Package net.dv8tion.jda.internal.entities

Class ReceivedMessage

java.lang.Object

net.dv8tion.jda.internal.entities.ReceivedMessage

All Implemented Interfaces:

Formattable, ISnowflake, Message

public class ReceivedMessage
extends Object
implements Message

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.entities.Message

Message.Attachment, Message.Interaction, Message.InteractionMetadata, Message.MentionType, Message.MessageFlag

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	didContentIntentWarning

Fields inherited from interface net.dv8tion.jda.api.entities.Message

INVITE_PATTERN, JUMP_URL, JUMP_URL_PATTERN, MAX_COMPONENT_COUNT, MAX_COMPONENT_COUNT_IN_COMPONENT_TREE, MAX_CONTENT_LENGTH, MAX_CONTENT_LENGTH_COMPONENT_V2, MAX_EMBED_COUNT, MAX_FILE_AMOUNT, MAX_FILE_SIZE, MAX_NONCE_LENGTH, MAX_REACTIONS, MAX_STICKER_COUNT

Constructor Summary

Constructors

Constructor

Description

ReceivedMessage(long id, long channelId, long guildId, JDA jda, Guild guild, MessageChannel channel, MessageType type, MessageReference messageReference, boolean fromWebhook, long applicationId, boolean tts, boolean pinned, String content, String nonce, User author, Member member, MessageActivity activity, MessagePoll poll, OffsetDateTime editTime, Mentions mentions, List<MessageReaction> reactions, List<Message.Attachment> attachments, List<MessageEmbed> embeds, List<StickerItem> stickers, List<MessageTopLevelComponentUnion> components, List<MessageSnapshot> messageSnapshots, int flags, Message.Interaction interaction, Message.InteractionMetadata interactionMetadata, ThreadChannel startedThread, int position)

Method Summary

Modifier and Type	Method	Description
RestAction<Void>	addReaction(Emoji emoji)	Adds a reaction to this Message using an Emoji.
RestAction<Void>	clearReactions()	Removes all reactions from this Message.
RestAction<Void>	clearReactions(Emoji emoji)	Removes all reactions for the specified Emoji.
ThreadChannelAction	createThreadChannel(String name)	Creates a new, public ThreadChannel spawning/starting at this Message inside the IThreadContainer this message was sent in.
RestAction<Message>	crosspost()	Attempts to crosspost this message.
AuditableRestAction<Void>	delete()	Deletes this Message from Discord.
MessageEditAction	editMessage(CharSequence newContent)	Edits this message and updates the content.
MessageEditAction	editMessage(MessageEditData newContent)	Edits this message using the provided MessageEditData.
MessageEditAction	editMessageAttachments(Collection<? extends AttachedFile> attachments)	Edits this message using the provided files.
MessageEditAction	editMessageComponents(Collection<? extends MessageTopLevelComponent> components)	Edits this message using the provided MessageTopLevelComponents.
MessageEditAction	editMessageEmbeds(Collection<? extends MessageEmbed> embeds)	Edits this message using the provided MessageEmbeds.
MessageEditAction	editMessageFormat(String format, Object... args)	Edits this message using the provided format arguments.
AuditableRestAction<Message>	endPoll()	End the poll attached to this message.
boolean	equals(Object o)
void	formatTo(Formatter formatter, int flags, int width, int precision)
MessageActivity	getActivity()	A MessageActivity that contains its type and party id.
long	getApplicationIdLong()	If this message is from an application-owned Webhook or is a response to an Interaction, this will return the application's id.
int	getApproximatePosition()	Returns the approximate position of this message in a ThreadChannel.
List<Message.Attachment>	getAttachments()	An immutable list of Attachments that are attached to this message.
User	getAuthor()	The author of this Message
Category	getCategory()	The Category this message was sent in.
MessageChannelUnion	getChannel()	Returns the MessageChannel that this message was sent in.
long	getChannelIdLong()	The ID for the channel this message was sent in.
ChannelType	getChannelType()	Gets the ChannelType that this message was received from.
List<MessageTopLevelComponentUnion>	getComponents()	Layouts of interactive components, usually ActionRows.
String	getContentDisplay()	The textual content of this message in the format that would be shown to the Discord client.
String	getContentRaw()	The raw textual content of this message.
String	getContentStripped()	Gets the textual content of this message using Message.getContentDisplay() and then strips it of markdown characters like *, **, __, ~~, || that provide text formatting.
List<MessageEmbed>	getEmbeds()	An immutable list of MessageEmbeds that are part of this Message.
EnumSet<Message.MessageFlag>	getFlags()	Returns an EnumSet of all MessageFlags present for this Message.
long	getFlagsRaw()	Returns the raw message flags of this message
Guild	getGuild()	Returns the Guild that this message was sent in.
GuildMessageChannelUnion	getGuildChannel()	Returns the GuildMessageChannel that this message was sent in if it was sent in a Guild.
long	getGuildIdLong()	The ID for the guild this message was sent in.
long	getIdLong()	The Snowflake id of this entity.
Message.Interaction	getInteraction()	This is sent on the message object when the message is a response to an Interaction without an existing message.
Message.InteractionMetadata	getInteractionMetadata()	Returns the interaction metadata, available when the message is a response or a followup to an Interaction.
List<String>	getInvites()	Creates an immutable List of Invite codes that are included in this Message.
JDA	getJDA()	Returns the JDA instance related to this Message.
String	getJumpUrl()	Returns the jump-to URL for the received message.
Member	getMember()	Returns the author of this Message as a member.
Mentions	getMentions()	The Mentions used in this message.
MessageReference	getMessageReference()	Returns the MessageReference for this Message.
List<MessageSnapshot>	getMessageSnapshots()	The MessageSnaphots attached to this message.
String	getNonce()	Validation nonce for this Message This can be used to validate that a Message was properly sent to the Discord Service.
MessagePoll	getPoll()	The MessagePoll attached to this message.
MessageReaction	getReaction(Emoji emoji)	This obtains the MessageReaction for the given Emoji on this message.
List<MessageReaction>	getReactions()	All MessageReactions that are on this Message.
ThreadChannel	getStartedThread()	Returns a possibly null ThreadChannel that was started from this message.
List<StickerItem>	getStickers()	All StickerItems that are in this Message.
OffsetDateTime	getTimeEdited()	Provides the OffsetDateTime defining when this Message was last edited.
MessageType	getType()	This specifies the MessageType of this Message.
boolean	hasChannel()	Whether this message instance has an available Message.getChannel().
boolean	hasGuild()	Whether this message instance provides a guild instance via Message.getGuild().
int	hashCode()
boolean	isEdited()	Returns whether or not this Message has been edited before.
boolean	isEphemeral()	Whether this message is ephemeral.
boolean	isFromGuild()	Whether this message was sent in a Guild.
boolean	isFromType(ChannelType type)	Used to determine if this Message was received from a MessageChannel of the ChannelType specified.
boolean	isPinned()	Whether or not this Message has been pinned in its parent channel.
boolean	isSuppressedEmbeds()	Whether embeds are suppressed for this message.
boolean	isSuppressedNotifications()	Whether this message is silent.
boolean	isTTS()	Defines whether or not this Message triggers TTS (Text-To-Speech).
boolean	isUsingComponentsV2()	Whether this message can contain V2 components.
boolean	isVoiceMessage()	Whether this message is a voice message.
boolean	isWebhookMessage()	Indicates if this Message was sent either by a Webhook or an app, instead of a User.
RestAction<Void>	pin()	Used to add the Message to the MessageChannel's pinned message list.
RestAction<Void>	removeReaction(Emoji emoji)	Removes own reaction from this Message using an Emoji, you can use Message.removeReaction(Emoji, User) to remove reactions from other users, or Message.clearReactions(Emoji) to remove all reactions for the specified emoji.
RestAction<Void>	removeReaction(Emoji emoji, User user)	Removes a User's reaction from this Message using an Emoji.
ReactionPaginationAction	retrieveReactionUsers(Emoji emoji, MessageReaction.ReactionType type)	This obtains the users who reacted using the given Emoji.
AuditableRestAction<Void>	suppressEmbeds(boolean suppressed)	Enables/Disables suppression of Embeds on this Message.
String	toString()
RestAction<Void>	unpin()	Used to remove the Message from the MessageChannel's pinned message list.
ReceivedMessage	withHook(WebhookClient<Message> hook)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getTimeCreated

