Package com.github.jamesnetherton.zulip.client.api.message

Enum MessageFlag

java.lang.Object
java.lang.Enum<MessageFlag>
com.github.jamesnetherton.zulip.client.api.message.MessageFlag
All Implemented Interfaces:
Serializable, Comparable<MessageFlag>
public enum MessageFlag extends Enum<MessageFlag>
Defines a flag associated with a message.

  • Enum Constant Details

    • COLLAPSED

      public static final MessageFlag COLLAPSED
      Whether the message is collapsed.

    • HAS_ALERT_WORD

      public static final MessageFlag HAS_ALERT_WORD
      Whether the message contains one of the user alert words.

    • HISTORICAL

      public static final MessageFlag HISTORICAL
      Messages that are part of the users history.

    • MENTIONED

      public static final MessageFlag MENTIONED
      Whether the user was mentioned by this message.

    • READ

      public static final MessageFlag READ
      Whether the message has been read by the user.

    • STARRED

      public static final MessageFlag STARRED
      Whether the message has been starred.

    • STREAM_WILDCARD_MENTIONED

      public static final MessageFlag STREAM_WILDCARD_MENTIONED
      Whether this message contained either a stream wildcard mention.

    • TOPIC_WILDCARD_MENTIONED

      public static final MessageFlag TOPIC_WILDCARD_MENTIONED
      Whether this message contained a topic wildcard mention.

    • WILDCARD_MENTIONED

      @Deprecated public static final MessageFlag WILDCARD_MENTIONED
      Deprecated.
      use MessageFlag.STREAM_WILDCARD_MENTIONED or MessageFlag.TOPIC_WILDCARD_MENTIONED.
      Whether the message contained a wildcard mention such as @all.

  • Method Details

    • values

      public static MessageFlag[] 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 MessageFlag 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

    • fromString

      public static MessageFlag fromString(String flag)

    • toString

      public String toString()
      Overrides:
      toString in class Enum<MessageFlag>