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 and Description
CROSSPOSTED This message has been published to subscribed channels (via Channel Following).
IS_CROSSPOST This message originated from a message in another channel (via Channel Following).
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.
URGENT This message came from the urgent message system.

Method Summary

Modifier and Type	Method and 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.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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.

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 name

NullPointerException - 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 invoking getValue() from the returned enum will be equal (==) to the supplied value.

Parameters:

value - The flags value as represented by Discord.

Returns:

The EnumSet of flags.