Methods inherited from interface net.dv8tion.jda.api.entities.Message

editMessageAttachments, editMessageComponents, editMessageComponents, editMessageEmbeds, forwardTo, getActionRows, getApplicationId, getButtonById, getButtons, getButtonsByLabel, getChannelId, getComponentTree, getGuildId, getReferencedMessage, reply, reply, replyComponents, replyComponents, replyComponents, replyEmbeds, replyEmbeds, replyFiles, replyFiles, replyFormat, replyPoll, replyStickers, replyStickers, retrievePollVoters, retrieveReactionUsers

Field Details

didContentIntentWarning

public static boolean didContentIntentWarning

Constructor Details

ReceivedMessage

public ReceivedMessage(long id,
 long channelId,
 long guildId,
 JDA jda,
 Guild guild,
 MessageChannel channel,
 MessageType type,
 MessageReference messageReference,
 boolean fromWebhook,
 long applicationId,
 boolean tts,
 boolean pinned,
 String content,
 String nonce,
 User author,
 Member member,
 MessageActivity activity,
 MessagePoll poll,
 OffsetDateTime editTime,
 Mentions mentions,
 List<MessageReaction> reactions,
 List<Message.Attachment> attachments,
 List<MessageEmbed> embeds,
 List<StickerItem> stickers,
 List<MessageTopLevelComponentUnion> components,
 List<MessageSnapshot> messageSnapshots,
 int flags,
 Message.Interaction interaction,
 Message.InteractionMetadata interactionMetadata,
 ThreadChannel startedThread,
 int position)

Method Details

withHook

public ReceivedMessage withHook(WebhookClient<Message> hook)

getJDA

@Nonnull
public JDA getJDA()

Description copied from interface: Message

Returns the JDA instance related to this Message.

Specified by:

getJDA in interface Message

Returns:

the corresponding JDA instance

getMessageReference

@Nullable
public MessageReference getMessageReference()

Description copied from interface: Message

Returns the MessageReference for this Message. This will be null if this Message has no reference.

This will have different meaning depending on the message type. The following are the message types where a reference will be present:

• INLINE_REPLY
• THREAD_STARTER_MESSAGE
• CONTEXT_COMMAND (message context command)

You can access all the information about a reference through this object. Additionally, you can retrieve the referenced Message if discord did not load it in time. This can be done with MessageReference.resolve().

Specified by:

getMessageReference in interface Message

Returns:

The message reference, or null.

isPinned

public boolean isPinned()

Description copied from interface: Message

Whether or not this Message has been pinned in its parent channel.

Specified by:

isPinned in interface Message

Returns:

True - if this message has been pinned.

pin

@Nonnull
public RestAction<Void> pin()

Description copied from interface: Message

Used to add the Message to the MessageChannel's pinned message list.
This is a shortcut method to MessageChannel.pinMessageById(String).

The success or failure of this action will not affect the return of Message.isPinned().

The following ErrorResponses are possible:

• MISSING_ACCESS
  The pin request was attempted after the account lost access to the GuildChannel due to Permission.VIEW_CHANNEL being revoked, or the account lost access to the Guild typically due to being kicked or removed.
