Message (JDA 3.0.BETA2

All Superinterfaces:

ISnowflake
```
public interface Message
extends ISnowflake
```
Represents a Text message received from Discord.
This represents messages received from MessageChannels.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Message.Attachment
Represents a Message file attachment.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Message.Attachment` Represents a `Message` file attachment.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`RestAction<java.lang.Void>`	`addReaction(Emote emote)` Adds a reaction to this Message using an `Emote`.
`RestAction<java.lang.Void>`	`addReaction(java.lang.String unicode)` Adds a reaction to this Message using a UTF8 emoji.
`RestAction<java.lang.Void>`	`clearReactions()` Removes all reactions from this Message.
`RestAction<java.lang.Void>`	`delete()` Deletes this Message from Discord.
`RestAction<java.lang.Void>`	`deleteMessage()` Deprecated. Use `delete()` instead.
`RestAction<Message>`	`editMessage(Message newContent)` Edits this Message's content to the provided `Message`.
`RestAction<Message>`	`editMessage(MessageEmbed newContent)` Edits this Message's content to the provided `MessageEmbed`.
`RestAction<Message>`	`editMessage(java.lang.String newContent)` Edits this Message's content to the provided String.
`java.util.List<Message.Attachment>`	`getAttachments()` An unmodifiable list of `Attachments` that are attached to this message.
`User`	`getAuthor()` The author of this Message
`MessageChannel`	`getChannel()` Returns the `MessageChannel` that this message was sent in.
`ChannelType`	`getChannelType()` Gets the `ChannelType` that this message was received from.
`java.lang.String`	`getContent()` The textual content of this message in the format that would be shown to the Discord client.
`java.time.OffsetDateTime`	`getEditedTime()` Provides the `OffsetDateTime` defining when this Message was last edited.
`java.util.List<MessageEmbed>`	`getEmbeds()` An unmodifiable list of `MessageEmbeds` that are part of this Message.
`java.util.List<Emote>`	`getEmotes()` All `Emotes` used in this Message.
`Group`	`getGroup()` Returns the `Group` that this message was sent in.
`Guild`	`getGuild()` Returns the `Guild` that this message was sent in.
`JDA`	`getJDA()` Returns the `JDA` instance related to this Message.
`java.util.List<TextChannel>`	`getMentionedChannels()` A immutable list of all mentioned `TextChannels`.
`java.util.List<Role>`	`getMentionedRoles()` A immutable list of all mentioned `Roles`.
`java.util.List<User>`	`getMentionedUsers()` A immutable list of all mentioned users.
`PrivateChannel`	`getPrivateChannel()` Returns the `PrivateChannel` that this message was sent in.
`java.lang.String`	`getRawContent()` The raw textual content of this message.
`java.util.List<MessageReaction>`	`getReactions()` All `MessageReactions` that are on this Message.
`java.lang.String`	`getStrippedContent()` Gets the textual content of this message using `getContent()` and then strips it of all markdown characters like , *, __, ~~ that provide text formatting.
`TextChannel`	`getTextChannel()` Returns the `TextChannel` that this message was sent in.
`MessageType`	`getType()` This specifies the `MessageType` of this Message.
`boolean`	`isEdited()` Returns whether or not this Message has been edited before.
`boolean`	`isFromType(ChannelType type)` Used to determine if this Message was received from a `MessageChannel` of the `ChannelType` specified.
`boolean`	`isMentioned(User user)` Checks if given user was mentioned in this message in any way (@User, @everyone, @here).
`boolean`	`isPinned()` Whether or not this Message has been pinned in its parent channel.
`boolean`	`isTTS()` Defines whether or not this Message triggers TTS (Text-To-Speech).
`boolean`	`isWebhookMessage()` Indicates if this Message was sent by a `Webhook` instead of a `User`.
`boolean`	`mentionsEveryone()` Indicates if this Message mentions everyone using @everyone or @here.
`RestAction<java.lang.Void>`	`pin()` Used to add the Message to the `MessageChannel's` pinned message list.
`RestAction<java.lang.Void>`	`unpin()` Used to remove the Message from the `MessageChannel's` pinned message list.

Methods inherited from interface net.dv8tion.jda.core.entities.ISnowflake
getCreationTime, getId

- Method Detail
  - getMentionedUsers
```
java.util.List<User> getMentionedUsers()
```
    A immutable list of all mentioned users. if no user was mentioned, this list is empty.
    In PrivateChannel's, this always returns an empty List
    
    Returns:
    
    immutable list of mentioned users
  - isMentioned
```
boolean isMentioned(User user)
```
    Checks if given user was mentioned in this message in any way (@User, @everyone, @here).
    
    Parameters:
    
    user - The user to check on.
    
    Returns:
    
    True if the given user was mentioned in this message.
  - getMentionedChannels
```
java.util.List<TextChannel> getMentionedChannels()
```
    A immutable list of all mentioned TextChannels. If none were mentioned, this list is empty.
    In PrivateChannels and Groups, this always returns an empty List.
    
    Returns:
    
    immutable list of mentioned TextChannels
  - getMentionedRoles
```
java.util.List<Role> getMentionedRoles()
```
    A immutable list of all mentioned Roles. If none were mentioned, this list is empty.
    In PrivateChannels and Groups, this always returns an empty List.
    
    Returns:
    
    immutable list of mentioned Roles
  - mentionsEveryone
```
boolean mentionsEveryone()
```
    Indicates if this Message mentions everyone using @everyone or @here. In PrivateChannel's, this always returns false.
    
    Returns:
    
    True if message is mentioning everyone
  - isEdited
```
boolean isEdited()
```
    Returns whether or not this Message has been edited before.
    
    Returns:
    
    True if this message has been edited.
  - getEditedTime
```
java.time.OffsetDateTime getEditedTime()
```
    Provides the OffsetDateTime defining when this Message was last edited. If this Message has not been edited (isEdited() is false), then this method will return null.
    
    Returns:
    
    Time of the most recent edit, or null if the Message has never been edited.
  - getAuthor
```
User getAuthor()
```
    The author of this Message
    
    Returns:
    
    Message author
  - getContent
```
java.lang.String getContent()
```
    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,
    TextChannels to their #ChannelName format,
    Roles to their @RoleName format
    Emotes (not emojis!) to their :name: format.
    If you want the actual Content (mentions as <@id>), use getRawContent() instead
    
    Returns:
    
    The textual content of the message with mentions resolved to be visually like the Discord client.
  - getRawContent
```
java.lang.String getRawContent()
```
    The raw textual content of this message. Does not resolve IMentionable entities like getContent() 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.
    
    Returns:
    
    The raw textual content of the message, containing unresolved Discord message formatting.
  - getStrippedContent
```
java.lang.String getStrippedContent()
```
    Gets the textual content of this message using getContent() and then strips it of all 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.
    
    Returns:
    
    The textual content from getContent() with all text formatting characters removed or escaped.
  - isFromType
```
boolean isFromType(ChannelType type)
```
    Used to determine if this Message was received from a MessageChannel of the ChannelType specified.
    This will always be false for ChannelType.VOICE as Messages can't be sent to VoiceChannels.
    Useful for restricting functionality to a certain type of channels.
    
    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.
  - getChannelType
```
ChannelType getChannelType()
```
    Gets the ChannelType that this message was received from.
    This will never be ChannelType.VOICE as Messages can't be sent to VoiceChannels.
    
    Returns:
    
    The ChannelType which this message was received from.
  - isWebhookMessage
```
boolean isWebhookMessage()
```
    Indicates if this Message was sent by a Webhook instead of a User.
    Useful if you want to ignore non-users.
    
    Returns:
    
    True if this message was sent by a Webhook.
  - getChannel
```
MessageChannel getChannel()
```
    Returns the MessageChannel that this message was sent in.
    
    Returns:
    
    The MessageChannel of this Message
  - getPrivateChannel
```
PrivateChannel getPrivateChannel()
```
    Returns the PrivateChannel that this message was sent in.
    This is only valid if the Message was actually sent in a PrivateChannel. This will return null if it was not sent from a PrivateChannel.
    You can check the type of channel this message was sent from using isFromType(ChannelType) or getChannelType().
    Use getChannel() for an ambiguous MessageChannel if you do not need functionality specific to PrivateChannel.
    
    Returns:
    
    The PrivateChannel this message was sent in, or null if it was not sent from a PrivateChannel.
  - getGroup
```
Group getGroup()
```
    Returns the Group that this message was sent in.
    This is only valid if the Message was actually sent in a Group. This will return null if it was not sent from a Group.
    You can check the type of channel this message was sent from using isFromType(ChannelType) or getChannelType().
    Use getChannel() for an ambiguous MessageChannel if you do not need functionality specific to Group.
    
    Returns:
    
    The Group this message was sent in, or null if it was not sent from a Group.
  - getTextChannel
```
TextChannel getTextChannel()
```
    Returns the TextChannel that this message was sent in.
    This is only valid if the Message was actually sent in a TextChannel. This will return null if it was not sent from a TextChannel.
    You can check the type of channel this message was sent from using isFromType(ChannelType) or getChannelType().
    Use getChannel() for an ambiguous MessageChannel if you do not need functionality specific to TextChannel.
    
    Returns:
    
    The TextChannel this message was sent in, or null if it was not sent from a TextChannel.
  - getGuild
```
Guild getGuild()
```
    Returns the Guild that this message was sent in.
    This is just a shortcut to getTextChannel().getGuild().
    This is only valid if the Message was actually sent in a TextChannel. This will return null if it was not sent from a TextChannel.
    You can check the type of channel this message was sent from using isFromType(ChannelType) or getChannelType().
    
    Returns:
    
    The Guild this message was sent in, or null if it was not sent from a TextChannel.
  - getAttachments
```
java.util.List<Message.Attachment> getAttachments()
```
    An unmodifiable list of Attachments that are attached to this message.
    Most likely this will only ever be 1 Attachment at most.
    
    Returns:
    
    Unmodifiable list of Attachments.
  - getEmbeds
```
java.util.List<MessageEmbed> getEmbeds()
```
    An unmodifiable list of MessageEmbeds that are part of this Message.
    
    Returns:
    
    Unmodifiable list of all given MessageEmbeds.
  - getEmotes
```
java.util.List<Emote> getEmotes()
```
    All Emotes used in this Message.
    This only includes Custom Emotes, not UTF8 Emojis. JDA classifies Emotes as the Custom Emojis uploaded to a Guild and retrievable with Guild.getEmotes(). These are not the same as the UTF8 emojis that Discord also supports.
    This may or may not contain fake Emotes which means they can be displayed but not used by the logged in account. To check whether an Emote is fake you can test if IFakeable.isFake() returns true.
    
    Returns:
    
    An immutable list of the Emotes used in this message (example match <:jda:230988580904763393>)
  - getReactions
```
java.util.List<MessageReaction> getReactions()
```
    All MessageReactions that are on this Message.
    
    Returns:
    
    immutable list of all MessageReactions on this message.
  - isTTS
```
boolean isTTS()
```
    Defines whether or not this Message triggers TTS (Text-To-Speech).
    
    Returns:
    
    If this message is TTS.
  - editMessage
```
RestAction<Message> editMessage(java.lang.String newContent)
```
    Edits this Message's content to the provided String.
    Messages can only be edited by the account that sent them!.
    The following ErrorResponses are possible:
    - MISSING_ACCESS
      The edit was attempted after the account lost access to the Guild or Group typically due to being kicked or removed.
    - MISSING_PERMISSIONS
      The edit was attempted after the account lost Permission.MESSAGE_WRITE in the TextChannel.
    - UNKNOWN_MESSAGE
      The edit was attempted after the Message had been deleted.
    Parameters:
    
    newContent - the new content of the Message
    
    Returns:
    
    RestAction - Type: Message
    The Message with the updated content
    
    Throws:
    
    java.lang.IllegalStateException - If the message attempting to be edited was not created by the currently logged in account, or if newContent's length is 0 or greater than 2000.
  - editMessage
```
RestAction<Message> editMessage(MessageEmbed newContent)
```
    Edits this Message's content to the provided MessageEmbed.
    Messages can only be edited by the account that sent them!.
    The following ErrorResponses are possible:
    - MISSING_ACCESS
      The edit was attempted after the account lost access to the Guild or Group typically due to being kicked or removed.
    - MISSING_PERMISSIONS
      The edit was attempted after the account lost Permission.MESSAGE_WRITE in the TextChannel.
    - UNKNOWN_MESSAGE
      The edit was attempted after the Message had been deleted.
    Parameters:
    
    newContent - the new content of the Message
    
    Returns:
    
    RestAction - Type: Message
    The Message with the updated content
    
    Throws:
    
    java.lang.IllegalStateException - If the message attempting to be edited was not created by the currently logged in account, or if the passed-in embed is null or not sendable
  - editMessage
```
RestAction<Message> editMessage(Message newContent)
```
    Edits this Message's content to the provided Message.
    Messages can only be edited by the account that sent them!.
    The following ErrorResponses are possible:
    - MISSING_ACCESS
      The edit was attempted after the account lost access to the Guild or Group typically due to being kicked or removed.
    - MISSING_PERMISSIONS
      The edit was attempted after the account lost Permission.MESSAGE_WRITE in the TextChannel.
    - UNKNOWN_MESSAGE
      The edit was attempted after the Message had been deleted.
    Parameters:
    
    newContent - the new content of the Message
    
    Returns:
    
    RestAction - Type: Message
    The Message with the updated content
    
    Throws:
    java.lang.IllegalStateException -
    
    If the message attempting to be edited was not created by the currently logged in account
    
    If the message contains a MessageEmebd that is not sendable
  - deleteMessage
```
@Deprecated
RestAction<java.lang.Void> deleteMessage()
```
    Deprecated. Use delete() instead.
    
    Use delete() instead.
    
    Returns:
    
    RestAction - Type: Void
  - delete
```
RestAction<java.lang.Void> delete()
```
    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 TextChannel and the current account has Permission.MESSAGE_MANAGE in the channel.
    The following ErrorResponses are possible:
    - MISSING_ACCESS
      The delete was attempted after the account lost access to the TextChannel due to Permission.MESSAGE_READ being revoked, or the account lost access to the Guild or Group typically due to being kicked or removed.
    - MISSING_PERMISSIONS
      The delete was attempted after the account lost Permission.MESSAGE_MANAGE in the TextChannel when deleting another Member's message or lost Permission.MESSAGE_MANAGE.
    - UNKNOWN_MESSAGE The pin was attempted after the Message had been deleted.
    Returns:
    
    RestAction - Type: Void
    
    Throws:
    
    PermissionException - If this Message was not sent by the currently logged in account, the Message was sent in a TextChannel, and the currently logged in account does not have Permission.MESSAGE_MANAGE in the channel.
    
    java.lang.IllegalStateException - If this Message was not sent by the currently logged in account and it was not sent in a TextChannel.
  - getJDA
```
JDA getJDA()
```
    Returns the JDA instance related to this Message.
    
    Returns:
    
    the corresponding JDA instance
  - isPinned
```
boolean isPinned()
```
    Whether or not this Message has been pinned in its parent channel.
    
    Returns:
    
    True - if this message has been pinned.
  - pin
```
RestAction<java.lang.Void> pin()
```
    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 isPinned().
    The following ErrorResponses are possible:
    - MISSING_ACCESS
      The pin request was attempted after the account lost access to the TextChannel due to Permission.MESSAGE_READ being revoked, or the account lost access to the Guild or Group typically due to being kicked or removed.
    - MISSING_PERMISSIONS
      The pin request was attempted after the account lost Permission.MESSAGE_MANAGE in the TextChannel.
    - UNKNOWN_MESSAGE The pin request was attempted after the Message had been deleted.
    Returns:
    
    RestAction - Type: Void
    
    Throws:
    PermissionException - If this Message is from a TextChannel and:
    
    Missing Permission.MESSAGE_READ.
    The account needs access the the channel to pin a message in it.
    
    Missing Permission.MESSAGE_MANAGE.
    Required to actually pin the Message.
  - unpin
```
RestAction<java.lang.Void> unpin()
```
    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 isPinned().
    The following ErrorResponses are possible:
    - MISSING_ACCESS
      The unpin request was attempted after the account lost access to the TextChannel due to Permission.MESSAGE_READ being revoked, or the account lost access to the Guild or Group typically due to being kicked or removed.
    - MISSING_PERMISSIONS
      The unpin request was attempted after the account lost Permission.MESSAGE_MANAGE in the TextChannel.
    - UNKNOWN_MESSAGE The unpin request was attempted after the Message had been deleted.
    Returns:
    
    RestAction - Type: Void
    
    Throws:
    PermissionException - If this Message is from a TextChannel and:
    
    Missing Permission.MESSAGE_READ.
    The account needs access the the channel to pin a message in it.
    
    Missing Permission.MESSAGE_MANAGE.
    Required to actually pin the Message.
  - addReaction
```
RestAction<java.lang.Void> addReaction(Emote emote)
```
    Adds a reaction to this Message using an Emote.
    Reactions are the small emoji/emotes below a message that have a counter beside them showing how many users have reacted with same emoji/emote.
    Neither success nor failure of this request will affect this Message's 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 TextChannel due to Permission.MESSAGE_READ being revoked, or the account lost access to the Guild or Group typically due to being kicked or removed.
      Also can happen if the account lost the Permission.MESSAGE_HISTORY
    - MISSING_PERMISSIONS
      The reaction request was attempted after the account lost Permission.MESSAGE_ADD_REACTION in the TextChannel when adding the reaction.
    - UNKNOWN_MESSAGE The reaction request was attempted after the Message had been deleted.
    Parameters:
    
    emote - The Emote to add as a reaction to this Message.
    
    Returns:
    
    RestAction - Type: Void
    
    Throws:
    PermissionException - If the MessageChannel this message was sent in was a TextChannel and the logged in account does not have
    
    Permission.MESSAGE_ADD_REACTION
    
    Permission.MESSAGE_HISTORY
    java.lang.IllegalArgumentException -
    
    If the provided Emote is null.
    
    If the provided Emote is fake Emote.isFake().
    
    If the provided Emote cannot be used in the current channel. See Emote.canInteract(User, MessageChannel) or Emote.canInteract(Member) for more information.
  - addReaction
```
RestAction<java.lang.Void> addReaction(java.lang.String unicode)
```
    Adds a reaction to this Message using a UTF8 emoji.
    A reference of UTF8 emojis can be found here: Emoji Table.
    Reactions are the small emoji/emotes below a message that have a counter beside them showing how many users have reacted with same emoji/emote.
    Neither success nor failure of this request will affect this Message's 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 TextChannel due to Permission.MESSAGE_READ being revoked, or the account lost access to the Guild or Group typically due to being kicked or removed.
      Also can happen if the account lost the Permission.MESSAGE_HISTORY
    - MISSING_PERMISSIONS
      The reaction request was attempted after the account lost Permission.MESSAGE_ADD_REACTION in the TextChannel when adding the reaction.
    - UNKNOWN_MESSAGE The reaction request was attempted after the Message had been deleted.
    Parameters:
    
    unicode - The UTF8 emoji to add as a reaction to this Message.
    
    Returns:
    
    RestAction - Type: Void
    
    Throws:
    PermissionException - If the MessageChannel this message was sent in was a TextChannel and the logged in account does not have
    
    Permission.MESSAGE_ADD_REACTION
    
    Permission.MESSAGE_HISTORY
    
    Permission.MESSAGE_ADD_REACTION in the channel.
    java.lang.IllegalArgumentException - If the provided unicode emoji is null or empty.
  - clearReactions
```
RestAction<java.lang.Void> clearReactions()
```
    Removes all reactions from this Message.
    This is useful for moderator commands that wish to remove all reactions at once from a specific message.
    Neither success nor failure of this request will affect this Message's 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 TextChannel due to Permission.MESSAGE_READ being revoked, or the account lost access to the Guild or Group typically due to being kicked or removed.
    - MISSING_PERMISSIONS
      The clear-reactions request was attempted after the account lost Permission.MESSAGE_MANAGE in the TextChannel when adding the reaction.
    - UNKNOWN_MESSAGE The clear-reactions request was attempted after the Message had been deleted.
    Returns:
    
    RestAction - Type: Void
    
    Throws:
    
    PermissionException - If the MessageChannel this message was sent in was a TextChannel and the currently logged in account does not have Permission.MESSAGE_MANAGE in the channel.
    
    java.lang.IllegalArgumentException - If the provided unicode emoji is null or empty.
  - getType
```
MessageType getType()
```
    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 occurs. A few examples are the system message informing that a message has been pinned. Another would be the system message informing that a call has been started or ended in a group.
    
    Returns:
    
    The MessageType of this message.

Interface Message

Nested Class Summary

Method Summary

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

Method Detail

getMentionedUsers

isMentioned

getMentionedChannels

getMentionedRoles

mentionsEveryone

isEdited

getEditedTime

getAuthor

getContent

getRawContent

getStrippedContent

isFromType

getChannelType

isWebhookMessage

getChannel

getPrivateChannel

getGroup

getTextChannel

getGuild

getAttachments

getEmbeds

getEmotes

getReactions

isTTS

editMessage

editMessage

editMessage

deleteMessage

delete

getJDA

isPinned

pin

unpin

addReaction

addReaction

clearReactions

getType