Package discord4j.core.object.entity

Enum Message.Type

java.lang.Object

java.lang.Enum<Message.Type>

discord4j.core.object.entity.Message.Type

All Implemented Interfaces:

Serializable, Comparable<Message.Type>

Enclosing class:

Message

public static enum Message.Type
extends Enum<Message.Type>

Represents the various types of messages.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CALL	A message created when a call was started.
CHANNEL_ICON_CHANGE	A message created when a channel's icon changed.
CHANNEL_NAME_CHANGE	A message created when a channel's name changed.
CHANNEL_PINNED_MESSAGE	A message created when a message was pinned.
DEFAULT	A message created by a user.
GUILD_MEMBER_JOIN	A message created when an user joins a guild.
RECIPIENT_ADD	A message created when a recipient was added to a DM.
RECIPIENT_REMOVE	A message created when a recipient left a DM.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Gets the underlying value as represented by Discord.
static Message.Type	of(int value)	Gets the type of message.
static Message.Type	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Message.Type[]	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

DEFAULT

public static final Message.Type DEFAULT

A message created by a user.

RECIPIENT_ADD

public static final Message.Type RECIPIENT_ADD

A message created when a recipient was added to a DM.

RECIPIENT_REMOVE

public static final Message.Type RECIPIENT_REMOVE

A message created when a recipient left a DM.

CALL

public static final Message.Type CALL

A message created when a call was started.

CHANNEL_NAME_CHANGE

public static final Message.Type CHANNEL_NAME_CHANGE

A message created when a channel's name changed.

CHANNEL_ICON_CHANGE

public static final Message.Type CHANNEL_ICON_CHANGE

A message created when a channel's icon changed.

CHANNEL_PINNED_MESSAGE

public static final Message.Type CHANNEL_PINNED_MESSAGE

A message created when a message was pinned.

GUILD_MEMBER_JOIN

public static final Message.Type GUILD_MEMBER_JOIN

A message created when an user joins a guild.

Method Detail

values

public static Message.Type[] 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.Type c : Message.Type.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.Type 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.

of

public static Message.Type of(int value)

Gets the type of message. It is guaranteed that invoking getValue() from the returned enum will equal (==) the supplied value.

Parameters:

value - The underlying value as represented by Discord.

Returns:

The type of message.