• MISSING_PERMISSIONS
  The pin request was attempted after the account lost Permission.MESSAGE_MANAGE in the GuildChannel.
• UNKNOWN_MESSAGE
  If the message has already been deleted. This might also be triggered for ephemeral messages.

Specified by:

pin in interface Message

Returns:

RestAction - Type: Void

unpin

@Nonnull
public RestAction<Void> unpin()

Description copied from interface: Message

Used to remove the Message from the MessageChannel's pinned message list.
This is a shortcut method to MessageChannel.unpinMessageById(String).

The success or failure of this action will not affect the return of Message.isPinned().

The following ErrorResponses are possible:

• MISSING_ACCESS
  The unpin request was attempted after the account lost access to the GuildChannel due to Permission.VIEW_CHANNEL being revoked, or the account lost access to the Guild typically due to being kicked or removed.
• MISSING_PERMISSIONS
  The unpin request was attempted after the account lost Permission.MESSAGE_MANAGE in the GuildChannel.
• UNKNOWN_MESSAGE
  If the message has already been deleted. This might also be triggered for ephemeral messages.

Specified by:

unpin in interface Message

Returns:

RestAction - Type: Void

addReaction

@Nonnull
public RestAction<Void> addReaction(@Nonnull
 Emoji emoji)

Description copied from interface: Message

Adds a reaction to this Message using an Emoji.

This message instance will not be updated by this operation.

Reactions are the small emoji below a message that have a counter beside them showing how many users have reacted with the same emoji.

Neither success nor failure of this request will affect this Message's Message.getReactions() return as Message is immutable.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The reaction request was attempted after the account lost access to the GuildChannel due to Permission.VIEW_CHANNEL being revoked
  Also can happen if the account lost the Permission.MESSAGE_HISTORY
• REACTION_BLOCKED
  The user has blocked the currently logged in account and the reaction failed
• TOO_MANY_REACTIONS
  The message already has too many reactions to proceed
• MISSING_PERMISSIONS
  The reaction request was attempted after the account lost Permission.MESSAGE_ADD_REACTION or Permission.MESSAGE_HISTORY in the GuildChannel when adding the reaction.
• UNKNOWN_EMOJI
  The provided emoji was deleted, doesn't exist, or is not available to the currently logged-in account in this channel.
• UNKNOWN_MESSAGE
  If the message has already been deleted. This might also be triggered for ephemeral messages.

Specified by:

addReaction in interface Message

Parameters:

emoji - The Emoji to add as a reaction to this Message.

Returns:

RestAction

clearReactions

@Nonnull
public RestAction<Void> clearReactions()

Description copied from interface: Message

Removes all reactions from this Message.
This is useful for moderator commands that wish to remove all reactions at once from a specific message.

Please note that you can't clear reactions if this message was sent in a PrivateChannel!

Neither success nor failure of this request will affect this Message's Message.getReactions() return as Message is immutable.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The clear-reactions request was attempted after the account lost access to the GuildChannel due to Permission.VIEW_CHANNEL being revoked, or the account lost access to the Guild typically due to being kicked or removed.
• MISSING_PERMISSIONS
  The clear-reactions request was attempted after the account lost Permission.MESSAGE_MANAGE in the GuildChannel when adding the reaction.
• UNKNOWN_MESSAGE
  If the message has already been deleted. This might also be triggered for ephemeral messages.

Specified by:

clearReactions in interface Message

Returns:

RestAction

clearReactions

@Nonnull
public RestAction<Void> clearReactions(@Nonnull
 Emoji emoji)

Description copied from interface: Message

Removes all reactions for the specified Emoji.

Please note that you can't clear reactions if this message was sent in a PrivateChannel!

The following ErrorResponses are possible:

• MISSING_ACCESS
  The currently logged in account lost access to the channel by either being removed from the guild or losing the VIEW_CHANNEL permission
• UNKNOWN_EMOJI
  The provided emoji was deleted, doesn't exist, or is not available to the currently logged-in account in this channel.
• UNKNOWN_MESSAGE
  If the message has already been deleted. This might also be triggered for ephemeral messages.

Specified by:

clearReactions in interface Message

Parameters:

emoji - The Emoji to remove reactions for

Returns:

RestAction

removeReaction

@Nonnull
public RestAction<Void> removeReaction(@Nonnull
 Emoji emoji)

Description copied from interface: Message

Removes own reaction from this Message using an Emoji, you can use Message.removeReaction(Emoji, User) to remove reactions from other users, or Message.clearReactions(Emoji) to remove all reactions for the specified emoji.

This message instance will not be updated by this operation.

Reactions are the small emojis below a message that have a counter beside them showing how many users have reacted with the same emoji.

Neither success nor failure of this request will affect this Message's Message.getReactions() return as Message is immutable.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The reaction request was attempted after the account lost access to the GuildChannel due to Permission.VIEW_CHANNEL being revoked
  Also can happen if the account lost the Permission.MESSAGE_HISTORY
• UNKNOWN_EMOJI
  The provided emoji was deleted, doesn't exist, or is not available to the currently logged-in account in this channel.
• UNKNOWN_MESSAGE
  If the message has already been deleted. This might also be triggered for ephemeral messages.

Specified by:

removeReaction in interface Message

Parameters:

emoji - The Emoji reaction to remove as a reaction from this Message.

Returns:

RestAction

removeReaction

@Nonnull
public RestAction<Void> removeReaction(@Nonnull
 Emoji emoji,
 @Nonnull
 User user)

Description copied from interface: Message

Removes a User's reaction from this Message using an Emoji.

Please note that you can't remove reactions of other users if this message was sent in a PrivateChannel!

This message instance will not be updated by this operation.

Reactions are the small emojis below a message that have a counter beside them showing how many users have reacted with the same emoji.

