Interface Message
-
- All Superinterfaces:
java.util.Formattable,ISnowflake
public interface Message extends ISnowflake, java.util.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!- See Also:
MessageBuilder,MessageChannel.sendMessage(Message),MessageChannel.getIterableHistory(),MessageChannel.getHistory(),MessageChannel.getHistoryAfter(String, int),MessageChannel.getHistoryBefore(String, int),MessageChannel.getHistoryAround(String, int),MessageChannel.getHistoryFromBeginning(int),MessageChannel.retrieveMessageById(String),MessageChannel.deleteMessageById(String),MessageChannel.editMessageById(String, CharSequence)
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classMessage.AttachmentRepresents aMessagefile attachment.static classMessage.InteractionRepresents anInteractionprovided with aMessage.static classMessage.MentionTypeMention constants, useful for use withPatternsstatic classMessage.MessageFlagEnum representing the flags on a Message.
-
Field Summary
Fields Modifier and Type Field Description static java.util.regex.PatternINVITE_PATTERNPattern used to find instant invites in strings.static java.util.regex.PatternJUMP_URL_PATTERNPattern used to findJump URLsin strings.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)static intMAX_REACTIONSThe maximum amount of reactions that can be added to one message (20)
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description RestAction<java.lang.Void>addReaction(java.lang.String unicode)Adds a reaction to this Message using a unicode emoji.RestAction<java.lang.Void>addReaction(Emote emote)Adds a reaction to this Message using anEmote.RestAction<java.lang.Void>clearReactions()Removes all reactions from this Message.RestAction<java.lang.Void>clearReactions(java.lang.String unicode)Removes all reactions for the specified emoji.RestAction<java.lang.Void>clearReactions(Emote emote)Removes all reactions for the specified emote.RestAction<Message>crosspost()Attempts to crosspost this message.AuditableRestAction<java.lang.Void>delete()Deletes this Message from Discord.MessageActioneditMessage(java.lang.CharSequence newContent)Edits this Message's content to the provided String.MessageActioneditMessage(Message newContent)Edits this Message's content to the providedMessage.default MessageActioneditMessage(MessageEmbed newContent)Deprecated.UseeditMessageEmbeds(MessageEmbed...)insteadMessageActioneditMessageComponents(java.util.Collection<? extends ComponentLayout> components)Edits this Message's content to the providedComponentLayouts.default MessageActioneditMessageComponents(ComponentLayout... components)Edits this Message's content to the providedComponentLayouts.MessageActioneditMessageEmbeds(java.util.Collection<? extends MessageEmbed> embeds)Edits this Message's content to the providedMessageEmbeds.default MessageActioneditMessageEmbeds(MessageEmbed... embeds)Edits this Message's content to the providedMessageEmbeds.MessageActioneditMessageFormat(java.lang.String format, java.lang.Object... args)Edits this Message's content to the provided format.java.util.List<ActionRow>getActionRows()Rows of interactive components such asButtons.MessageActivitygetActivity()AMessageActivitythat contains its type and party id.java.util.List<Message.Attachment>getAttachments()An immutable list ofAttachmentsthat are attached to this message.UsergetAuthor()The author of this Messagedefault ButtongetButtonById(java.lang.String id)Gets theButtonwith the specified ID.default java.util.List<Button>getButtons()AllButtonsattached to this message.default java.util.List<Button>getButtonsByLabel(java.lang.String label, boolean ignoreCase)AllButtonswith the specified label attached to this message.CategorygetCategory()TheCategorythis message was sent in.MessageChannelgetChannel()Returns theMessageChannelthat this message was sent in.ChannelTypegetChannelType()Gets theChannelTypethat this message was received from.java.lang.StringgetContentDisplay()The textual content of this message in the format that would be shown to the Discord client.java.lang.StringgetContentRaw()The raw textual content of this message.java.lang.StringgetContentStripped()Gets the textual content of this message usinggetContentDisplay()and then strips it of markdown characters like *, **, __, ~~, || that provide text formatting.java.util.List<MessageEmbed>getEmbeds()An immutable list ofMessageEmbedsthat are part of this Message.java.util.List<Emote>getEmotes()AllEmotesused in this Message.org.apache.commons.collections4.Bag<Emote>getEmotesBag()ABagof emotes used in this message.java.util.EnumSet<Message.MessageFlag>getFlags()Returns an EnumSet of allMessageFlagspresent for this Message.longgetFlagsRaw()Returns the raw message flags of this messageGuildgetGuild()Returns theGuildthat this message was sent in.Message.InteractiongetInteraction()This is sent on the message object when the message is a response to anInteractionwithout an existing message.java.util.List<java.lang.String>getInvites()Creates an immutable List ofInvitecodes that are included in this Message.JDAgetJDA()Returns theJDAinstance related to this Message.java.lang.StringgetJumpUrl()Returns the jump-to URL for the received message.MembergetMember()Returns the author of this Message as amember.java.util.List<TextChannel>getMentionedChannels()A immutable list of all mentionedTextChannels.org.apache.commons.collections4.Bag<TextChannel>getMentionedChannelsBag()ABagof mentioned channels.java.util.List<Member>getMentionedMembers()Creates an immutable list ofMembersrepresenting the users ofgetMentionedUsers()in theGuildthis Message was sent in.java.util.List<Member>getMentionedMembers(Guild guild)Creates an immutable list ofMembersrepresenting the users ofgetMentionedUsers()in the specifiedGuild.java.util.List<Role>getMentionedRoles()A immutable list of all mentionedRoles.org.apache.commons.collections4.Bag<Role>getMentionedRolesBag()ABagof mentioned roles.java.util.List<User>getMentionedUsers()An immutable list of all mentionedUsers.org.apache.commons.collections4.Bag<User>getMentionedUsersBag()ABagof mentioned users.java.util.List<IMentionable>getMentions(Message.MentionType... types)Combines all instances ofIMentionablefiltered by the specifiedMentionTypevalues.MessageReferencegetMessageReference()Returns theMessageReferencefor this Message.java.lang.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.MessageReaction.ReactionEmotegetReactionById(long id)This obtains theReactionEmotefor the given reaction id on this message.MessageReaction.ReactionEmotegetReactionById(java.lang.String id)This obtains theReactionEmotefor the given reaction id on this message.MessageReaction.ReactionEmotegetReactionByUnicode(java.lang.String unicode)This obtains theReactionEmotefor the given unicode reaction on this message.java.util.List<MessageReaction>getReactions()AllMessageReactionsthat are on this Message.default MessagegetReferencedMessage()Referenced message.java.util.List<MessageSticker>getStickers()AllMessageStickersthat are in this Message.TextChannelgetTextChannel()Returns theTextChannelthat this message was sent in.java.time.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.booleanisEphemeral()Whether this message is ephemeral.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.booleanisSuppressedEmbeds()Whether embeds are suppressed for this message.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<java.lang.Void>pin()Used to add the Message to theMessageChannel'spinned message list.RestAction<java.lang.Void>removeReaction(java.lang.String unicode)Removes a reaction from this Message using a unicode emoji.RestAction<java.lang.Void>removeReaction(java.lang.String unicode, User user)Removes a reaction from this Message using a unicode emoji.RestAction<java.lang.Void>removeReaction(Emote emote)Removes a reaction from this Message using anEmote.RestAction<java.lang.Void>removeReaction(Emote emote, User user)default MessageActionreply(byte[] data, java.lang.String name, AttachmentOption... options)Replies and references this message.default MessageActionreply(java.io.File data, java.lang.String name, AttachmentOption... options)Replies and references this message.default MessageActionreply(java.io.File file, AttachmentOption... options)Replies and references this message.default MessageActionreply(java.io.InputStream data, java.lang.String name, AttachmentOption... options)Replies and references this message.default MessageActionreply(java.lang.CharSequence content)Replies and references this message.default MessageActionreply(Message content)Replies and references this message.default MessageActionreply(MessageEmbed content)Deprecated.UsereplyEmbeds(MessageEmbed, MessageEmbed...)insteaddefault MessageActionreplyEmbeds(java.util.Collection<? extends MessageEmbed> embeds)Replies and references this message.default MessageActionreplyEmbeds(MessageEmbed embed, MessageEmbed... other)Replies and references this message.default MessageActionreplyFormat(java.lang.String format, java.lang.Object... args)Replies and references this message.ReactionPaginationActionretrieveReactionUsers(java.lang.String unicode)This obtains theuserswho reacted using the given unicode emoji.ReactionPaginationActionretrieveReactionUsers(Emote emote)AuditableRestAction<java.lang.Void>suppressEmbeds(boolean suppressed)Enables/Disables suppression of Embeds on this Message.RestAction<java.lang.Void>unpin()Used to remove the Message from theMessageChannel'spinned message list.-
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
-
MAX_REACTIONS
static final int MAX_REACTIONS
The maximum amount of reactions that can be added to one message (20)
-
INVITE_PATTERN
static final java.util.regex.Pattern INVITE_PATTERN
Pattern used to find instant invites in strings.The only named group is at index 1 with the name
"code".- See Also:
getInvites()
-
JUMP_URL_PATTERN
static final java.util.regex.Pattern JUMP_URL_PATTERN
Pattern used to findJump URLsin strings.Groups
You can use the names withIndex Name Description 0 N/A The entire link 1 guild The ID of the target guild 2 channel The ID of the target channel 3 message The ID of the target message Matcher.group(String)and the index withMatcher.group(int).- See Also:
getJumpUrl()
-
-
Method Detail
-
getMessageReference
@Nullable MessageReference getMessageReference()
Returns theMessageReferencefor this Message. This will be null if this Message has no reference.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().- Returns:
- The message reference, or null.
-
getReferencedMessage
@Nullable default Message getReferencedMessage()
Referenced message.This will have different meaning depending on the
typeof message. Usually, this is aINLINE_REPLYreference. This can be null even if the type isINLINE_REPLY, when the message it references doesn't exist or discord wasn't able to resolve it in time.This differs from a
MessageReference, which contains the raw IDs attached to the reference, and allows you to retrieve the referenced message- Returns:
- The referenced message, or null
- See Also:
getMessageReference()
-
getMentionedUsers
@Nonnull java.util.List<User> getMentionedUsers()
An immutable list of all mentionedUsers.
If no user was mentioned, this list is empty. Elements are sorted in order of appearance. This only counts direct mentions of the user and not mentions through roles or the everyone tag.- Returns:
- immutable list of mentioned users
- Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
getMentionedUsersBag
@Nonnull org.apache.commons.collections4.Bag<User> getMentionedUsersBag()
ABagof mentioned users.
This can be used to retrieve the amount of times a user was mentioned in this message. This only counts direct mentions of the user and not mentions through roles or the everyone tag.Example
public void sendCount(Message msg) { List<User> mentions = msg.getMentionedUsers(); // distinct list, in order of appearance Bag<User> count = msg.getMentionedUsersBag(); StringBuilder content = new StringBuilder(); for (User user : mentions) { content.append(user.getAsTag()) .append(": ") .append(count.getCount(user)) .append("\n"); } msg.getChannel().sendMessage(content.toString()).queue(); }- Returns:
Bagof mentioned users- Throws:
java.lang.UnsupportedOperationException- If this is a system message- See Also:
getMentionedUsers()
-
getMentionedChannels
@Nonnull java.util.List<TextChannel> getMentionedChannels()
A immutable list of all mentionedTextChannels.
If none were mentioned, this list is empty. Elements are sorted in order of appearance.This may include TextChannels from other
Guilds- Returns:
- immutable list of mentioned TextChannels
- Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
getMentionedChannelsBag
@Nonnull org.apache.commons.collections4.Bag<TextChannel> getMentionedChannelsBag()
ABagof mentioned channels.
This can be used to retrieve the amount of times a channel was mentioned in this message.Example
public void sendCount(Message msg) { List<TextChannel> mentions = msg.getMentionedTextChannels(); // distinct list, in order of appearance Bag<TextChannel> count = msg.getMentionedTextChannelsBag(); StringBuilder content = new StringBuilder(); for (TextChannel channel : mentions) { content.append("#") .append(channel.getName()) .append(": ") .append(count.getCount(channel)) .append("\n"); } msg.getChannel().sendMessage(content.toString()).queue(); }- Returns:
Bagof mentioned channels- Throws:
java.lang.UnsupportedOperationException- If this is a system message- See Also:
getMentionedChannels()
-
getMentionedRoles
@Nonnull java.util.List<Role> getMentionedRoles()
A immutable list of all mentionedRoles.
If none were mentioned, this list is empty. Elements are sorted in order of appearance. This only counts direct mentions of the role and not mentions through the everyone tag.This may include Roles from other
Guilds- Returns:
- immutable list of mentioned Roles
- Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
getMentionedRolesBag
@Nonnull org.apache.commons.collections4.Bag<Role> getMentionedRolesBag()
ABagof mentioned roles.
This can be used to retrieve the amount of times a role was mentioned in this message. This only counts direct mentions of the role and not mentions through the everyone tag. If a role is notmentionableit will not be included.Example
public void sendCount(Message msg) { List<Role> mentions = msg.getMentionedRoles(); // distinct list, in order of appearance Bag<Role> count = msg.getMentionedRolesBag(); StringBuilder content = new StringBuilder(); for (Role role : mentions) { content.append(role.getName()) .append(": ") .append(count.getCount(role)) .append("\n"); } msg.getChannel().sendMessage(content.toString()).queue(); }- Returns:
Bagof mentioned roles- Throws:
java.lang.UnsupportedOperationException- If this is a system message- See Also:
getMentionedRoles()
-
getMentionedMembers
@Nonnull java.util.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:
java.lang.UnsupportedOperationException- If this is a system messagejava.lang.IllegalArgumentException- If the specified Guild isnull- Since:
- 3.4.0
-
getMentionedMembers
@Nonnull java.util.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:
java.lang.UnsupportedOperationException- If this is a system messagejava.lang.IllegalStateException- If this message was not sent in aTextChannel- Since:
- 3.4.0
-
getMentions
@Nonnull java.util.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:
java.lang.UnsupportedOperationException- If this is a system messagejava.lang.IllegalArgumentException- 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:
java.lang.UnsupportedOperationException- If this is a system message
-
mentionsEveryone
boolean mentionsEveryone()
Indicates if this Message mentions everyone using @everyone or @here.- Returns:
- True, if message is mentioning everyone
- Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
isEdited
boolean isEdited()
Returns whether or not this Message has been edited before.- Returns:
- True if this message has been edited.
- Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
getTimeEdited
@Nullable java.time.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. - Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
getAuthor
@Nonnull User getAuthor()
The author of this Message- Returns:
- Message author
- Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
getMember
@Nullable Member getMember()
Returns the author of this Message as amember.
This is only valid if the Message was actually sent in a TextChannel. This will returnnullif the message was not sent in a TextChannel, or if the message was sent by a Webhook.
You can check the type of channel this message was sent from usingisFromType(ChannelType)orgetChannelType().Discord does not provide a member object for messages returned by
RestActionsof any kind. This will return null if the message was retrieved throughMessageChannel.retrieveMessageById(long)or similar means, unless the member is already cached.- Returns:
- Message author, or
nullif the message was not sent in a TextChannel, or if the message was sent by a Webhook. - Throws:
java.lang.UnsupportedOperationException- If this is a system message- See Also:
isWebhookMessage()
-
getJumpUrl
@Nonnull java.lang.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:
java.lang.UnsupportedOperationException- If this is a system message
-
getContentDisplay
@Nonnull java.lang.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:
java.lang.UnsupportedOperationException- If this is a system message
-
getContentRaw
@Nonnull java.lang.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 java.lang.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. - Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
getInvites
@Nonnull java.util.List<java.lang.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
- Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
getNonce
@Nullable java.lang.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:
java.lang.UnsupportedOperationException- If this is a system message
-
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:
java.lang.UnsupportedOperationException- If this is a system message
-
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. - Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
getChannel
@Nonnull MessageChannel getChannel()
Returns theMessageChannelthat this message was sent in.- Returns:
- The MessageChannel of this Message
- Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
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:
java.lang.UnsupportedOperationException- If this is a system messagejava.lang.IllegalStateException- 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:
java.lang.UnsupportedOperationException- If this is a system messagejava.lang.IllegalStateException- 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:
java.lang.UnsupportedOperationException- If this is a system message
-
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:
java.lang.UnsupportedOperationException- If this is a system messagejava.lang.IllegalStateException- If this was not sent in aTextChannel.- See Also:
isFromGuild(),isFromType(ChannelType),getChannelType()
-
getAttachments
@Nonnull java.util.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. - Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
getEmbeds
@Nonnull java.util.List<MessageEmbed> getEmbeds()
An immutable list ofMessageEmbedsthat are part of this Message.- Returns:
- Immutable list of all given MessageEmbeds.
- Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
getActionRows
@Nonnull java.util.List<ActionRow> getActionRows()
Rows of interactive components such asButtons.
You can useMessageAction.setActionRows(ActionRow...)to update these.- Returns:
- Immutable
ListofActionRow - See Also:
getButtons(),getButtonById(String)
-
getButtons
@Nonnull default java.util.List<Button> getButtons()
AllButtonsattached to this message.- Returns:
- Immutable
ListofButtons
-
getButtonById
@Nullable default Button getButtonById(@Nonnull java.lang.String id)
Gets theButtonwith the specified ID.- Parameters:
id- The id of the button- Returns:
- The
Buttonor null of no button with that ID is present on this message - Throws:
java.lang.IllegalArgumentException- If the id is null
-
getButtonsByLabel
@Nonnull default java.util.List<Button> getButtonsByLabel(@Nonnull java.lang.String label, boolean ignoreCase)
AllButtonswith the specified label attached to this message.- Parameters:
label- The button labelignoreCase- Whether to useString.equalsIgnoreCase(String)instead ofString.equals(Object)- Returns:
- Immutable
ListofButtonswith the specified label - Throws:
java.lang.IllegalArgumentException- If the provided label is null
-
getEmotes
@Nonnull java.util.List<Emote> getEmotes()
AllEmotesused in this Message.
This only includes Custom Emotes, not unicode Emojis. JDA classifies Emotes as the Custom Emojis uploaded to a Guild and retrievable withGuild.getEmotes(). These are not the same as the unicode emojis that Discord also supports. Elements are sorted in order of appearance.Unicode emojis are not included as
Emote!- Returns:
- An immutable list of the Emotes used in this message (example match <:jda:230988580904763393>)
- Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
getEmotesBag
@Nonnull org.apache.commons.collections4.Bag<Emote> getEmotesBag()
ABagof emotes used in this message.
This can be used to retrieve the amount of times an emote was used in this message.Example
public void sendCount(Message msg) { List<Emote> emotes = msg.getEmotes(); // distinct list, in order of appearance Bag<Emote> count = msg.getEmotesBag(); StringBuilder content = new StringBuilder(); for (Emote emote : emotes) { content.append(emote.getName()) .append(": ") .append(count.getCount(role)) .append("\n"); } msg.getChannel().sendMessage(content.toString()).queue(); }- Returns:
Bagof used emotes- Throws:
java.lang.UnsupportedOperationException- If this is a system message- See Also:
getEmotes()
-
getReactions
@Nonnull java.util.List<MessageReaction> getReactions()
AllMessageReactionsthat are on this Message.- Returns:
- Immutable list of all MessageReactions on this message.
- Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
getStickers
@Nonnull java.util.List<MessageSticker> getStickers()
AllMessageStickersthat are in this Message.
The returned MessageStickers may only contain necessary information such as the sticker id, format type, name, and icon url.- Returns:
- Immutable list of all MessageStickers in this message.
- Throws:
java.lang.UnsupportedOperationException- If this is a system 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 java.lang.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
If the message has already been deleted. This might also be triggered for ephemeral messages.
- Parameters:
newContent- the new content of the Message- Returns:
MessageAction
TheMessagewith the updated content- Throws:
java.lang.UnsupportedOperationException- If this is a system messagejava.lang.IllegalStateException- 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 @Deprecated @ForRemoval(deadline="5.0.0") @ReplaceWith("editMessageEmbeds(newEmbed)") @DeprecatedSince("4.4.0") default MessageAction editMessage(@Nonnull MessageEmbed newContent)
Deprecated.UseeditMessageEmbeds(MessageEmbed...)insteadEdits 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
If the message has already been deleted. This might also be triggered for ephemeral messages.
- Parameters:
newContent- the new content of the Message- Returns:
MessageAction
TheMessagewith the updated content- Throws:
java.lang.UnsupportedOperationException- If this is a system messagejava.lang.IllegalStateException- If the message attempting to be edited was not created by the currently logged in account, or if the passed-in embed isnullor notsendable
-
editMessageEmbeds
@Nonnull @CheckReturnValue MessageAction editMessageEmbeds(@Nonnull java.util.Collection<? extends MessageEmbed> embeds)
Edits this Message's content to the providedMessageEmbeds.
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
If the message has already been deleted. This might also be triggered for ephemeral messages.
- Parameters:
embeds- the new embeds of the Message (up to 10)- Returns:
MessageAction
TheMessagewith the updated content- Throws:
java.lang.UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTjava.lang.IllegalStateException- If the message attempting to be edited was not created by the currently logged in accountjava.lang.IllegalArgumentException- if any of the passed-in embeds isnullor notsendable.
-
editMessageEmbeds
@Nonnull @CheckReturnValue default MessageAction editMessageEmbeds(@Nonnull MessageEmbed... embeds)
Edits this Message's content to the providedMessageEmbeds.
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
If the message has already been deleted. This might also be triggered for ephemeral messages.
- Parameters:
embeds- the new embeds of the Message (up to 10)- Returns:
MessageAction
TheMessagewith the updated content- Throws:
java.lang.UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTjava.lang.IllegalStateException- If the message attempting to be edited was not created by the currently logged in accountjava.lang.IllegalArgumentException- if any of the passed-in embeds isnullor notsendable.
-
editMessageComponents
@Nonnull @CheckReturnValue MessageAction editMessageComponents(@Nonnull java.util.Collection<? extends ComponentLayout> components)
Edits this Message's content to the providedComponentLayouts.
Messages can only be edited by the account that sent them!.
This will replace all the currentComponents, such asButtonsorSelectionMenuson this message. The provided parameters areComponentLayoutsuch asActionRowwhich contain a list of components to arrange in the respective layout.This message instance will not be updated by this operation, please use the response message instead.
The following
ErrorResponsesare possible:INVALID_AUTHOR_EDIT
Attempted to edit a message that was not sent by the currently logged in account. Discord does not allow editing of other users' Messages!MISSING_ACCESS
The request was attempted after the account lost access to theGuildtypically due to being kicked or removed, or afterPermission.MESSAGE_READwas revoked in theTextChannelUNKNOWN_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.
Example
List<ActionRow> rows = Arrays.asList( ActionRow.of(Button.success("prompt:accept", "Accept"), Button.danger("prompt:reject", "Reject")), // 1st row below message ActionRow.of(Button.link(url, "Help")) // 2nd row below message ); message.editMessageComponents(rows).queue();- Parameters:
components- Up to 5 newComponentLayoutsfor the edited message, such asActionRow- Returns:
MessageAction
TheMessagewith the updated components- Throws:
java.lang.UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTor any of the component layouts is a custom implementation that is not supported by this interfacejava.lang.IllegalArgumentException- If null is provided, or more than 5 layouts are addedjava.lang.IllegalStateException- If the message attempting to be edited was not created by the currently logged in account
-
editMessageComponents
@Nonnull @CheckReturnValue default MessageAction editMessageComponents(@Nonnull ComponentLayout... components)
Edits this Message's content to the providedComponentLayouts.
Messages can only be edited by the account that sent them!.
This will replace all the currentComponents, such asButtonsorSelectionMenuson this message. The provided parameters areComponentLayoutsuch asActionRowwhich contain a list of components to arrange in the respective layout.This message instance will not be updated by this operation, please use the response message instead.
The following
ErrorResponsesare possible:INVALID_AUTHOR_EDIT
Attempted to edit a message that was not sent by the currently logged in account. Discord does not allow editing of other users' Messages!MISSING_ACCESS
The request was attempted after the account lost access to theGuildtypically due to being kicked or removed, or afterPermission.MESSAGE_READwas revoked in theTextChannelUNKNOWN_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.
Example
message.editMessageComponents( ActionRow.of(Button.success("prompt:accept", "Accept"), Button.danger("prompt:reject", "Reject")), // 1st row below message ActionRow.of(Button.link(url, "Help")) // 2nd row below message ).queue();- Parameters:
components- Up to 5 newComponentLayoutsfor the edited message, such asActionRow- Returns:
MessageAction
TheMessagewith the updated components- Throws:
java.lang.UnsupportedOperationException- If this is not a Received Message fromMessageType.DEFAULTor any of the component layouts is a custom implementation that is not supported by this interfacejava.lang.IllegalArgumentException- If null is provided, or more than 5 layouts are addedjava.lang.IllegalStateException- If the message attempting to be edited was not created by the currently logged in account
-
editMessageFormat
@Nonnull @CheckReturnValue MessageAction editMessageFormat(@Nonnull java.lang.String format, @Nonnull java.lang.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
If the message has already been deleted. This might also be triggered for ephemeral messages.
- 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:
java.lang.UnsupportedOperationException- If this is a system messagejava.lang.IllegalArgumentException- If the provided format String isnullor blank, or if the created message exceeds the 2000 character limitjava.util.IllegalFormatException- 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.java.lang.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
If the message has already been deleted. This might also be triggered for ephemeral messages.
- Parameters:
newContent- the new content of the Message- Returns:
MessageAction
TheMessagewith the updated content- Throws:
java.lang.UnsupportedOperationException- If this is a system messagejava.lang.IllegalStateException-- If the message attempting to be edited was not created by the currently logged in account
- If the message contains a MessageEmbed that is not
sendable
-
reply
@Nonnull @CheckReturnValue default MessageAction reply(@Nonnull java.lang.CharSequence content)
Replies and references this message.
This is identical tomessage.getChannel().sendMessage(content).reference(message). You can usementionRepliedUser(false)to not mention the author of the message.
By default there won't be any error thrown if the referenced message does not exist. This behavior can be changed withMessageAction.failOnInvalidReply(boolean).For further info, see
MessageChannel.sendMessage(CharSequence)andMessageAction.reference(Message).- Parameters:
content- The content of the reply message- Returns:
MessageActionProviding theMessagecreated from this upload.- Since:
- 4.2.1
-
reply
@Nonnull @CheckReturnValue @Deprecated @ForRemoval(deadline="5.0.0") @ReplaceWith("replyEmbeds(content)") @DeprecatedSince("4.4.0") default MessageAction reply(@Nonnull MessageEmbed content)
Deprecated.UsereplyEmbeds(MessageEmbed, MessageEmbed...)insteadReplies and references this message.
This is identical tomessage.getChannel().sendMessage(content).reference(message). You can usementionRepliedUser(false)to not mention the author of the message.
By default there won't be any error thrown if the referenced message does not exist. This behavior can be changed withMessageAction.failOnInvalidReply(boolean).For further info, see
MessageChannel.sendMessageEmbeds(MessageEmbed, MessageEmbed...)andMessageAction.reference(Message).- Parameters:
content- The content of the reply message- Returns:
MessageActionProviding theMessagecreated from this upload.- Since:
- 4.2.1
-
replyEmbeds
@Nonnull @CheckReturnValue default MessageAction replyEmbeds(@Nonnull MessageEmbed embed, @Nonnull MessageEmbed... other)
Replies and references this message.
This is identical tomessage.getChannel().sendMessageEmbeds(embeds).reference(message). You can usementionRepliedUser(false)to not mention the author of the message.
By default there won't be any error thrown if the referenced message does not exist. This behavior can be changed withMessageAction.failOnInvalidReply(boolean).For further info, see
MessageChannel.sendMessageEmbeds(MessageEmbed, MessageEmbed...)andMessageAction.reference(Message).- Parameters:
embed- The embed to reply withother- Additional embeds to reply with- Returns:
MessageActionProviding theMessagecreated from this upload.- Throws:
java.lang.IllegalArgumentException- If null is provided, any of the embeds are notsendable, more than 10 embeds are provided, or the sum ofMessageEmbed.getLength()is greater thanMessageEmbed.EMBED_MAX_LENGTH_BOT
-
replyEmbeds
@Nonnull @CheckReturnValue default MessageAction replyEmbeds(@Nonnull java.util.Collection<? extends MessageEmbed> embeds)
Replies and references this message.
This is identical tomessage.getChannel().sendMessageEmbeds(embeds).reference(message). You can usementionRepliedUser(false)to not mention the author of the message.
By default there won't be any error thrown if the referenced message does not exist. This behavior can be changed withMessageAction.failOnInvalidReply(boolean).For further info, see
MessageChannel.sendMessageEmbeds(MessageEmbed, MessageEmbed...)andMessageAction.reference(Message).- Parameters:
embeds- The embeds to reply with- Returns:
MessageActionProviding theMessagecreated from this upload.- Throws:
java.lang.IllegalArgumentException- If null is provided, any of the embeds are notsendable, more than 10 embeds are provided, or the sum ofMessageEmbed.getLength()is greater thanMessageEmbed.EMBED_MAX_LENGTH_BOT
-
reply
@Nonnull @CheckReturnValue default MessageAction reply(@Nonnull Message content)
Replies and references this message.
This is identical tomessage.getChannel().sendMessage(content).reference(message). You can usementionRepliedUser(false)to not mention the author of the message.
By default there won't be any error thrown if the referenced message does not exist. This behavior can be changed withMessageAction.failOnInvalidReply(boolean).For further info, see
MessageChannel.sendMessage(Message)andMessageAction.reference(Message).- Parameters:
content- The content of the reply message- Returns:
MessageActionProviding theMessagecreated from this upload.- Since:
- 4.2.1
-
replyFormat
@Nonnull @CheckReturnValue default MessageAction replyFormat(@Nonnull java.lang.String format, @Nonnull java.lang.Object... args)
Replies and references this message.
This is identical tomessage.getChannel().sendMessageFormat(content, args).reference(message). You can usementionRepliedUser(false)to not mention the author of the message.
By default there won't be any error thrown if the referenced message does not exist. This behavior can be changed withMessageAction.failOnInvalidReply(boolean).For further info, see
MessageChannel.sendMessageFormat(String, Object...)andMessageAction.reference(Message).- Parameters:
format- The string that should be formatted, if this is null or empty the content of the Message would be empty and cause a builder exception.args- The arguments for your format- Returns:
MessageActionProviding theMessagecreated from this upload.- Since:
- 4.2.1
-
reply
@Nonnull @CheckReturnValue default MessageAction reply(@Nonnull java.io.File file, @Nonnull AttachmentOption... options)
Replies and references this message.
This is identical tomessage.getChannel().sendFile(file, options).reference(message). You can usementionRepliedUser(false)to not mention the author of the message.
By default there won't be any error thrown if the referenced message does not exist. This behavior can be changed withMessageAction.failOnInvalidReply(boolean).For further info, see
MessageChannel.sendFile(File, net.dv8tion.jda.api.utils.AttachmentOption...)andMessageAction.reference(Message).- Parameters:
file- The file to upload to the channel in the replyoptions- Possible options to apply to this attachment, such as marking it as spoiler image- Returns:
MessageActionProviding theMessagecreated from this upload.- Since:
- 4.2.1
-
reply
@Nonnull @CheckReturnValue default MessageAction reply(@Nonnull java.io.File data, @Nonnull java.lang.String name, @Nonnull AttachmentOption... options)
Replies and references this message.
This is identical tomessage.getChannel().sendFile(data, name, options).reference(message). You can usementionRepliedUser(false)to not mention the author of the message.
By default there won't be any error thrown if the referenced message does not exist. This behavior can be changed withMessageAction.failOnInvalidReply(boolean).For further info, see
MessageChannel.sendFile(File, String, net.dv8tion.jda.api.utils.AttachmentOption...)andMessageAction.reference(Message).- Parameters:
data- The data to upload to the channel in the replyname- The name that should be sent to discordoptions- Possible options to apply to this attachment, such as marking it as spoiler image- Returns:
MessageActionProviding theMessagecreated from this upload.- Since:
- 4.2.1
-
reply
@Nonnull @CheckReturnValue default MessageAction reply(@Nonnull java.io.InputStream data, @Nonnull java.lang.String name, @Nonnull AttachmentOption... options)
Replies and references this message.
This is identical tomessage.getChannel().sendFile(data, name, options).reference(message). You can usementionRepliedUser(false)to not mention the author of the message.
By default there won't be any error thrown if the referenced message does not exist. This behavior can be changed withMessageAction.failOnInvalidReply(boolean).For further info, see
MessageChannel.sendFile(InputStream, String, net.dv8tion.jda.api.utils.AttachmentOption...)andMessageAction.reference(Message).- Parameters:
data- The data to upload to the channel in the replyname- The name that should be sent to discordoptions- Possible options to apply to this attachment, such as marking it as spoiler image- Returns:
MessageActionProviding theMessagecreated from this upload.- Since:
- 4.2.1
-
reply
@Nonnull @CheckReturnValue default MessageAction reply(@Nonnull byte[] data, @Nonnull java.lang.String name, @Nonnull AttachmentOption... options)
Replies and references this message.
This is identical tomessage.getChannel().sendFile(data, name, options).reference(message). You can usementionRepliedUser(false)to not mention the author of the message.
By default there won't be any error thrown if the referenced message does not exist. This behavior can be changed withMessageAction.failOnInvalidReply(boolean).For further info, see
MessageChannel.sendFile(byte[], String, net.dv8tion.jda.api.utils.AttachmentOption...)andMessageAction.reference(Message).- Parameters:
data- The data to upload to the channel in the replyname- The name that should be sent to discordoptions- Possible options to apply to this attachment, such as marking it as spoiler image- Returns:
MessageActionProviding theMessagecreated from this upload.- Since:
- 4.2.1
-
delete
@Nonnull @CheckReturnValue AuditableRestAction<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 aTextChanneland the current account hasPermission.MESSAGE_MANAGEin the channel.To delete many messages at once in a
MessageChannelyou should useMessageChannel.purgeMessages(List)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_MESSAGE
If the message has already been deleted. This might also be triggered for ephemeral messages.
- Returns:
AuditableRestAction- Throws:
java.lang.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.java.lang.IllegalStateException-- If this Message was not sent by the currently logged in account and it was not sent in a
TextChannel. - If this Message is ephemeral
- If this Message was not sent by the currently logged in account and it was not sent in a
- See Also:
TextChannel.deleteMessages(Collection),MessageChannel.purgeMessages(List)
-
getJDA
@Nonnull JDA getJDA()
Returns theJDAinstance related to this Message.- Returns:
- the corresponding JDA instance
- Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
isPinned
boolean isPinned()
Whether or not this Message has been pinned in its parent channel.- Returns:
- True - if this message has been pinned.
- Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
pin
@Nonnull @CheckReturnValue RestAction<java.lang.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_MESSAGE
If the message has already been deleted. This might also be triggered for ephemeral messages.
- Returns:
RestAction- Type:Void- Throws:
java.lang.UnsupportedOperationException- If this is a system messageInsufficientPermissionException- 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
java.lang.IllegalStateException- If this Message is ephemeral
-
unpin
@Nonnull @CheckReturnValue RestAction<java.lang.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_MESSAGE
If the message has already been deleted. This might also be triggered for ephemeral messages.
- Returns:
RestAction- Type:Void- Throws:
java.lang.UnsupportedOperationException- If this is a system messageInsufficientPermissionException- 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
java.lang.IllegalStateException- If this Message is ephemeral
-
addReaction
@Nonnull @CheckReturnValue RestAction<java.lang.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 the 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
Also can happen if the account lost thePermission.MESSAGE_HISTORYREACTION_BLOCKED
The user has blocked the currently logged in account and the reaction failedTOO_MANY_REACTIONS
The message already has too many reactions to proceedMISSING_PERMISSIONS
The reaction request was attempted after the account lostPermission.MESSAGE_ADD_REACTIONorPermission.MESSAGE_HISTORYin theTextChannelwhen adding the reaction.UNKNOWN_EMOJI
The provided emote 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.
- Parameters:
emote- TheEmoteto add as a reaction to this Message.- Returns:
RestAction- Type:Void- Throws:
java.lang.UnsupportedOperationException- If this is a system messageInsufficientPermissionException- If the MessageChannel this message was sent in was aTextChanneland the logged in account does not havejava.lang.IllegalArgumentException-- If the provided
Emoteis null. - If the provided
Emotecannot be used in the current channel. SeeEmote.canInteract(User, MessageChannel)orEmote.canInteract(Member)for more information.
- If the provided
java.lang.IllegalStateException- If this message is ephemeral
-
addReaction
@Nonnull @CheckReturnValue RestAction<java.lang.Void> addReaction(@Nonnull java.lang.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 the 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
Also can happen if the account lost thePermission.MESSAGE_HISTORYREACTION_BLOCKED
The user has blocked the currently logged in account and the reaction failedTOO_MANY_REACTIONS
The message already has too many reactions to proceedMISSING_PERMISSIONS
The reaction request was attempted after the account lostPermission.MESSAGE_ADD_REACTIONin theTextChannelwhen adding the reaction.UNKNOWN_EMOJI
The provided unicode character does not refer to a known emoji unicode character.
Proper unicode characters for emojis can be found here: Emoji TableUNKNOWN_MESSAGE
If the message has already been deleted. This might also be triggered for ephemeral messages.
- Parameters:
unicode- The unicode emoji to add as a reaction to this Message.- Returns:
RestAction- Type:Void- Throws:
java.lang.UnsupportedOperationException- If this is a system messageInsufficientPermissionException- If the MessageChannel this message was sent in was aTextChanneland the logged in account does not havejava.lang.IllegalArgumentException- If the provided unicode emoji is null or empty.java.lang.IllegalStateException- If this Message is ephemeral
-
clearReactions
@Nonnull @CheckReturnValue 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.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
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_MESSAGE
If the message has already been deleted. This might also be triggered for ephemeral messages.
- Returns:
RestAction- Type:Void- Throws:
java.lang.UnsupportedOperationException- If this is a system messageInsufficientPermissionException- If the MessageChannel this message was sent in was aTextChanneland the currently logged in account does not havePermission.MESSAGE_MANAGEin the channel.java.lang.IllegalStateException-- If this message was not sent in a
Guild. - If this message is ephemeral
- If this message was not sent in a
-
clearReactions
@Nonnull @CheckReturnValue RestAction<java.lang.Void> clearReactions(@Nonnull java.lang.String unicode)
Removes all reactions for the specified emoji.Please note that you can't clear reactions if this message was sent in a
PrivateChannel!Example
// custom message.clearReactions("minn:245267426227388416").queue(); // unicode escape message.clearReactions("\uD83D\uDE02").queue(); // codepoint notation message.clearReactions("U+1F602").queue();The following
ErrorResponsesare possible:MISSING_ACCESS
The currently logged in account lost access to the channel by either being removed from the guild or losing theVIEW_CHANNELpermissionUNKNOWN_EMOJI
The provided unicode character does not refer to a known emoji unicode character.
Proper unicode characters for emojis can be found here: Emoji TableUNKNOWN_MESSAGE
If the message has already been deleted. This might also be triggered for ephemeral messages.
- Parameters:
unicode- The unicode emoji to remove reactions for- Returns:
RestAction- Throws:
java.lang.UnsupportedOperationException- If this is a system messageInsufficientPermissionException- If the currently logged in account does not havePermission.MESSAGE_MANAGEin the channeljava.lang.IllegalArgumentException- If provided with nulljava.lang.IllegalStateException-- If this message was not sent in a
Guild. - If this message is ephemeral
- If this message was not sent in a
- Since:
- 4.2.0
-
clearReactions
@Nonnull @CheckReturnValue RestAction<java.lang.Void> clearReactions(@Nonnull Emote emote)
Removes all reactions for the specified emote.Please note that you can't clear reactions if this message was sent in a
PrivateChannel!The following
ErrorResponsesare possible:MISSING_ACCESS
The currently logged in account lost access to the channel by either being removed from the guild or losing theVIEW_CHANNELpermissionUNKNOWN_EMOJI
The provided emote 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.
- Parameters:
emote- TheEmoteto remove reactions for- Returns:
RestAction- Throws:
java.lang.UnsupportedOperationException- If this is a system messageInsufficientPermissionException- If the currently logged in account does not havePermission.MESSAGE_MANAGEin the channeljava.lang.IllegalArgumentException- If provided with nulljava.lang.IllegalStateException-- If this message was not sent in a
Guild. - If this message is ephemeral
- If this message was not sent in a
- Since:
- 4.2.0
-
removeReaction
@Nonnull @CheckReturnValue RestAction<java.lang.Void> removeReaction(@Nonnull Emote emote)
Removes a reaction from 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 the 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
Also can happen if the account lost thePermission.MESSAGE_HISTORYUNKNOWN_EMOJI
The provided emote 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.
- Parameters:
emote- TheEmoteto remove as a reaction from this Message.- Returns:
RestAction- Type:Void- Throws:
java.lang.UnsupportedOperationException- If this is a system messageInsufficientPermissionException- If the MessageChannel this message was sent in was aTextChanneland the logged in account does not havePermission.MESSAGE_HISTORYjava.lang.IllegalArgumentException-- If the provided
Emoteis null. - If the provided
Emotecannot be used in the current channel. SeeEmote.canInteract(User, MessageChannel)orEmote.canInteract(Member)for more information.
- If the provided
java.lang.IllegalStateException- If this is an ephemeral message- Since:
- 4.1.0
-
removeReaction
@Nonnull @CheckReturnValue RestAction<java.lang.Void> removeReaction(@Nonnull Emote emote, @Nonnull User user)
Removes aUser'sreaction from this Message using anEmote.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 emoji/emotes below a message that have a counter beside them showing how many users have reacted with the 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
Also can happen if the account lost thePermission.MESSAGE_HISTORYMISSING_PERMISSIONS
The reaction request was attempted after the account lostPermission.MESSAGE_MANAGEin theTextChannelwhen removing the reaction.UNKNOWN_EMOJI
The provided emote 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.
- Parameters:
emote- TheEmoteto remove as a reaction from this Message.user- TheUserto remove the reaction for.- Returns:
RestAction- Type:Void- Throws:
java.lang.UnsupportedOperationException- If this is a system messageInsufficientPermissionException- If the MessageChannel this message was sent in was aTextChanneland the logged in account does not havePermission.MESSAGE_HISTORY.java.lang.IllegalArgumentException-- If the provided
Emoteis null. - If the provided
Emotecannot be used in the current channel. SeeEmote.canInteract(User, MessageChannel)orEmote.canInteract(Member)for more information. - If the provided user is null
- If the provided
java.lang.IllegalStateException-- Since:
- 4.1.0
-
removeReaction
@Nonnull @CheckReturnValue RestAction<java.lang.Void> removeReaction(@Nonnull java.lang.String unicode)
Removes a reaction from 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 the same emoji/unicode.
Neither success nor failure of this request will affect this Message's
getReactions()return as Message is immutable.Examples
// custom
message.removeReaction("minn:245267426227388416").queue();
// unicode escape
message.removeReaction("\uD83D\uDE02").queue();
// codepoint notation
message.removeReaction("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
Also can happen if the account lost thePermission.MESSAGE_HISTORYUNKNOWN_EMOJI
The provided unicode character does not refer to a known emoji unicode character.
Proper unicode characters for emojis can be found here: Emoji TableUNKNOWN_MESSAGE
If the message has already been deleted. This might also be triggered for ephemeral messages.
- Parameters:
unicode- The unicode emoji to add as a reaction to this Message.- Returns:
RestAction- Type:Void- Throws:
java.lang.UnsupportedOperationException- If this is a system messageInsufficientPermissionException- If the MessageChannel this message was sent in was aTextChanneland the logged in account does not havePermission.MESSAGE_HISTORYjava.lang.IllegalArgumentException- If the provided unicode emoji is null or empty.java.lang.IllegalStateException- If this is an ephemeral message- Since:
- 4.1.0
-
removeReaction
@Nonnull @CheckReturnValue RestAction<java.lang.Void> removeReaction(@Nonnull java.lang.String unicode, @Nonnull User user)
Removes a reaction from this Message using a unicode emoji.
A reference of unicode emojis can be found here: Emoji Table.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 emoji/emotes below a message that have a counter beside them showing how many users have reacted with the same emoji/unicode.
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 reaction request was attempted after the account lost access to theTextChanneldue toPermission.MESSAGE_READbeing revoked
Also can happen if the account lost thePermission.MESSAGE_HISTORYUNKNOWN_EMOJI
The provided unicode character does not refer to a known emoji unicode character.
Proper unicode characters for emojis can be found here: Emoji TableMISSING_PERMISSIONS
The reaction request was attempted after the account lostPermission.MESSAGE_MANAGEin theTextChannelwhen removing the reaction.UNKNOWN_MESSAGE
If the message has already been deleted. This might also be triggered for ephemeral messages.
- Parameters:
unicode- The unicode emoji to add as a reaction to this Message.user- TheUserto remove the reaction for.- Returns:
RestAction- Type:Void- Throws:
java.lang.UnsupportedOperationException- If this is a system messageInsufficientPermissionException- If the MessageChannel this message was sent in was aTextChanneland the logged in account does not havejava.lang.IllegalArgumentException- If the provided unicode emoji is null or empty or if the provided user is null.java.lang.IllegalStateException- If this message:- Since:
- 4.1.0
-
retrieveReactionUsers
@Nonnull @CheckReturnValue ReactionPaginationAction retrieveReactionUsers(@Nonnull Emote emote)
This obtains theuserswho reacted using the givenemote.Messages maintain a list of reactions, alongside a list of users who added them.
Using this data, we can obtain a
ReactionPaginationActionof the users who've reacted to this message.The following
ErrorResponsesare possible:MISSING_ACCESS
The retrieve request was attempted after the account lost access to theTextChanneldue toPermission.MESSAGE_READbeing revoked
Also can happen if the account lost thePermission.MESSAGE_HISTORYUNKNOWN_EMOJI
The provided emote 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.
- Parameters:
emote- Theemoteto retrieve users for.- Returns:
- The
ReactionPaginationActionof the emote's users. - Throws:
java.lang.UnsupportedOperationException- If this is a system messageInsufficientPermissionException- If the MessageChannel this message was sent in was aTextChanneland the logged in account does not havePermission.MESSAGE_HISTORYin the channel.java.lang.IllegalArgumentException- If the providedEmoteis null.java.lang.IllegalStateException- If this Message is ephemeral- Since:
- 4.1.0
-
retrieveReactionUsers
@Nonnull @CheckReturnValue ReactionPaginationAction retrieveReactionUsers(@Nonnull java.lang.String unicode)
This obtains theuserswho reacted using the given unicode emoji.Messages maintain a list of reactions, alongside a list of users who added them.
Using this data, we can obtain a
ReactionPaginationActionof the users who've reacted to this message.The following
ErrorResponsesare possible:MISSING_ACCESS
The retrieve request was attempted after the account lost access to theTextChanneldue toPermission.MESSAGE_READbeing revoked
Also can happen if the account lost thePermission.MESSAGE_HISTORYUNKNOWN_EMOJI
The provided unicode character does not refer to a known emoji unicode character.
Proper unicode characters for emojis can be found here: Emoji TableUNKNOWN_MESSAGE
If the message has already been deleted. This might also be triggered for ephemeral messages.
- Parameters:
unicode- The unicode emote to retrieve users for.- Returns:
- The
ReactionPaginationActionof the emoji's users. - Throws:
java.lang.UnsupportedOperationException- If this is a system messageInsufficientPermissionException- If the MessageChannel this message was sent in was aTextChanneland the logged in account does not havePermission.MESSAGE_HISTORYin the channel.java.lang.IllegalArgumentException- If the provided unicode emoji is null or empty.java.lang.IllegalStateException- If this Message is ephemeral- Since:
- 4.1.0
-
getReactionByUnicode
@Nullable @CheckReturnValue MessageReaction.ReactionEmote getReactionByUnicode(@Nonnull java.lang.String unicode)
This obtains theReactionEmotefor the given unicode reaction on this message.Messages also store reactions using unicode values.
An instance of the related
ReactionEmotecan be obtained through this method by using the emoji's unicode value.- Parameters:
unicode- The unicode value of the reaction emoji.- Returns:
- The
ReactionEmoteof this message or null if not present. - Throws:
java.lang.UnsupportedOperationException- If this is a system messagejava.lang.IllegalArgumentException- If the provided unicode value is null or empty.- Since:
- 4.1.0
-
getReactionById
@Nullable @CheckReturnValue MessageReaction.ReactionEmote getReactionById(@Nonnull java.lang.String id)
This obtains theReactionEmotefor the given reaction id on this message.Messages store reactions by keeping a list of reaction names.
An instance of the related
ReactionEmotecan be obtained through this method by using the emote's id.- Parameters:
id- The string id of the reaction emote.- Returns:
- The
ReactionEmoteof this message or null if not present. - Throws:
java.lang.UnsupportedOperationException- If this is a system messagejava.lang.IllegalArgumentException- If the provided id is not a valid snowflake.- Since:
- 4.1.0
-
getReactionById
@Nullable @CheckReturnValue MessageReaction.ReactionEmote getReactionById(long id)
This obtains theReactionEmotefor the given reaction id on this message.Messages store reactions by keeping a list of reaction names.
An instance of the related
ReactionEmotecan be obtained through this method by using the emote's id.- Parameters:
id- The long id of the reaction emote.- Returns:
- The
ReactionEmoteof this message or null if not present. - Throws:
java.lang.UnsupportedOperationException- If this is a system message- Since:
- 4.1.0
-
suppressEmbeds
@Nonnull @CheckReturnValue AuditableRestAction<java.lang.Void> suppressEmbeds(boolean suppressed)
Enables/Disables suppression of Embeds on this Message.
Suppressing Embeds is equivalent to pressing theXin the top-right corner of an Embed inside the Discord client.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 suppress-embeds request was attempted after the account lostPermission.MESSAGE_MANAGEin theTextChannelwhen adding the reaction.UNKNOWN_MESSAGE
If the message has already been deleted. This might also be triggered for ephemeral messages.
- Parameters:
suppressed- Whether or not the embed should be suppressed- Returns:
AuditableRestAction- Type:Void- Throws:
java.lang.UnsupportedOperationException- If this is a system messageInsufficientPermissionException- If the MessageChannel this message was sent in was aTextChanneland the currently logged in account does not havePermission.MESSAGE_MANAGEin the channel.PermissionException- If the MessageChannel this message was sent in was aPrivateChanneland the message was not sent by the currently logged in account.java.lang.IllegalStateException- If this Message is ephemeral- See Also:
isSuppressedEmbeds()
-
crosspost
@Nonnull @CheckReturnValue RestAction<Message> crosspost()
Attempts to crosspost this message.The following
ErrorResponsesare possible:ALREADY_CROSSPOSTED
The target message has already been crossposted.MISSING_ACCESS
The request was attempted after the account lost access to theGuildtypically due to being kicked or removed, or afterPermission.MESSAGE_READwas revoked in theTextChannelMISSING_PERMISSIONS
The request was attempted after the account lostPermission.MESSAGE_MANAGEin the TextChannel.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.
- Returns:
RestAction- Type:Message- Throws:
java.lang.UnsupportedOperationException- If this is a system messagejava.lang.IllegalStateException-- If the channel is not a text or news channel. See
TextChannel.isNews(). - If the message is ephemeral.
- If the channel is not a text or news channel. See
InsufficientPermissionException- If the currently logged in account does not havePermission.VIEW_CHANNELin this channel or if this message is from another user and we don't havePermission.MESSAGE_MANAGE.- Since:
- 4.2.1
-
isSuppressedEmbeds
boolean isSuppressedEmbeds()
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 ifgetFlags()containsMessageFlag#EMBEDS_SUPPRESSED- Returns:
- Whether or not Embeds are suppressed for this Message.
- Throws:
java.lang.UnsupportedOperationException- If this is a system message- See Also:
suppressEmbeds(boolean)
-
getFlags
@Nonnull java.util.EnumSet<Message.MessageFlag> getFlags()
Returns an EnumSet of allMessageFlagspresent for this Message.- Returns:
- Never-Null EnumSet of present
MessageFlags - Throws:
java.lang.UnsupportedOperationException- If this is a system message- See Also:
Message.MessageFlag
-
getFlagsRaw
long getFlagsRaw()
Returns the raw message flags of this message- Returns:
- The raw message flags
- Throws:
java.lang.UnsupportedOperationException- If this is a system message- See Also:
getFlags()
-
isEphemeral
boolean isEphemeral()
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 ifgetFlags()containsMessage.MessageFlag.EPHEMERAL- Returns:
- Whether the message is ephemeral
- Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
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. - Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
getInteraction
@Nullable Message.Interaction getInteraction()
This is sent on the message object when the message is a response to anInteractionwithout 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.
- Returns:
- The
Interactionof this message. - Throws:
java.lang.UnsupportedOperationException- If this is a system message
-
-