Package com.flowable.engage.message.api

Enum Category

java.lang.Object
java.lang.Enum<Category>
com.flowable.engage.message.api.Category
All Implemented Interfaces:
NamedType, java.io.Serializable, java.lang.Comparable<Category>, java.lang.constant.Constable
public enum Category
extends java.lang.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.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    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.
    EVENT
    An event is a data object within the event stream or audit trail.
    MEDIA
    A media object contains a file and meta information along with an optional message.
    MESSAGE
    A general message within a Conversation.

  • Method Summary

    Modifier and Type Method Description
    static Category fromName​(java.lang.String name)  
    java.lang.String getName()
    Returns the name of the underlying type, enumeration or category.
    java.lang.String toString()  
    static Category valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static Category[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • 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 Details

    • values

      public static Category[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static Category valueOf​(java.lang.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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null

    • getName

      public java.lang.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

    • fromName

      public static Category fromName​(java.lang.String name)

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Enum<Category>