Neither success nor failure of this request will affect this Message's Message.getReactions() return as Message is immutable.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The reaction request was attempted after the account lost access to the GuildChannel due to Permission.VIEW_CHANNEL being revoked
  Also can happen if the account lost the Permission.MESSAGE_HISTORY
• MISSING_PERMISSIONS
  The reaction request was attempted after the account lost Permission.MESSAGE_MANAGE in the GuildChannel when removing the reaction.
• UNKNOWN_EMOJI
  The provided emoji was deleted, doesn't exist, or is not available to the currently logged-in account in this channel.
• UNKNOWN_MESSAGE
  If the message has already been deleted. This might also be triggered for ephemeral messages.

Specified by:

removeReaction in interface Message

Parameters:

emoji - The Emoji reaction to remove as a reaction from this Message.

user - The User to remove the reaction for.

Returns:

RestAction

retrieveReactionUsers

@Nonnull
public ReactionPaginationAction retrieveReactionUsers(@Nonnull
 Emoji emoji,
 @Nonnull
 MessageReaction.ReactionType type)

Description copied from interface: Message

This obtains the users who reacted using the given Emoji.

Messages maintain a list of reactions, alongside a list of users who added them.

Using this data, we can obtain a ReactionPaginationAction of the users who've reacted to this message.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The retrieve request was attempted after the account lost access to the GuildChannel due to Permission.VIEW_CHANNEL being revoked
  Also can happen if the account lost the Permission.MESSAGE_HISTORY
• UNKNOWN_EMOJI
  The provided emoji was deleted, doesn't exist, or is not available to the currently logged-in account in this channel.
• UNKNOWN_MESSAGE
  If the message has already been deleted. This might also be triggered for ephemeral messages.

Specified by:

retrieveReactionUsers in interface Message

Parameters:

emoji - The Emoji to retrieve users for.

type - The specific type of reaction

Returns:

The ReactionPaginationAction of the users who reacted with the provided emoji

getReaction

@Nullable
public MessageReaction getReaction(@Nonnull
 Emoji emoji)

Description copied from interface: Message

This obtains the MessageReaction for the given Emoji on this message.
The reaction instance also store which users reacted with the specified emoji.

Messages store reactions by keeping a list of reaction names.

Specified by:

getReaction in interface Message

Parameters:

emoji - The unicode or custom emoji of the reaction emoji

Returns:

The MessageReaction or null if not present.

getType

@Nonnull
public MessageType getType()

Description copied from interface: Message

This specifies the MessageType of this Message.

Messages can represent more than just simple text sent by Users, they can also be special messages that inform about events that occur. Messages can either be default messages or special messages like welcome messages.

Specified by:

getType in interface Message

Returns:

The MessageType of this message.

getInteraction

@Nullable
public Message.Interaction getInteraction()

Description copied from interface: Message

This is sent on the message object when the message is a response to an Interaction without an existing message.

This means responses to Message Components do not include this property, instead including a message reference object as components always exist on preexisting messages.

Specified by:

getInteraction in interface Message

Returns:

The Interaction of this message.

getInteractionMetadata

@Nullable
public Message.InteractionMetadata getInteractionMetadata()

Description copied from interface: Message

Returns the interaction metadata, available when the message is a response or a followup to an Interaction.

Specified by:

getInteractionMetadata in interface Message

Returns:

The Message.InteractionMetadata of this message, or null

getIdLong

public long getIdLong()

Description copied from interface: ISnowflake

The Snowflake id of this entity. This is unique to every entity and will never change.

Specified by:

getIdLong in interface ISnowflake

Returns:

Long containing the Id.

getJumpUrl

@Nonnull
public String getJumpUrl()

Description copied from interface: Message

Returns the jump-to URL for the received message. Clicking this URL in the Discord client will cause the client to jump to the specified message.

Specified by:

getJumpUrl in interface Message

Returns:

A String representing the jump-to URL for the message

isEdited

public boolean isEdited()

Description copied from interface: Message

Returns whether or not this Message has been edited before.

Specified by:

isEdited in interface Message

Returns:

True if this message has been edited.

getTimeEdited

public OffsetDateTime getTimeEdited()

Description copied from interface: Message

Provides the OffsetDateTime defining when this Message was last edited. If this Message has not been edited (Message.isEdited() is false), then this method will return null.

Specified by:

getTimeEdited in interface Message

Returns:

Time of the most recent edit, or null if the Message has never been edited.

getAuthor

@Nonnull
public User getAuthor()

Description copied from interface: Message

The author of this Message

Specified by:

getAuthor in interface Message

Returns:

Message author

getMember

public Member getMember()

Description copied from interface: Message

Returns the author of this Message as a member.
This is only valid if the Message was actually sent in a GuildMessageChannel. This will return null if the message was not sent in a GuildMessageChannel, or if the message was sent by a Webhook (including apps).
You can check the type of channel this message was sent from using Message.isFromType(ChannelType) or Message.getChannelType().

Discord does not provide a member object for messages returned by RestActions of any kind. This will return null if the message was retrieved through MessageChannel.retrieveMessageById(long) or similar means, unless the member is already cached.

Specified by:

getMember in interface Message

Returns:

Message author, or null if the message was not sent in a GuildMessageChannel, or if the message was sent by a Webhook.

See Also:

• Message.isWebhookMessage()

getApproximatePosition

public int getApproximatePosition()

Description copied from interface: Message

Returns the approximate position of this message in a ThreadChannel.
This can be used to estimate the relative position of a message in a thread, by comparing against ThreadChannel.getTotalMessageCount().

Notes:

• The position might contain gaps or duplicates.
• The position is not set on messages sent earlier than July 19th, 2022, and will return -1.

Specified by:

getApproximatePosition in interface Message

Returns:

The approximate position of this message, or -1 if this message is too old.

See Also:

• Discord docs: position property on the message object

getContentStripped

