Package discord4j.core.object.entity
Enum Message.Flag
- java.lang.Object
-
- java.lang.Enum<Message.Flag>
-
- discord4j.core.object.entity.Message.Flag
-
- All Implemented Interfaces:
Serializable
,Comparable<Message.Flag>
- Enclosing class:
- Message
public static enum Message.Flag extends Enum<Message.Flag>
Describes extra features of a message.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CROSSPOSTED
This message has been published to subscribed channels (via Channel Following).EPHEMERAL
This message is an ephemeral interaction response.FAILED_TO_MENTION_SOME_ROLES_IN_THREAD
This message failed to mention some roles and add their members to the thread.HAS_THREAD
This message has an associated thread, with the same id as the message.IS_CROSSPOST
This message originated from a message in another channel (via Channel Following).IS_VOICE_MESSAGE
This message is a voice message.LOADING
This message is an Interaction Response and the bot is "thinking".SOURCE_MESSAGE_DELETED
The source message for this crosspost has been deleted (via Channel Following).SUPPRESS_EMBEDS
Do not include any embeds when serializing this message.SUPPRESS_NOTIFICATIONS
This message will not trigger push and desktop notifications.URGENT
This message came from the urgent message system.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getFlag()
Gets the flag value as represented by Discord.int
getValue()
Gets the underlying value as represented by Discord.static EnumSet<Message.Flag>
of(int value)
Gets the flags of message.static Message.Flag
valueOf(String name)
Returns the enum constant of this type with the specified name.static Message.Flag[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
CROSSPOSTED
public static final Message.Flag CROSSPOSTED
This message has been published to subscribed channels (via Channel Following).
-
IS_CROSSPOST
public static final Message.Flag IS_CROSSPOST
This message originated from a message in another channel (via Channel Following).
-
SUPPRESS_EMBEDS
public static final Message.Flag SUPPRESS_EMBEDS
Do not include any embeds when serializing this message.
-
SOURCE_MESSAGE_DELETED
public static final Message.Flag SOURCE_MESSAGE_DELETED
The source message for this crosspost has been deleted (via Channel Following).
-
URGENT
public static final Message.Flag URGENT
This message came from the urgent message system.
-
HAS_THREAD
public static final Message.Flag HAS_THREAD
This message has an associated thread, with the same id as the message.
-
EPHEMERAL
public static final Message.Flag EPHEMERAL
This message is an ephemeral interaction response.
-
LOADING
public static final Message.Flag LOADING
This message is an Interaction Response and the bot is "thinking".
-
FAILED_TO_MENTION_SOME_ROLES_IN_THREAD
public static final Message.Flag FAILED_TO_MENTION_SOME_ROLES_IN_THREAD
This message failed to mention some roles and add their members to the thread.
-
SUPPRESS_NOTIFICATIONS
public static final Message.Flag SUPPRESS_NOTIFICATIONS
This message will not trigger push and desktop notifications.
-
IS_VOICE_MESSAGE
public static final Message.Flag IS_VOICE_MESSAGE
This message is a voice message.
-
-
Method Detail
-
values
public static Message.Flag[] 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 (Message.Flag c : Message.Flag.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Message.Flag 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 nameNullPointerException
- if the argument is null
-
getValue
public int getValue()
Gets the underlying value as represented by Discord.- Returns:
- The underlying value as represented by Discord.
-
getFlag
public int getFlag()
Gets the flag value as represented by Discord.- Returns:
- The flag value as represented by Discord.
-
of
public static EnumSet<Message.Flag> of(int value)
Gets the flags of message. It is guaranteed that invokinggetValue()
from the returned enum will be equal (==
) to the suppliedvalue
.- Parameters:
value
- The flags value as represented by Discord.- Returns:
- The
EnumSet
of flags.
-
-