Package org.javacord.api.entity.message

Enum MessageFlag

java.lang.Object

java.lang.Enum<MessageFlag>

org.javacord.api.entity.message.MessageFlag

All Implemented Interfaces:

Serializable, Comparable<MessageFlag>

public enum MessageFlag
extends Enum<MessageFlag>

Represents a message flag type.

Enum Constant Summary

Enum Constants

Enum Constant	Description
EPHEMERAL	An ephemeral message (only visible for the user).
UNKNOWN	An unknown flag.

Method Summary

Modifier and Type	Method	Description
static MessageFlag	getFlagTypeById(int id)	Gets the message flag type by its id.
int	getId()	Gets the id of the message flag type.
static MessageFlag	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MessageFlag[]	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

EPHEMERAL

public static final MessageFlag EPHEMERAL

An ephemeral message (only visible for the user).

UNKNOWN

public static final MessageFlag UNKNOWN

An unknown flag.

Method Detail

values

public static MessageFlag[] 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 (MessageFlag c : MessageFlag.values())
    System.out.println(c);

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

getId

public int getId()

Gets the id of the message flag type.

Returns:

The id of the message flag type.

getFlagTypeById

public static MessageFlag getFlagTypeById(int id)

Gets the message flag type by its id.

Parameters:

id - The id of the message flag type.

Returns:

The message flag type with the given id or UNKNOWN if unknown id.