@Nonnull
public String getContentStripped()

Description copied from interface: Message

Gets the textual content of this message using Message.getContentDisplay() and then strips it of markdown characters like *, **, __, ~~, || that provide text formatting. Any characters that match these but are not being used for formatting are escaped to prevent possible formatting.

Requires GatewayIntent.MESSAGE_CONTENT

Specified by:

getContentStripped in interface Message

Returns:

The textual content from Message.getContentDisplay() with all text formatting characters removed or escaped.

getContentDisplay

@Nonnull
public String getContentDisplay()

Description copied from interface: Message

The textual content of this message in the format that would be shown to the Discord client. All IMentionable entities will be resolved to the format shown by the Discord client instead of the <id> format.

This includes resolving:
Users / Members to their @Username/@Nickname format,
GuildChannels to their #ChannelName format,
Roles to their @RoleName format
Custom Emojis (not unicode emojis!) to their :name: format.

If you want the actual Content (mentions as <@id>), use Message.getContentRaw() instead

Requires GatewayIntent.MESSAGE_CONTENT

Specified by:

getContentDisplay in interface Message

Returns:

The textual content of the message with mentions resolved to be visually like the Discord client.

getContentRaw

@Nonnull
public String getContentRaw()

Description copied from interface: Message

The raw textual content of this message. Does not resolve IMentionable entities like Message.getContentDisplay() does. This means that this is the completely raw textual content of the message received from Discord and can contain mentions specified by Discord's Message Formatting.

Requires GatewayIntent.MESSAGE_CONTENT

Specified by:

getContentRaw in interface Message

Returns:

The raw textual content of the message, containing unresolved Discord message formatting.

getInvites

@Nonnull
public List<String> getInvites()

Description copied from interface: Message

Creates an immutable List of Invite codes that are included in this Message.
This will use the Pattern provided under Message.INVITE_PATTERN to construct a Matcher that will parse the Message.getContentRaw() output and include all codes it finds in a list.

You can use the codes to retrieve/validate invites via Invite.resolve(JDA, String)

Specified by:

getInvites in interface Message

Returns:

Immutable list of invite codes

getNonce

public String getNonce()

Description copied from interface: Message

Validation nonce for this Message
This can be used to validate that a Message was properly sent to the Discord Service.
To set a nonce before sending you may use MessageCreateAction.setNonce(String)!

Specified by:

getNonce in interface Message

Returns:

The validation nonce

See Also:

• MessageCreateAction.setNonce(String)
• Cryptographic Nonce - Wikipedia

isFromType

public boolean isFromType(@Nonnull
 ChannelType type)

Description copied from interface: Message

Used to determine if this Message was received from a MessageChannel of the ChannelType specified.

Useful for restricting functionality to a certain type of channels.

Specified by:

isFromType in interface Message

Parameters:

type - The ChannelType to check against.

Returns:

True if the ChannelType which this message was received from is the same as the one specified by type.

isFromGuild

public boolean isFromGuild()

Description copied from interface: Message

Whether this message was sent in a Guild.
If this is false then Message.getGuild() will throw an IllegalStateException.

Specified by:

isFromGuild in interface Message

Returns:

True, if Message.getChannelType().isGuild() is true.

getChannelType

@Nonnull
public ChannelType getChannelType()

Description copied from interface: Message

Gets the ChannelType that this message was received from.

Specified by:

getChannelType in interface Message

Returns:

The ChannelType which this message was received from.

getChannel

@Nonnull
public MessageChannelUnion getChannel()

Description copied from interface: Message

Returns the MessageChannel that this message was sent in.

Specified by:

getChannel in interface Message

Returns:

The MessageChannel of this Message

See Also:

• Message.hasChannel()
• Message.getChannelIdLong()

getGuildChannel

@Nonnull
public GuildMessageChannelUnion getGuildChannel()

Description copied from interface: Message

Returns the GuildMessageChannel that this message was sent in if it was sent in a Guild.

Specified by:

getGuildChannel in interface Message

Returns:

The MessageChannel of this Message

See Also:

• Message.hasChannel()
• Message.getChannelIdLong()

getCategory

public Category getCategory()

Description copied from interface: Message

The Category this message was sent in. This will always be null for DMs.
Equivalent to getGuildChannel().getParentCategory() if this was sent in a GuildMessageChannel.

Specified by:

getCategory in interface Message

Returns:

Category for this message

hasGuild

public boolean hasGuild()

Description copied from interface: Message

Whether this message instance provides a guild instance via Message.getGuild().
This is different from Message.isFromGuild(), which checks whether the message was sent in a guild. This method describes whether Message.getGuild() is usable.

This can be false for messages sent via webhooks, or in the context of interactions.

Specified by:

hasGuild in interface Message

Returns:

True, if Message.getGuild() is provided

getGuildIdLong

public long getGuildIdLong()

Description copied from interface: Message

The ID for the guild this message was sent in.
This is useful when Message.getGuild() is not provided, for instance on webhook messages.

Specified by:

getGuildIdLong in interface Message

Returns:

The guild id, or 0 if this message was not sent in a guild

getGuild

@Nonnull
public Guild getGuild()

Description copied from interface: Message

Returns the Guild that this message was sent in.
This is just a shortcut to Message.getGuildChannel().getGuild().
This is only valid if the Message was actually sent in a GuildMessageChannel.
You can check the type of channel this message was sent from using Message.isFromType(ChannelType) or Message.getChannelType().

Specified by:

getGuild in interface Message

Returns:

The Guild this message was sent in

See Also:

• Message.isFromGuild()
• Message.isFromType(ChannelType)
• Message.getChannelType()

getAttachments

@Nonnull
public List<Message.Attachment> getAttachments()

Description copied from interface: Message

An immutable list of Attachments that are attached to this message.
Most likely this will only ever be 1 Attachment at most.

