Package net.dv8tion.jda.api.entities

Enum MessageType

java.lang.Object

java.lang.Enum<MessageType>

net.dv8tion.jda.api.entities.MessageType

All Implemented Interfaces:

Serializable, Comparable<MessageType>

public enum MessageType
extends Enum<MessageType>

Represents the different types of Messages that can be received from Discord.
A normal text based message is DEFAULT.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO_MODERATION_ACTION	This message was created by the automod system.
CALL	Specialized message used for Groups as a System-Message showing that a Call was started.
CHANNEL_FOLLOW_ADD	Specialized message used to announce when a crosspost webhook is added to a channel
CHANNEL_ICON_CHANGE	Specialized message used for Groups as a System-Message showing that the icon of the Group was changed.
CHANNEL_NAME_CHANGE	Specialized message used for Groups as a System-Message showing that the name of the Group was changed.
CHANNEL_PINNED_ADD	Specialized message used in MessageChannels as a System-Message to announce new pins
CONTEXT_COMMAND	This message was created by an interaction.
DEFAULT	The normal text messages received when a user or bot sends a Message.
GUILD_APPLICATION_PREMIUM_SUBSCRIPTION	Sent to the system channel when a guild administrator subscribes to the premium plan of an application.
GUILD_BOOST_TIER_1	Specialized message used to announce the server has reached tier 1
GUILD_BOOST_TIER_2	Specialized message used to announce the server has reached tier 2
GUILD_BOOST_TIER_3	Specialized message used to announce the server has reached tier 3
GUILD_DISCOVERY_DISQUALIFIED	System message related to discovery qualifications.
GUILD_DISCOVERY_GRACE_PERIOD_FINAL_WARNING	System message related to discovery qualifications.
GUILD_DISCOVERY_GRACE_PERIOD_INITIAL_WARNING	System message related to discovery qualifications.
GUILD_DISCOVERY_REQUALIFIED	System message related to discovery qualifications.
GUILD_INCIDENT_ALERT_MODE_DISABLED	Sent when a moderator deactivates a temporary security measure, such as pausing invites or direct messages.
GUILD_INCIDENT_ALERT_MODE_ENABLED	Sent when a moderator activates a temporary security measure, such as pausing invites or direct messages.
GUILD_INCIDENT_REPORT_FALSE_ALARM	Sent when a moderator reports a raid as a false alarm in a guild.
GUILD_INCIDENT_REPORT_RAID	Sent when a moderator reports a raid in a guild.
GUILD_INVITE_REMINDER	The "Invite your friends" messages that are sent to guild owners in new servers.
GUILD_MEMBER_BOOST	Specialized message used to announce a new booster
GUILD_MEMBER_JOIN	Specialized message used to welcome new members in a Guild
INLINE_REPLY	Reply to another message.
INTERACTION_PREMIUM_UPSELL	Sent by a bot when a command is restricted to premium users.
RECIPIENT_ADD	Specialized messages used for Groups as a System-Message showing that a new User has been added to the Group.
RECIPIENT_REMOVE	Specialized messages used for Groups as a System-Message showing that a new User has been removed from the Group.
ROLE_SUBSCRIPTION_PURCHASE	Sent when someone purchases a role subscription.
SLASH_COMMAND	This message was created by an interaction.
STAGE_END	Messages created in StageChannels to indicate that a stage instance has ended.
STAGE_SPEAKER	Messages created in StageChannels to indicate that a new speaker is up.
STAGE_START	Messages created in StageChannels to indicate that a stage instance has started.
STAGE_TOPIC	Messages created in StageChannels to indicate that a stage instance topic has been changed.
THREAD_CREATED	This is sent to a TextChannel when a message thread is created if the message from which the thread was started is "old".
THREAD_STARTER_MESSAGE	A new message sent as the first message in threads that are started from an existing message in the parent channel.
UNKNOWN	Unknown MessageType.

Method Summary

Modifier and Type	Method	Description
boolean	canDelete()	Whether messages of this type can be deleted.
static MessageType	fromId(int id)	Used to retrieve a MessageType based on the Discord id key.
int	getId()	The Discord id key used to reference the MessageType.
boolean	isSystem()	Whether this message type is for system messages.
static MessageType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MessageType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEFAULT

