Package net.dv8tion.jda.api.entities
Enum MessageType
- All Implemented Interfaces:
Serializable
,Comparable<MessageType>
-
Enum Constant Summary
Enum ConstantDescriptionThis message was created by the automod system.Specialized message used for Groups as a System-Message showing that a Call was started.Specialized message used to announce when a crosspost webhook is added to a channelSpecialized message used for Groups as a System-Message showing that the icon of the Group was changed.Specialized message used for Groups as a System-Message showing that the name of the Group was changed.Specialized message used in MessageChannels as a System-Message to announce new pinsThis message was created by an interaction.The normal text messages received when a user or bot sends a Message.Sent to thesystem channel
when a guild administrator subscribes to the premium plan of an application.Specialized message used to announce the server has reached tier 1Specialized message used to announce the server has reached tier 2Specialized message used to announce the server has reached tier 3System message related to discovery qualifications.System message related to discovery qualifications.System message related to discovery qualifications.System message related to discovery qualifications.Sent when a moderator deactivates a temporary security measure, such as pausing invites or direct messages.Sent when a moderator activates a temporary security measure, such as pausing invites or direct messages.Sent when a moderator reports a raid as a false alarm in a guild.Sent when a moderator reports a raid in a guild.The "Invite your friends" messages that are sent to guild owners in new servers.Specialized message used to announce a new boosterSpecialized message used to welcome new members in a GuildReply to another message.Sent by a bot when a command is restricted to premium users.Sent when a poll completed in the channel.Sent when a user purchases a product sold in a guildSpecialized messages used for Groups as a System-Message showing that a new User has been added to the Group.Specialized messages used for Groups as a System-Message showing that a new User has been removed from the Group.Sent when someone purchases a role subscription.This message was created by an interaction.Messages created inStageChannels
to indicate that a stage instance has ended.Messages created inStageChannels
to indicate that a newspeaker
is up.Messages created inStageChannels
to indicate that a stage instance has started.Messages created inStageChannels
to indicate that a stage instance topic has been changed.This is sent to a TextChannel when a message thread is created if the message from which the thread was started is "old".A new message sent as the first message in threads that are started from an existing message in the parent channel.Unknown MessageType. -
Method Summary
Modifier and TypeMethodDescriptionboolean
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
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.
-
Enum Constant Details
-
DEFAULT
The normal text messages received when a user or bot sends a Message. -
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
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
Specialized message used for Groups as a System-Message showing that a Call was started. -
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
Specialized message used for Groups as a System-Message showing that the icon of the Group was changed. -
CHANNEL_PINNED_ADD
Specialized message used in MessageChannels as a System-Message to announce new pins -
GUILD_MEMBER_JOIN
Specialized message used to welcome new members in a Guild -
GUILD_MEMBER_BOOST
Specialized message used to announce a new booster -
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 -
CHANNEL_FOLLOW_ADD
Specialized message used to announce when a crosspost webhook is added to a channel -
GUILD_DISCOVERY_DISQUALIFIED
System message related to discovery qualifications. -
GUILD_DISCOVERY_REQUALIFIED
System message related to discovery qualifications. -
GUILD_DISCOVERY_GRACE_PERIOD_INITIAL_WARNING
System message related to discovery qualifications. -
GUILD_DISCOVERY_GRACE_PERIOD_FINAL_WARNING
System message related to discovery qualifications. -
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
Reply to another message. This usually comes with areferenced message
. -
SLASH_COMMAND
This message was created by an interaction. Usually in combination with Slash Commands. -
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
The "Invite your friends" messages that are sent to guild owners in new servers. -
CONTEXT_COMMAND
This message was created by an interaction. Usually in combination with Context Menus. -
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
Sent when someone purchases a role subscription. -
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
Messages created inStageChannels
to indicate that a stage instance has started.
The message content will be thetopic
and the author is the user who started the stage instance. -
STAGE_END
Messages created inStageChannels
to indicate that a stage instance has ended.
The message content will be thetopic
and the author is the user who ended the stage instance. -
STAGE_SPEAKER
Messages created inStageChannels
to indicate that a newspeaker
is up.
The author is the user who became speaker. -
STAGE_TOPIC
Messages created inStageChannels
to indicate that a stage instance topic has been changed.
The message content will be the newtopic
and the author is the user who updated the topic. -
GUILD_APPLICATION_PREMIUM_SUBSCRIPTION
Sent to thesystem channel
when a guild administrator subscribes to the premium plan of an application. -
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:
-
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
Sent when a moderator reports a raid in a guild.
The message author is the reporter. -
GUILD_INCIDENT_REPORT_FALSE_ALARM
Sent when a moderator reports a raid as a false alarm in a guild. -
PURCHASE_NOTIFICATION
Sent when a user purchases a product sold in a guild -
POLL_RESULT
Sent when a poll completed in the channel. -
UNKNOWN
Unknown MessageType.
-
-
Method Details
-
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
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
-
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
Used to retrieve a MessageType based on the Discord id key.
If theid
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
.
-