Enum ChatType

java.lang.Object
java.lang.Enum<ChatType>
net.essentialsx.api.v2.ChatType
All Implemented Interfaces:
Serializable, Comparable<ChatType>

public enum ChatType extends Enum<ChatType>
Represents chat type for a message
  • Enum Constant Details

    • SHOUT

      public static final ChatType SHOUT
      Message is being sent to global chat as a shout
    • QUESTION

      public static final ChatType QUESTION
      Message is being sent to global chat as a question
    • LOCAL

      public static final ChatType LOCAL
      Message is being sent locally
    • SPY

      public static final ChatType SPY
      Message is being sent to spy channel
    • UNKNOWN

      public static final ChatType UNKNOWN
      Chat type is not determined

      This type used when local/global chat features are disabled

  • Method Details

    • values

      public static ChatType[] 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 ChatType 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
    • key

      public String key()
      Returns:
      Lowercase name of the chat type.