public static final MessageType DEFAULT

The normal text messages received when a user or bot sends a Message.

RECIPIENT_ADD

public static final MessageType RECIPIENT_ADD

Specialized messages used for Groups as a System-Message showing that a new User has been added to the Group. Also used in message threads to indicate a member has joined that thread.

RECIPIENT_REMOVE

public static final MessageType RECIPIENT_REMOVE

Specialized messages used for Groups as a System-Message showing that a new User has been removed from the Group. Also used in message threads to indicate a member has left that thread.

CALL

public static final MessageType CALL

Specialized message used for Groups as a System-Message showing that a Call was started.

CHANNEL_NAME_CHANGE

public static final MessageType CHANNEL_NAME_CHANGE

Specialized message used for Groups as a System-Message showing that the name of the Group was changed. Also used in message threads to indicate the name of that thread has changed.

CHANNEL_ICON_CHANGE

public static final MessageType CHANNEL_ICON_CHANGE

Specialized message used for Groups as a System-Message showing that the icon of the Group was changed.

CHANNEL_PINNED_ADD

public static final MessageType CHANNEL_PINNED_ADD

Specialized message used in MessageChannels as a System-Message to announce new pins

GUILD_MEMBER_JOIN

public static final MessageType GUILD_MEMBER_JOIN

Specialized message used to welcome new members in a Guild

GUILD_MEMBER_BOOST

public static final MessageType GUILD_MEMBER_BOOST

Specialized message used to announce a new booster

GUILD_BOOST_TIER_1

public static final MessageType GUILD_BOOST_TIER_1

Specialized message used to announce the server has reached tier 1

GUILD_BOOST_TIER_2

public static final MessageType GUILD_BOOST_TIER_2

Specialized message used to announce the server has reached tier 2

GUILD_BOOST_TIER_3

public static final MessageType GUILD_BOOST_TIER_3

Specialized message used to announce the server has reached tier 3

CHANNEL_FOLLOW_ADD

public static final MessageType CHANNEL_FOLLOW_ADD

Specialized message used to announce when a crosspost webhook is added to a channel

GUILD_DISCOVERY_DISQUALIFIED

public static final MessageType GUILD_DISCOVERY_DISQUALIFIED

System message related to discovery qualifications.

GUILD_DISCOVERY_REQUALIFIED

public static final MessageType GUILD_DISCOVERY_REQUALIFIED

System message related to discovery qualifications.

GUILD_DISCOVERY_GRACE_PERIOD_INITIAL_WARNING

public static final MessageType GUILD_DISCOVERY_GRACE_PERIOD_INITIAL_WARNING

System message related to discovery qualifications.

GUILD_DISCOVERY_GRACE_PERIOD_FINAL_WARNING

public static final MessageType GUILD_DISCOVERY_GRACE_PERIOD_FINAL_WARNING

System message related to discovery qualifications.

THREAD_CREATED

public static final MessageType THREAD_CREATED

This is sent to a TextChannel when a message thread is created if the message from which the thread was started is "old". The definition of "old" is loose, but is currently a very liberal definition.

INLINE_REPLY

public static final MessageType INLINE_REPLY

Reply to another message. This usually comes with a referenced message.

SLASH_COMMAND

public static final MessageType SLASH_COMMAND

This message was created by an interaction. Usually in combination with Slash Commands.

THREAD_STARTER_MESSAGE

public static final MessageType THREAD_STARTER_MESSAGE

A new message sent as the first message in threads that are started from an existing message in the parent channel. It only contains a message reference field that points to the message from which the thread was started.

GUILD_INVITE_REMINDER

public static final MessageType GUILD_INVITE_REMINDER

The "Invite your friends" messages that are sent to guild owners in new servers.

CONTEXT_COMMAND

public static final MessageType CONTEXT_COMMAND

This message was created by an interaction. Usually in combination with Context Menus.

AUTO_MODERATION_ACTION

public static final MessageType AUTO_MODERATION_ACTION

This message was created by the automod system.

Messages from this type usually come with custom embeds containing relevant information, the author is the user that triggered the filter.