Requires GatewayIntent.MESSAGE_CONTENT

Specified by:

getAttachments in interface Message

Returns:

Immutable list of Attachments.

getEmbeds

@Nonnull
public List<MessageEmbed> getEmbeds()

Description copied from interface: Message

An immutable list of MessageEmbeds that are part of this Message.

Requires GatewayIntent.MESSAGE_CONTENT

Specified by:

getEmbeds in interface Message

Returns:

Immutable list of all given MessageEmbeds.

getComponents

@Nonnull
public List<MessageTopLevelComponentUnion> getComponents()

Description copied from interface: Message

Layouts of interactive components, usually ActionRows.
You can use MessageRequest.setComponents(MessageTopLevelComponent...) to update these.

Requires GatewayIntent.MESSAGE_CONTENT

Specified by:

getComponents in interface Message

Returns:

Immutable List of MessageTopLevelComponent

See Also:

• Message.getActionRows()
• Message.getButtons()
• Message.getButtonById(String)

isUsingComponentsV2

public boolean isUsingComponentsV2()

Description copied from interface: Message

Whether this message can contain V2 components.
This checks for Message.MessageFlag.IS_COMPONENTS_V2.

Specified by:

isUsingComponentsV2 in interface Message

Returns:

true if this message has the components V2 flag

See Also:

• MessageRequest.useComponentsV2()
• MessageRequest.useComponentsV2(boolean)

getPoll

public MessagePoll getPoll()

Description copied from interface: Message

The MessagePoll attached to this message.

Specified by:

getPoll in interface Message

Returns:

Possibly-null poll instance for this message

See Also:

• Message.endPoll()

endPoll

@Nonnull
public AuditableRestAction<Message> endPoll()

Description copied from interface: Message

End the poll attached to this message.

Specified by:

endPoll in interface Message

Returns:

AuditableRestAction - Type: Message

getMentions

@Nonnull
public Mentions getMentions()

Description copied from interface: Message

The Mentions used in this message.

This includes Members, GuildChannels, Roles, and CustomEmojis. Can also be used to check if a message mentions @everyone or @here.

Example
System.out.println("Message mentioned these users: " + message.getMentions().getUsers()); System.out.println("Message used these custom emojis: " + message.getMentions().getCustomEmojis());

Specified by:

getMentions in interface Message

Returns:

Mentions for this message.

getReactions

@Nonnull
public List<MessageReaction> getReactions()

Description copied from interface: Message

All MessageReactions that are on this Message.

Specified by:

getReactions in interface Message

Returns:

Immutable list of all MessageReactions on this message.

See Also:

• MessageReaction

getStickers

@Nonnull
public List<StickerItem> getStickers()

Description copied from interface: Message

All StickerItems that are in this Message.
The returned StickerItems may only contain necessary information such as the sticker id, format type, name, and icon url.

Specified by:

getStickers in interface Message

Returns:

Immutable list of all StickerItems in this message.

getMessageSnapshots

@Nonnull
public List<MessageSnapshot> getMessageSnapshots()

Description copied from interface: Message

The MessageSnaphots attached to this message.

This is used primarily for message forwarding. The content of the forwarded message is provided as a snapshot at the time of forwarding. When the message is edited or deleted, this snapshot remains unchanged.

Specified by:

getMessageSnapshots in interface Message

Returns:

Immutable List of MessageSnapshot

isWebhookMessage

public boolean isWebhookMessage()

Description copied from interface: Message

Indicates if this Message was sent either by a Webhook or an app, instead of a User.
Useful if you want to ignore non-users.

Specified by:

isWebhookMessage in interface Message

Returns:

True if this message was sent by a Webhook.

getApplicationIdLong

public long getApplicationIdLong()

Description copied from interface: Message

If this message is from an application-owned Webhook or is a response to an Interaction, this will return the application's id.

Specified by:

getApplicationIdLong in interface Message

Returns:

The application's id or 0 if this message was not sent by an application

hasChannel

public boolean hasChannel()

Description copied from interface: Message

Whether this message instance has an available Message.getChannel().

This can be false for messages sent via webhooks, or in the context of interactions.

Specified by:

hasChannel in interface Message

Returns:

True, if Message.getChannel() is available

getChannelIdLong

public long getChannelIdLong()

Description copied from interface: Message

The ID for the channel this message was sent in.
This is useful when Message.getChannel() is unavailable, for instance on webhook messages.

Specified by:

getChannelIdLong in interface Message

Returns:

The channel id

isTTS

public boolean isTTS()

Description copied from interface: Message

Defines whether or not this Message triggers TTS (Text-To-Speech).

Specified by:

isTTS in interface Message

Returns:

If this message is TTS.

getActivity

@Nullable
public MessageActivity getActivity()

Description copied from interface: Message

A MessageActivity that contains its type and party id.

Specified by:

getActivity in interface Message

Returns:

The activity, or null if no activity was added to the message.

editMessage

@Nonnull
public MessageEditAction editMessage(@Nonnull
 CharSequence newContent)

Description copied from interface: Message

Edits this message and updates the content.
Any other fields of the message will remain unchanged, you can use replace(true) to remove everything else (embeds/attachments/components).

The following ErrorResponses are possible:

• MISSING_ACCESS
  The request was attempted after the account lost access to the Guild typically due to being kicked or removed, or after Permission.VIEW_CHANNEL was revoked in the GuildMessageChannel
• UNKNOWN_MESSAGE
  The provided messageId is unknown in this MessageChannel, either due to the id being invalid, or the message it referred to has already been deleted.
• UNKNOWN_CHANNEL
  The request was attempted after the channel was deleted.
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Specified by:

editMessage in interface Message

Parameters:

newContent - The new content of the message, or empty string to remove content (assumes other fields exist like embeds)

Returns:

MessageEditAction

See Also:

