Interface Message
-
- All Superinterfaces:
Formattable,ISnowflake
public interface Message extends ISnowflake, Formattable
Represents a Text message received from Discord.
This represents messages received fromMessageChannels.This type is not updated. JDA does not keep track of changes to messages, it is advised to do this via events such as
MessageUpdateEventand similar.Message Differences
There are 3 implementations of this interface in JDA.- Received Message
Messages received through events or history query. These messages hold information of existing messages and can be modified or deleted. - System Message
Specification of Received Messages that are generated by Discord on certain events. Commonly this is used in groups or to indicate a pin within a MessageChannel. The different types can be found in theMessageTypeenum. - Data Message
This type is produced byMessageBuilderand only holds sendable information such as content or nonce. These messages do not allow any modifications via RestActions or information that is generated when sent such as the id to be used.
When a feature is not available it will throw an
UnsupportedOperationExceptionas per interface specifications.
Specific operations may have specified information available in thethrowsjavadoc.Formattable
This interface extendsFormattableand can be used with aFormattersuch as used byString.format(String, Object...)orPrintStream.printf(String, Object...).This will use
getContentDisplay()rather thanObject.toString()!
Supported Features:- Alternative
- UsinggetContentRaw()(Example:%#s- usesgetContentDisplay()) - Width/Left-Justification
- Ensures the size of a format (Example:%20s- uses at minimum 20 chars;%-10s- uses left-justified padding) - Precision
- Cuts the content to the specified size (replacing last 3 chars with...; Example:%.20s)
More information on formatting syntax can be found in the
format syntax documentation!
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classMessage.AttachmentRepresents aMessagefile attachment.static classMessage.MentionTypeMention formatting constants, useful for use withPatterns
-
Field Summary
Fields Modifier and Type Field Description static PatternINVITE_PATTERNPattern used to find instant invites in messages.static intMAX_CONTENT_LENGTHThe maximum amount of characters sendable in one message.static intMAX_FILE_AMOUNTThe maximum amount of files sendable within a single message (10)static intMAX_FILE_SIZEThe maximum sendable file size (8 MiB)static intMAX_FILE_SIZE_NITROThe maximum sendable file size for nitro (50 MiB)
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description RestAction<Void>addReaction(String unicode)Adds a reaction to this Message using a unicode emoji.RestAction<Void>addReaction(Emote emote)Adds a reaction to this Message using anEmote.RestAction<Void>clearReactions()Removes all reactions from this Message.AuditableRestAction<Void>delete()Deletes this Message from Discord.MessageActioneditMessage(CharSequence newContent)Edits this Message's content to the provided String.MessageActioneditMessage(Message newContent)Edits this Message's content to the providedMessage.MessageActioneditMessage(MessageEmbed newContent)Edits this Message's content to the providedMessageEmbed.MessageActioneditMessageFormat(String format, Object... args)Edits this Message's content to the provided format.MessageActivitygetActivity()AMessageActivitythat contains its type and party id.List<Message.Attachment>getAttachments()An immutable list ofAttachmentsthat are attached to this message.UsergetAuthor()The author of this MessageCategorygetCategory()TheCategorythis message was sent in.MessageChannelgetChannel()Returns theMessageChannelthat this message was sent in.ChannelTypegetChannelType()Gets theChannelTypethat this message was received from.StringgetContentDisplay()The textual content of this message in the format that would be shown to the Discord client.StringgetContentRaw()The raw textual content of this message.StringgetContentStripped()Gets the textual content of this message usinggetContentDisplay()and then strips it of markdown characters like *, **, __, ~~, || that provide text formatting.List<MessageEmbed>getEmbeds()An immutable list ofMessageEmbedsthat are part of this Message.List<Emote>getEmotes()AllEmotesused in this Message.GuildgetGuild()Returns theGuildthat this message was sent in.List<String>getInvites()Creates an immutable List ofInvitecodes that are included in this Message.JDAgetJDA()Returns theJDAinstance related to this Message.StringgetJumpUrl()Returns the jump-to URL for the received message.MembergetMember()Returns the author of this Message as amember.List<TextChannel>getMentionedChannels()A immutable list of all mentionedTextChannels.List<Member>getMentionedMembers()Creates an immutable list ofMembersrepresenting the users ofgetMentionedUsers()in theGuildthis Message was sent in.List<Member>getMentionedMembers(Guild guild)Creates an immutable list ofMembersrepresenting the users ofgetMentionedUsers()in the specifiedGuild.List<Role>getMentionedRoles()A immutable list of all mentionedRoles.List<User>getMentionedUsers()An immutable list of all mentionedUsers.List<IMentionable>getMentions(Message.MentionType... types)Combines all instances ofIMentionablefiltered by the specifiedMentionTypevalues.StringgetNonce()Validation nonce for this Message
This can be used to validate that a Message was properly sent to the Discord Service.PrivateChannelgetPrivateChannel()Returns thePrivateChannelthat this message was sent in.List<MessageReaction>getReactions()AllMessageReactionsthat are on this Message.TextChannelgetTextChannel()Returns theTextChannelthat this message was sent in.OffsetDateTimegetTimeEdited()Provides theOffsetDateTimedefining when this Message was last edited.MessageTypegetType()This specifies theMessageTypeof this Message.booleanisEdited()Returns whether or not this Message has been edited before.default booleanisFromGuild()Whether this message was sent in aGuild.booleanisFromType(ChannelType type)Used to determine if this Message was received from aMessageChannelof theChannelTypespecified.booleanisMentioned(IMentionable mentionable, Message.MentionType... types)Checks if givenIMentionablewas mentioned in this message in any way (@User, @everyone, @here, @Role).booleanisPinned()Whether or not this Message has been pinned in its parent channel.booleanisTTS()Defines whether or not this Message triggers TTS (Text-To-Speech).booleanisWebhookMessage()booleanmentionsEveryone()Indicates if this Message mentions everyone using @everyone or @here.RestAction<Void>pin()Used to add the Message to theMessageChannel'spinned message list.RestAction<Void>unpin()Used to remove the Message from theMessageChannel'spinned message list.-
Methods inherited from interface java.util.Formattable
formatTo
-
Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake
getId, getIdLong, getTimeCreated
-
-
-
-
Field Detail
-
MAX_FILE_SIZE
static final int MAX_FILE_SIZE
The maximum sendable file size (8 MiB)- See Also:
MessageAction.addFile(...), Constant Field Values
-
MAX_FILE_SIZE_NITRO
static final int MAX_FILE_SIZE_NITRO
The maximum sendable file size for nitro (50 MiB)- See Also:
MessageAction.addFile(...), Constant Field Values
-
MAX_FILE_AMOUNT
static final int MAX_FILE_AMOUNT
The maximum amount of files sendable within a single message (10)- See Also:
MessageAction.addFile(...), Constant Field Values
-
MAX_CONTENT_LENGTH
static final int MAX_CONTENT_LENGTH
The maximum amount of characters sendable in one message. (2000)
This only applies to the raw content and not embeds!- See Also:
MessageAction.append(...), Constant Field Values
-
INVITE_PATTERN
static final Pattern INVITE_PATTERN
Pattern used to find instant invites in messages.- See Also:
getInvites()
-
-
Method Detail
-
getMentionedUsers
@Nonnull List<User> getMentionedUsers()
An immutable list of all mentionedUsers.
If no user was mentioned, this list is empty.- Returns:
- immutable list of mentioned users
- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULT
-
getMentionedChannels
@Nonnull List<TextChannel> getMentionedChannels()
A immutable list of all mentionedTextChannels.
If none were mentioned, this list is empty.This may include TextChannels from other
Guilds- Returns:
- immutable list of mentioned TextChannels
- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULT
-
getMentionedRoles
@Nonnull List<Role> getMentionedRoles()
A immutable list of all mentionedRoles.
If none were mentioned, this list is empty.This may include Roles from other
Guilds- Returns:
- immutable list of mentioned Roles
- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULT
-
getMentionedMembers
@Nonnull List<Member> getMentionedMembers(@Nonnull Guild guild)
Creates an immutable list ofMembersrepresenting the users ofgetMentionedUsers()in the specifiedGuild.
This is only a convenience method and will skip all users that are not in the specified Guild.- Parameters:
guild- Non-nullGuildthat will be used to retrieve Members.- Returns:
- Immutable list of mentioned Members
- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTIllegalArgumentException- If the specified Guild isnull- Since:
- 3.4.0
-
getMentionedMembers
@Nonnull List<Member> getMentionedMembers()
Creates an immutable list ofMembersrepresenting the users ofgetMentionedUsers()in theGuildthis Message was sent in.
This is only a convenience method and will skip all users that are not in the specified Guild.
It will provide thegetGuild()output Guild togetMentionedMembers(Guild).- Returns:
- Immutable list of mentioned Members
- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTIllegalStateException- If this message was not sent in aTextChannel- Since:
- 3.4.0
-
getMentions
@Nonnull List<IMentionable> getMentions(@Nonnull Message.MentionType... types)
Combines all instances ofIMentionablefiltered by the specifiedMentionTypevalues.
This does not includegetMentionedMembers()to avoid duplicates.If no MentionType values are given this will fallback to all types.
- Parameters:
types- Amount ofMentionTypesto include in the list of mentions- Returns:
- Immutable list of filtered
IMentionableinstances - Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTIllegalArgumentException- If provided withnull- Since:
- 3.4.0
-
isMentioned
boolean isMentioned(@Nonnull IMentionable mentionable, @Nonnull Message.MentionType... types)
Checks if givenIMentionablewas mentioned in this message in any way (@User, @everyone, @here, @Role).
If no filteringMentionTypesare specified this will fallback to all mention types.MentionType.HEREandMentionType.EVERYONEwill only be checked, if the givenIMentionableis of typeUserorMember.
Online status of Users/Members is NOT considered when checkingMentionType.HERE.- Parameters:
mentionable- The mentionable entity to check on.types- The types to include when checking whether this type was mentioned. This will be used withgetMentions(MentionType...)- Returns:
- True, if the given mentionable was mentioned in this message
- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULT
-
mentionsEveryone
boolean mentionsEveryone()
Indicates if this Message mentions everyone using @everyone or @here.- 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.
-
getTimeEdited
@Nullable OffsetDateTime getTimeEdited()
Provides theOffsetDateTimedefining when this Message was last edited. If this Message has not been edited (isEdited()isfalse), then this method will returnnull.- Returns:
- Time of the most recent edit, or
nullif the Message has never been edited.
-
getAuthor
@Nonnull User getAuthor()
The author of this Message- Returns:
- Message author
- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULT
-
getMember
@Nullable Member getMember()
Returns the author of this Message as amember.
This is just a shortcut togetGuild().getMember(getAuthor()).
This is only valid if the Message was actually sent in a TextChannel. This will returnnullif it was not sent from a TextChannel.
You can check the type of channel this message was sent from usingisFromType(ChannelType)orgetChannelType().- Returns:
- Message author, or
nullif the message was not sent from a TextChannel. - Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULT
-
getJumpUrl
@Nonnull String getJumpUrl()
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.- Returns:
- A String representing the jump-to URL for the message
- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULT
-
getContentDisplay
@Nonnull String getContentDisplay()
The textual content of this message in the format that would be shown to the Discord client. AllIMentionableentities will be resolved to the format shown by the Discord client instead of the <id> format.This includes resolving:
Users/Membersto their @Username/@Nickname format,TextChannelsto their #ChannelName format,Rolesto their @RoleName formatEmotes(not emojis!) to their:name:format.If you want the actual Content (mentions as <@id>), use
getContentRaw()instead- Returns:
- The textual content of the message with mentions resolved to be visually like the Discord client.
- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULT
-
getContentRaw
@Nonnull String getContentRaw()
The raw textual content of this message. Does not resolveIMentionableentities likegetContentDisplay()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.
-
getContentStripped
@Nonnull String getContentStripped()
Gets the textual content of this message usinggetContentDisplay()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.- Returns:
- The textual content from
getContentDisplay()with all text formatting characters removed or escaped.
-
getInvites
@Nonnull List<String> getInvites()
Creates an immutable List ofInvitecodes that are included in this Message.
This will use thePatternprovided underINVITE_PATTERNto construct aMatcherthat will parse thegetContentRaw()output and include all codes it finds in a list.You can use the codes to retrieve/validate invites via
Invite.resolve(JDA, String)- Returns:
- Immutable list of invite codes
-
getNonce
@Nullable String getNonce()
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 useMessageBuilder.setNonce(String)!- Returns:
- The validation nonce
- Since:
- 3.4.0
- See Also:
MessageBuilder.setNonce(String), Cryptographic Nonce - Wikipedia
-
isFromType
boolean isFromType(@Nonnull ChannelType type)
Used to determine if this Message was received from aMessageChannelof theChannelTypespecified.
This will always be false forChannelType.VOICEas Messages can't be sent toVoiceChannels.Useful for restricting functionality to a certain type of channels.
- Parameters:
type- TheChannelTypeto check against.- Returns:
- True if the
ChannelTypewhich this message was received from is the same as the one specified bytype. - Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULT
-
isFromGuild
default boolean isFromGuild()
Whether this message was sent in aGuild.
If this isfalsethengetGuild()will throw anIllegalStateException.- Returns:
- True, if
getChannelType().isGuild()is true.
-
getChannelType
@Nonnull ChannelType getChannelType()
Gets theChannelTypethat this message was received from.
This will never beChannelType.VOICEas Messages can't be sent toVoiceChannels.- Returns:
- The ChannelType which this message was received from.
- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULT
-
isWebhookMessage
boolean isWebhookMessage()
Indicates if this Message was sent by aWebhookinstead of aUser.
Useful if you want to ignore non-users.- Returns:
- True if this message was sent by a
Webhook.
-
getChannel
@Nonnull MessageChannel getChannel()
Returns theMessageChannelthat this message was sent in.- Returns:
- The MessageChannel of this Message
- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULT
-
getPrivateChannel
@Nonnull PrivateChannel getPrivateChannel()
Returns thePrivateChannelthat this message was sent in.
This is only valid if the Message was actually sent in a PrivateChannel.
You can check the type of channel this message was sent from usingisFromType(ChannelType)orgetChannelType().Use
getChannel()for an ambiguousMessageChannelif you do not need functionality specific toPrivateChannel.- Returns:
- The PrivateChannel this message was sent in
- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTIllegalStateException- If this was not sent in aPrivateChannel.- See Also:
isFromGuild(),isFromType(ChannelType),getChannelType()
-
getTextChannel
@Nonnull TextChannel getTextChannel()
Returns theTextChannelthat this message was sent in.
This is only valid if the Message was actually sent in a TextChannel.
You can check the type of channel this message was sent from usingisFromType(ChannelType)orgetChannelType().Use
getChannel()for an ambiguousMessageChannelif you do not need functionality specific toTextChannel.- Returns:
- The TextChannel this message was sent in
- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTIllegalStateException- If this was not sent in aTextChannel.- See Also:
isFromGuild(),isFromType(ChannelType),getChannelType()
-
getCategory
@Nullable Category getCategory()
TheCategorythis message was sent in. This will always benullfor DMs.
Equivalent togetTextChannel().getParent()if this was sent in aTextChannel.- Returns:
Categoryfor this message- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULT
-
getGuild
@Nonnull Guild getGuild()
Returns theGuildthat this message was sent in.
This is just a shortcut togetTextChannel().getGuild().
This is only valid if the Message was actually sent in a TextChannel.
You can check the type of channel this message was sent from usingisFromType(ChannelType)orgetChannelType().- Returns:
- The Guild this message was sent in
- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTIllegalStateException- If this was not sent in aTextChannel.- See Also:
isFromGuild(),isFromType(ChannelType),getChannelType()
-
getAttachments
@Nonnull List<Message.Attachment> getAttachments()
An immutable list ofAttachmentsthat are attached to this message.
Most likely this will only ever be 1Attachmentat most.- Returns:
- Immutable list of
Attachments.
-
getEmbeds
@Nonnull List<MessageEmbed> getEmbeds()
An immutable list ofMessageEmbedsthat are part of this Message.- Returns:
- Immutable list of all given MessageEmbeds.
-
getEmotes
@Nonnull List<Emote> getEmotes()
AllEmotesused in this Message.
This only includes Custom Emotes, not UTF8 Emojis. JDA classifies Emotes as the Custom Emojis uploaded to a Guild and retrievable withGuild.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.Unicode emojis are not included as
Emote!- Returns:
- An immutable list of the Emotes used in this message (example match <:jda:230988580904763393>)
- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULT
-
getReactions
@Nonnull List<MessageReaction> getReactions()
AllMessageReactionsthat 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.
-
getActivity
@Nullable MessageActivity getActivity()
AMessageActivitythat contains its type and party id.- Returns:
- The activity, or
nullif no activity was added to the message.
-
editMessage
@Nonnull @CheckReturnValue MessageAction editMessage(@Nonnull CharSequence newContent)
Edits this Message's content to the provided String.
Messages can only be edited by the account that sent them!.This message instance will not be updated by this operation, please use the response message instead.
The following
ErrorResponsesare possible:MISSING_ACCESS
The edit was attempted after the account lost access to theGuildtypically due to being kicked or removed.MISSING_PERMISSIONS
The edit was attempted after the account lostPermission.MESSAGE_WRITEin theTextChannel.UNKNOWN_MESSAGE
The edit was attempted after the Message had been deleted.
- Parameters:
newContent- the new content of the Message- Returns:
MessageAction
TheMessagewith the updated content- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTIllegalStateException- If the message attempting to be edited was not created by the currently logged in account, or ifnewContent's length is 0 or greater than 2000.
-
editMessage
@Nonnull @CheckReturnValue MessageAction editMessage(@Nonnull MessageEmbed newContent)
Edits this Message's content to the providedMessageEmbed.
Messages can only be edited by the account that sent them!.This message instance will not be updated by this operation, please use the response message instead.
The following
ErrorResponsesare possible:MISSING_ACCESS
The edit was attempted after the account lost access to theGuildtypically due to being kicked or removed.MISSING_PERMISSIONS
The edit was attempted after the account lostPermission.MESSAGE_WRITEin theTextChannel.UNKNOWN_MESSAGE
The edit was attempted after the Message had been deleted.
- Parameters:
newContent- the new content of the Message- Returns:
MessageAction
TheMessagewith the updated content- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTIllegalStateException- If the message attempting to be edited was not created by the currently logged in account, or if the passed-in embed isnullor notsendable
-
editMessageFormat
@Nonnull @CheckReturnValue MessageAction editMessageFormat(@Nonnull String format, @Nonnull Object... args)
Edits this Message's content to the provided format.
Shortcut forMessageBuilder.appendFormat(String, Object...).
Messages can only be edited by the account that sent them!.This message instance will not be updated by this operation, please use the response message instead.
The following
ErrorResponsesare possible:MISSING_ACCESS
The edit was attempted after the account lost access to theGuildtypically due to being kicked or removed.MISSING_PERMISSIONS
The edit was attempted after the account lostPermission.MESSAGE_WRITEin theTextChannel.UNKNOWN_MESSAGE
The edit was attempted after the Message had been deleted.
- Parameters:
format- Format String used to generate the Message's content viaMessageBuilder.appendFormat(String, Object...)specificationargs- The arguments to use in order to be converted in the format string- Returns:
MessageAction
TheMessagewith the updated content- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTIllegalArgumentException- If the provided format String isnullor blank, or if the created message exceeds the 2000 character limitIllegalFormatException- If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.IllegalStateException- If the message attempting to be edited was not created by the currently logged in account
-
editMessage
@Nonnull @CheckReturnValue MessageAction editMessage(@Nonnull Message newContent)
Edits this Message's content to the providedMessage.
Messages can only be edited by the account that sent them!.This message instance will not be updated by this operation, please use the response message instead.
The following
ErrorResponsesare possible:MISSING_ACCESS
The edit was attempted after the account lost access to theGuildtypically due to being kicked or removed.MISSING_PERMISSIONS
The edit was attempted after the account lostPermission.MESSAGE_WRITEin theTextChannel.UNKNOWN_MESSAGE
The edit was attempted after the Message had been deleted.
- Parameters:
newContent- the new content of the Message- Returns:
MessageAction
TheMessagewith the updated content- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTIllegalStateException-- 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
-
delete
@Nonnull @CheckReturnValue AuditableRestAction<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 aTextChanneland the current account hasPermission.MESSAGE_MANAGEin the channel.To delete many messages at once in a
MessageChannelyou should useMessageChannel.purgeMessages(Collection)instead.The following
ErrorResponsesare possible:MISSING_ACCESS
The delete was attempted after the account lost access to theTextChanneldue toPermission.MESSAGE_READbeing revoked, or the account lost access to theGuildtypically due to being kicked or removed.MISSING_PERMISSIONS
The delete was attempted after the account lostPermission.MESSAGE_MANAGEin theTextChannelwhen deleting another Member's message or lostPermission.MESSAGE_MANAGE.UNKNOWN_MESSAGEThe pin was attempted after the Message had been deleted.
- Returns:
AuditableRestAction- Throws:
UnsupportedOperationException- If this is a Data Message (output ofMessageBuilder)InsufficientPermissionException- If this Message was not sent by the currently logged in account, the Message was sent in aTextChannel, and the currently logged in account does not havePermission.MESSAGE_MANAGEin the channel.IllegalStateException- If this Message was not sent by the currently logged in account and it was not sent in aTextChannel.- See Also:
TextChannel.deleteMessages(Collection),MessageChannel.purgeMessages(List)
-
getJDA
@Nonnull JDA getJDA()
Returns theJDAinstance related to this Message.- Returns:
- the corresponding JDA instance
- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULT
-
isPinned
boolean isPinned()
Whether or not this Message has been pinned in its parent channel.- Returns:
- True - if this message has been pinned.
-
pin
@Nonnull @CheckReturnValue RestAction<Void> pin()
Used to add the Message to theMessageChannel'spinned message list.
This is a shortcut method toMessageChannel.pinMessageById(String).The success or failure of this action will not affect the return of
isPinned().The following
ErrorResponsesare possible:MISSING_ACCESS
The pin request was attempted after the account lost access to theTextChanneldue toPermission.MESSAGE_READbeing revoked, or the account lost access to theGuildtypically due to being kicked or removed.MISSING_PERMISSIONS
The pin request was attempted after the account lostPermission.MESSAGE_MANAGEin theTextChannel.UNKNOWN_MESSAGEThe pin request was attempted after the Message had been deleted.
- Returns:
RestAction- Type:Void- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTInsufficientPermissionException- If this Message is from aTextChanneland:- 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.
- Missing
-
unpin
@Nonnull @CheckReturnValue RestAction<Void> unpin()
Used to remove the Message from theMessageChannel'spinned message list.
This is a shortcut method toMessageChannel.unpinMessageById(String).The success or failure of this action will not affect the return of
isPinned().The following
ErrorResponsesare possible:MISSING_ACCESS
The unpin request was attempted after the account lost access to theTextChanneldue toPermission.MESSAGE_READbeing revoked, or the account lost access to theGuildtypically due to being kicked or removed.MISSING_PERMISSIONS
The unpin request was attempted after the account lostPermission.MESSAGE_MANAGEin theTextChannel.UNKNOWN_MESSAGEThe unpin request was attempted after the Message had been deleted.
- Returns:
RestAction- Type:Void- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTInsufficientPermissionException- If this Message is from aTextChanneland:- 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.
- Missing
-
addReaction
@Nonnull @CheckReturnValue RestAction<Void> addReaction(@Nonnull Emote emote)
Adds a reaction to this Message using anEmote.This message instance will not be updated by this operation.
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.Unicode emojis are not included as
Emote!The following
ErrorResponsesare possible:MISSING_ACCESS
The reaction request was attempted after the account lost access to theTextChanneldue toPermission.MESSAGE_READbeing revoked, or the account lost access to theGuildtypically due to being kicked or removed.
Also can happen if the account lost thePermission.MESSAGE_HISTORYMISSING_PERMISSIONS
The reaction request was attempted after the account lostPermission.MESSAGE_ADD_REACTIONin theTextChannelwhen adding the reaction.UNKNOWN_MESSAGEThe reaction request was attempted after the Message had been deleted.
- Parameters:
emote- TheEmoteto add as a reaction to this Message.- Returns:
RestAction- Type:Void- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTInsufficientPermissionException- If the MessageChannel this message was sent in was aTextChanneland the logged in account does not haveIllegalArgumentException-- If the provided
Emoteis null. - If the provided
Emoteis fakeEmote.isFake(). - If the provided
Emotecannot be used in the current channel. SeeEmote.canInteract(User, MessageChannel)orEmote.canInteract(Member)for more information.
- If the provided
-
addReaction
@Nonnull @CheckReturnValue RestAction<Void> addReaction(@Nonnull String unicode)
Adds a reaction to this Message using a unicode emoji.
A reference of unicode emojis can be found here: Emoji Table.This message instance will not be updated by this operation.
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.Examples
// custom
message.addReaction("minn:245267426227388416").queue();
// unicode escape
message.addReaction("\uD83D\uDE02").queue();
// codepoint notation
message.addReaction("U+1F602").queue();The following
ErrorResponsesare possible:MISSING_ACCESS
The reaction request was attempted after the account lost access to theTextChanneldue toPermission.MESSAGE_READbeing revoked, or the account lost access to theGuildtypically due to being kicked or removed.
Also can happen if the account lost thePermission.MESSAGE_HISTORYMISSING_PERMISSIONS
The reaction request was attempted after the account lostPermission.MESSAGE_ADD_REACTIONin theTextChannelwhen adding the reaction.UNKNOWN_MESSAGEThe reaction request was attempted after the Message had been deleted.
- Parameters:
unicode- The unicode emoji to add as a reaction to this Message.- Returns:
RestAction- Type:Void- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTInsufficientPermissionException- If the MessageChannel this message was sent in was aTextChanneland the logged in account does not haveIllegalArgumentException- If the provided unicode emoji is null or empty.
-
clearReactions
@Nonnull @CheckReturnValue RestAction<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
ErrorResponsesare possible:MISSING_ACCESS
The clear-reactions request was attempted after the account lost access to theTextChanneldue toPermission.MESSAGE_READbeing revoked, or the account lost access to theGuildtypically due to being kicked or removed.MISSING_PERMISSIONS
The clear-reactions request was attempted after the account lostPermission.MESSAGE_MANAGEin theTextChannelwhen adding the reaction.UNKNOWN_MESSAGEThe clear-reactions request was attempted after the Message had been deleted.
- Returns:
RestAction- Type:Void- Throws:
UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTInsufficientPermissionException- If the MessageChannel this message was sent in was aTextChanneland the currently logged in account does not havePermission.MESSAGE_MANAGEin the channel.IllegalStateException- If this message was not sent in aTextChannel.
-
getType
@Nonnull MessageType getType()
This specifies theMessageTypeof 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 messagesor special messages likewelcome messages.- Returns:
- The
MessageTypeof this message.
-
-