ROLE_SUBSCRIPTION_PURCHASE

public static final MessageType ROLE_SUBSCRIPTION_PURCHASE

Sent when someone purchases a role subscription.

See Also:

• Role.RoleTags.isAvailableForPurchase()
• Role.RoleTags.hasSubscriptionListing()

INTERACTION_PREMIUM_UPSELL

public static final MessageType INTERACTION_PREMIUM_UPSELL

Sent by a bot when a command is restricted to premium users.
Contains a button which allows to upgrade to premium.

STAGE_START

public static final MessageType STAGE_START

Messages created in StageChannels to indicate that a stage instance has started.
The message content will be the topic and the author is the user who started the stage instance.

STAGE_END

public static final MessageType STAGE_END

Messages created in StageChannels to indicate that a stage instance has ended.
The message content will be the topic and the author is the user who ended the stage instance.

STAGE_SPEAKER

public static final MessageType STAGE_SPEAKER

Messages created in StageChannels to indicate that a new speaker is up.
The author is the user who became speaker.

STAGE_TOPIC

public static final MessageType STAGE_TOPIC

Messages created in StageChannels to indicate that a stage instance topic has been changed.
The message content will be the new topic and the author is the user who updated the topic.

GUILD_APPLICATION_PREMIUM_SUBSCRIPTION

public static final MessageType GUILD_APPLICATION_PREMIUM_SUBSCRIPTION

Sent to the system channel when a guild administrator subscribes to the premium plan of an application.

GUILD_INCIDENT_ALERT_MODE_ENABLED

public static final MessageType GUILD_INCIDENT_ALERT_MODE_ENABLED

Sent when a moderator activates a temporary security measure, such as pausing invites or direct messages.
The message content is an ISO 8601 timestamp, which indicates when the action expires and disables the security measures automatically.

See Also:

• OffsetDateTime.parse(CharSequence)

GUILD_INCIDENT_ALERT_MODE_DISABLED

public static final MessageType GUILD_INCIDENT_ALERT_MODE_DISABLED

Sent when a moderator deactivates a temporary security measure, such as pausing invites or direct messages.

GUILD_INCIDENT_REPORT_RAID

public static final MessageType GUILD_INCIDENT_REPORT_RAID

Sent when a moderator reports a raid in a guild.
The message author is the reporter.

GUILD_INCIDENT_REPORT_FALSE_ALARM

public static final MessageType GUILD_INCIDENT_REPORT_FALSE_ALARM

Sent when a moderator reports a raid as a false alarm in a guild.

UNKNOWN

public static final MessageType UNKNOWN

Unknown MessageType.

Method Details

values

public static MessageType[] 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 MessageType 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()

The Discord id key used to reference the MessageType.

Returns:

the Discord id key.

isSystem

public boolean isSystem()

Whether this message type is for system messages.
These are messages that are sent by Discord and don't look like messages from users. Messages like this have some special restrictions.

Returns:

True, if this type is for a system message

canDelete

public boolean canDelete()

Whether messages of this type can be deleted.
These are messages which are required to stay such as thread starter messages.

Messages which cannot be deleted:

• RECIPIENT_ADD
• RECIPIENT_REMOVE
• CALL
• CHANNEL_NAME_CHANGE
• CHANNEL_ICON_CHANGE
• GUILD_DISCOVERY_DISQUALIFIED
• GUILD_DISCOVERY_REQUALIFIED
• GUILD_DISCOVERY_GRACE_PERIOD_INITIAL_WARNING
• GUILD_DISCOVERY_GRACE_PERIOD_FINAL_WARNING
• GUILD_DISCOVERY_GRACE_PERIOD_FINAL_WARNING
• THREAD_STARTER_MESSAGE
• GUILD_APPLICATION_PREMIUM_SUBSCRIPTION

Returns:

True, if delete is supported

fromId

@Nonnull
public static MessageType fromId(int id)

Used to retrieve a MessageType based on the Discord id key.
If the id provided is not a known id, UNKNOWN is returned

Parameters:

id - The Discord key id of the requested MessageType.

Returns:

A MessageType with the same Discord id key as the one provided, or UNKNOWN.