• MessageChannel.editMessageById(long, CharSequence)

editMessageEmbeds

@Nonnull
public MessageEditAction editMessageEmbeds(@Nonnull
 Collection<? extends MessageEmbed> embeds)

Description copied from interface: Message

Edits this message using the provided MessageEmbeds.
You can use EmbedBuilder to create a MessageEmbed instance.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The request was attempted after the account lost access to the Guild typically due to being kicked or removed, or after Permission.VIEW_CHANNEL was revoked in the GuildMessageChannel
• UNKNOWN_MESSAGE
  The provided messageId is unknown in this MessageChannel, either due to the id being invalid, or the message it referred to has already been deleted.
• UNKNOWN_CHANNEL
  The request was attempted after the channel was deleted.
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Specified by:

editMessageEmbeds in interface Message

Parameters:

embeds - The new MessageEmbeds of the message, empty list to remove embeds

Returns:

MessageEditAction

See Also:

• EmbedBuilder
• MessageChannel.editMessageEmbedsById(long, Collection)

editMessageComponents

@Nonnull
public MessageEditAction editMessageComponents(@Nonnull
 Collection<? extends MessageTopLevelComponent> components)

Description copied from interface: Message

Edits this message using the provided MessageTopLevelComponents.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The request was attempted after the account lost access to the Guild typically due to being kicked or removed, or after Permission.VIEW_CHANNEL was revoked in the GuildMessageChannel
• UNKNOWN_MESSAGE
  The provided messageId is unknown in this MessageChannel, either due to the id being invalid, or the message it referred to has already been deleted.
• UNKNOWN_CHANNEL
  The request was attempted after the channel was deleted.
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Specified by:

editMessageComponents in interface Message

Parameters:

components - The MessageTopLevelComponents to set, can be empty to remove components, can contain up to 5 V1 components. There are no limits for V2 components outside the total tree size (40).

Returns:

MessageEditAction

See Also:

• MessageChannel.editMessageComponentsById(long, Collection)

editMessageFormat

@Nonnull
public MessageEditAction editMessageFormat(@Nonnull
 String format,
 @Nonnull
 Object... args)

Description copied from interface: Message

Edits this message using the provided format arguments.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The request was attempted after the account lost access to the Guild typically due to being kicked or removed, or after Permission.VIEW_CHANNEL was revoked in the GuildMessageChannel
• UNKNOWN_MESSAGE
  The provided messageId is unknown in this MessageChannel, either due to the id being invalid, or the message it referred to has already been deleted.
• UNKNOWN_CHANNEL
  The request was attempted after the channel was deleted.
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Specified by:

editMessageFormat in interface Message

Parameters:

format - Format String used to generate new Content

args - The arguments which should be used to format the given format String

Returns:

MessageEditAction

See Also:

• MessageChannel.editMessageFormatById(long, String, Object...)

editMessageAttachments

@Nonnull
public MessageEditAction editMessageAttachments(@Nonnull
 Collection<? extends AttachedFile> attachments)

Description copied from interface: Message

Edits this message using the provided files.

The following ErrorResponses are possible:

• REQUEST_ENTITY_TOO_LARGE
  If any of the provided files is bigger than Guild.getMaxFileSize()
• MISSING_ACCESS
  The request was attempted after the account lost access to the Guild typically due to being kicked or removed, or after Permission.VIEW_CHANNEL was revoked in the GuildMessageChannel
• UNKNOWN_MESSAGE
  The provided messageId is unknown in this MessageChannel, either due to the id being invalid, or the message it referred to has already been deleted. This might also be triggered for ephemeral messages, if the interaction expired.
• UNKNOWN_CHANNEL
  The request was attempted after the channel was deleted.
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Resource Handling Note: Once the request is handed off to the requester, for example when you call RestAction.queue(), the requester will automatically clean up all opened files by itself. You are only responsible to close them yourself if it is never handed off properly. For instance, if an exception occurs after using FileUpload.fromData(File), before calling RestAction.queue(). You can safely use a try-with-resources to handle this, since FileUpload.close() becomes ineffective once the request is handed off.

Specified by:

editMessageAttachments in interface Message

Parameters:

attachments - The new attachments of the message (Can be FileUploads or AttachmentUpdates)

Returns:

MessageEditAction that can be used to further update the message

See Also:

• AttachedFile.fromAttachment(Message.Attachment)
• FileUpload.fromData(InputStream, String)

editMessage

@Nonnull
public MessageEditAction editMessage(@Nonnull
 MessageEditData newContent)

Description copied from interface: Message

Edits this message using the provided MessageEditData.
You can use MessageEditBuilder to create a MessageEditData instance.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The request was attempted after the account lost access to the Guild typically due to being kicked or removed, or after Permission.VIEW_CHANNEL was revoked in the GuildMessageChannel
• UNKNOWN_MESSAGE
  The provided messageId is unknown in this MessageChannel, either due to the id being invalid, or the message it referred to has already been deleted.
• UNKNOWN_CHANNEL
  The request was attempted after the channel was deleted.
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Specified by:

editMessage in interface Message

Parameters:

newContent - The MessageEditData used to update the message

Returns:

MessageEditAction

See Also:

• MessageEditBuilder
• MessageChannel.editMessageById(long, MessageEditData)

delete

@Nonnull
public AuditableRestAction<Void> delete()

Description copied from interface: Message

Deletes this Message from Discord.
If this Message was not sent by the currently logged in account, then this will fail unless the Message is from a GuildChannel and the current account has Permission.MESSAGE_MANAGE in the channel.

To delete many messages at once in a MessageChannel you should use MessageChannel.purgeMessages(List) instead.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The delete was attempted after the account lost access to the GuildChannel due to Permission.VIEW_CHANNEL being revoked, or the account lost access to the Guild typically due to being kicked or removed.
• MISSING_PERMISSIONS
  The delete was attempted after the account lost Permission.MESSAGE_MANAGE in the GuildChannel when deleting another Member's message or lost Permission.MESSAGE_MANAGE.
