Package com.flowable.engage.message.api

Enum Category

  • All Implemented Interfaces:
    NamedType, Serializable, Comparable<Category>
    public enum Category
extends Enum<Category>
implements NamedType
    The enumeration of message categories. The type and subtype describe the data in more detail and are fully customizable, the category, however, is not extensible and defaults to message and event only as of now.

    • Enum Constant Detail

      • MESSAGE

        public static final Category MESSAGE
        A general message within a conversation.

      • MEDIA

        public static final Category MEDIA
        A media object contains a file and meta information along with an optional message.

      • EVENT

        public static final Category EVENT
        An event is a data object within the event stream or audit trail.

      • ACTION

        public static final Category ACTION
        An action is a specific message sent / received as part of a conversation to interact with the underlying work item or as a generally available action.

    • Method Detail

      • values

        public static Category[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Category c : Category.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Category valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getName

        public String getName()
        Description copied from interface: NamedType
        Returns the name of the underlying type, enumeration or category.
        Specified by:
        getName in interface NamedType
        Returns:
        the name