• UNKNOWN_MESSAGE
  If the message has already been deleted. This might also be triggered for ephemeral messages, if the interaction expired.

Specified by:

delete in interface Message

Returns:

AuditableRestAction

See Also:

• TextChannel.deleteMessages(Collection)
• MessageChannel.purgeMessages(List)

suppressEmbeds

@Nonnull
public AuditableRestAction<Void> suppressEmbeds(boolean suppressed)

Description copied from interface: Message

Enables/Disables suppression of Embeds on this Message.
Suppressing Embeds is equivalent to pressing the X in the top-right corner of an Embed inside the Discord client.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The clear-reactions request was attempted after the account lost access to the GuildChannel due to Permission.VIEW_CHANNEL being revoked, or the account lost access to the Guild typically due to being kicked or removed.
• MISSING_PERMISSIONS
  The suppress-embeds request was attempted after the account lost Permission.MESSAGE_MANAGE in the GuildChannel when adding the reaction.
• UNKNOWN_MESSAGE
  If the message has already been deleted. This might also be triggered for ephemeral messages.

Specified by:

suppressEmbeds in interface Message

Parameters:

suppressed - Whether the embed should be suppressed

Returns:

AuditableRestAction - Type: Void

See Also:

• Message.isSuppressedEmbeds()

crosspost

@Nonnull
public RestAction<Message> crosspost()

Description copied from interface: Message

Attempts to crosspost this message.

The following ErrorResponses are possible:

• ALREADY_CROSSPOSTED
  The target message has already been crossposted.
• MISSING_ACCESS
  The request was attempted after the account lost access to the Guild typically due to being kicked or removed, or after Permission.VIEW_CHANNEL was revoked in the GuildChannel
• MISSING_PERMISSIONS
  The request was attempted after the account lost Permission.MESSAGE_MANAGE in the GuildMessageChannel.
• UNKNOWN_MESSAGE
  If the message has already been deleted. This might also be triggered for ephemeral messages.
• UNKNOWN_CHANNEL
  The request was attempted after the channel was deleted.

Specified by:

crosspost in interface Message

Returns:

RestAction - Type: Message

isSuppressedEmbeds

public boolean isSuppressedEmbeds()

Description copied from interface: Message

Whether embeds are suppressed for this message. When Embeds are suppressed, they are not displayed on clients nor provided via API until un-suppressed.
This is a shortcut method for checking if getFlags() contains MessageFlag#EMBEDS_SUPPRESSED

Specified by:

isSuppressedEmbeds in interface Message

Returns:

Whether or not Embeds are suppressed for this Message.

See Also:

• Message.suppressEmbeds(boolean)

getFlags

@Nonnull
public EnumSet<Message.MessageFlag> getFlags()

Description copied from interface: Message

Returns an EnumSet of all MessageFlags present for this Message.

Specified by:

getFlags in interface Message

Returns:

Never-Null EnumSet of present MessageFlags

See Also:

• Message.MessageFlag

getFlagsRaw

public long getFlagsRaw()

Description copied from interface: Message

Returns the raw message flags of this message

Specified by:

getFlagsRaw in interface Message

Returns:

The raw message flags

See Also:

• Message.getFlags()

isEphemeral

public boolean isEphemeral()

Description copied from interface: Message

Whether this message is ephemeral.
The message being ephemeral means it is only visible to the bot and the interacting user
This is a shortcut method for checking if Message.getFlags() contains Message.MessageFlag.EPHEMERAL

Specified by:

isEphemeral in interface Message

Returns:

Whether the message is ephemeral

isSuppressedNotifications

public boolean isSuppressedNotifications()

Description copied from interface: Message

Whether this message is silent.
The message being silent means it will not trigger push and desktop notifications
This is a shortcut method for checking if Message.getFlags() contains Message.MessageFlag.NOTIFICATIONS_SUPPRESSED

Specified by:

isSuppressedNotifications in interface Message

Returns:

Whether the message is silent

isVoiceMessage

public boolean isVoiceMessage()

Description copied from interface: Message

Whether this message is a voice message.

Specified by:

isVoiceMessage in interface Message

Returns:

True, if this is a voice message

getStartedThread

@Nullable
public ThreadChannel getStartedThread()

Description copied from interface: Message

Returns a possibly null ThreadChannel that was started from this message. This can be null due to no ThreadChannel being started from it or the ThreadChannel later being deleted.

Specified by:

getStartedThread in interface Message

Returns:

The ThreadChannel that was started from this message.

createThreadChannel

public ThreadChannelAction createThreadChannel(@Nonnull
 String name)

Description copied from interface: Message

Creates a new, public ThreadChannel spawning/starting at this Message inside the IThreadContainer this message was sent in.
The starting message will copy this message, and will be of type MessageType.THREAD_STARTER_MESSAGE.

The resulting ThreadChannel may be one of:

• ChannelType.GUILD_PUBLIC_THREAD
• ChannelType.GUILD_NEWS_THREAD

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MAX_CHANNELS
  The maximum number of channels were exceeded
• ErrorResponse.THREAD_WITH_THIS_MESSAGE_ALREADY_EXISTS
  This message has already been used to create a thread
• ErrorResponse.MAX_ACTIVE_THREADS
  The maximum number of active threads has been reached, and no more may be created.

Specified by:

createThreadChannel in interface Message

Parameters:

name - The name of the new ThreadChannel (up to 100 characters)

Returns:

A specific ThreadChannelAction that may be used to configure the new ThreadChannel before its creation.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

formatTo

public void formatTo(Formatter formatter,
 int flags,
 int width,
 int precision)

Specified by:

formatTo in interface Formattable