Message

type

A sent message: content, author, embeds, reactions and mentions.

37 syntaxesnet.dv8tion.jda.api.entities.Message

37 / 37

Properties

propertyTextsince 5.0.0-a1

[the] discord content of %message%

%message%'s discord content

Get the raw (non formatted) content of a sent message.

mentioned inManaging messages

Helpful?

propertyUsersince 5.0.0-a1

[the] discord author of %message%

%message%'s discord author

Get the user instance of the message's author. Can be null in case of the message was sent by a webhook.

mentioned inManaging messages

Helpful?

propertyMembersince 5.0.0-a1

[the] member author of %message%

%message%'s member author

Get the member instance of the message's author. Can be null if it's in PM or not in guild!

mentioned inManaging messages

Helpful?

propertyMessagesince 5.0.0-a1

[the] referenced message of %message%

%message%'s referenced message

Get the message referenced (replied to) by a specific message, if any.

mentioned inManaging messages

Helpful?

propertyMessagepollsince 5.0.0-a1

Feeling lost? This is covered in the guide Polls

[the] poll of %message%

%message%'s poll

Get the poll attached to a specific message, if any.

mentioned inManaging messages

Helpful?

propertylist of MessageEmbedsince 5.0.0-a1

[the] embeds of %message%

%message%'s embeds

Get every embed of a specific message, in display order (10 at most).

mentioned inEmbeds Managing messages

Helpful?

propertylist of Attachmentsince 5.0.0-a1

Feeling lost? This is covered in the guide File uploads

[the] discord attachments of %message%

%message%'s discord attachments

Get every attachment as custom object of a message.

mentioned inManaging messages

Helpful?

propertylist of MessageReactionsince 5.0.0-a1

Feeling lost? This is covered in the guide Reactions

[the] reactions of %message%

%message%'s reactions

Get every reaction of a message.

Because of Discord's limitation, we cannot get which user reacted with which reaction, you'll have to count them yourself.

mentioned inManaging messages

Helpful?

propertylist of Usersince 5.0.0-a1

[the] mentioned users of %message%

%message%'s mentioned users

Get every mentioned user in a message.

mentioned inManaging messages

Helpful?

propertylist of Membersince 5.0.0-a1

[the] mentioned members of %message%

%message%'s mentioned members

Get every mentioned member in a message. If the message doesn't come from a guild it will return an empty list!

mentioned inManaging messages

Helpful?

propertylist of Rolesince 5.0.0-a1

[the] mentioned roles of %message%

%message%'s mentioned roles

Get every mentioned role in a message. If the message doesn't come from a guild it will return an empty list!

mentioned inManaging messages

Helpful?

propertylist of Textchannelsince 5.0.0-a1

[the] mentioned channels of %message%

%message%'s mentioned channels

Get every mentioned text channel in a message.

mentioned inManaging messages

Helpful?

propertylist of Voicechannelsince 5.0.0-a1

[the] mentioned voice channels of %message%

%message%'s mentioned voice channels

Get every mentioned voice channel in a message.

mentioned inManaging messages

Helpful?

propertylist of Emotesince 5.0.0-a1

[the] mentioned emotes of %message%

%message%'s mentioned emotes

Get every mentioned emote in a message.

This will only return custom emotes, and will therefore not include discord (unicode) emotes.

mentioned inManaging messages

Helpful?

propertylist of Componentsince 5.0.0-a1

[the] discord components of %message%

%message%'s discord components

Every component of a sent message, rows and containers flattened: the buttons, dropdowns, text displays and so on it carries.

These are the sent components, not builders; use 'replace component' to change one.

mentioned inManaging messages

Helpful?

propertyText since 5.0.0-a1

[the] jump url of %message%

%message%'s jump url

The jump-to URL of a message or a guild channel. Clicking it in the Discord client jumps straight to the message/channel. Co-owned across both types, so "jump url of %message/channel%" works on either.

mentioned inManaging messages

Helpful?

propertyGuild since 5.0.0-a1

[the] guild of %message%

%message%'s guild

The guild a Discord entity belongs to: a member's, message's, role's, channel's, webhook's, sticker's, emoji's or scheduled event's guild. Co-owned across every such type, so "guild of %x%" works on any of them (null when the entity is not tied to a guild, e.g. a message from DMs).

mentioned inManaging messages

Helpful?

Getters

getterMessage since 5.0.0-a1

Feeling lost? This is covered in the guide Getting entities by id

message with id %string% (in|from) [the] [text] [channel] %messagechannel%

The message with the given id in a channel (requires await).

mentioned inCache and await Managing messages

Helpful?

Effects

effect since 5.0.0-a1

Feeling lost? This is covered in the guide Managing messages

edit [the] [message] %message% (with|to show) %string/embedbuilder/component%

Replaces a message's content or embeds. Only the bot's own messages can be edited.

A text replaces the content, an embed replaces the embeds.

Helpful?

effect since 5.0.0-a1

Feeling lost? This is covered in the guide Polls

end [the] poll of [the] [message] %message% [now]

Ends the poll attached to a message immediately, preventing any further vote.

mentioned inManaging messages

Helpful?

effect since 5.0.0-a1

Feeling lost? This is covered in the guide Managing messages

forward [the] [message] %message% to [the] [channel] %messagechannel%

Forwards a message to another channel, creating a copy carrying the 'forwarded' marker.

Helpful?

effect since 5.0.0-a1

Feeling lost? This is covered in the guide Managing messages

pin [the] [message] %message%

Pins a message in its channel. A channel holds up to 50 pinned messages.

Helpful?

effect since 5.0.0-a1

[discord] (publish|crosspost) [the] [message] %message%

Publishes (crossposts) a message to every guild following its channel.

Only works in a news/announcement channel.

mentioned inManaging messages

Helpful?

effectsince 5.0.0-a1

Feeling lost? This is covered in the guide Managing messages

purge [the] [message[s]] %messages%

Deletes several messages at once, using Discord's bulk-delete endpoint.

Messages are grouped per channel; a channel with a single message falls back to a plain delete.

To delete one message, use the destroy effect instead.

Helpful?

effect since 5.0.0-a1

Feeling lost? This is covered in the guide Reactions

react to [the] [message] %message% with [the] %emojis/strings%

Adds one or more reactions to a message, as the bot.

An emoji or emote object reacts with that emoji; a text is either a unicode emoji or the formatted '<:name:id>' form of a custom one.

Helpful?

effect since 5.0.0-a1

(suppress|hide) [the] [discord] [link] embed[s] [message] (of|from) [the] [discord] [message] %message%

Hides the link embeds Discord generated for a message.

mentioned inManaging messages

Helpful?

effect since 5.0.0-a1

unpin [the] [message] %message%

Removes a message from its channel's pins.

mentioned inManaging messages

Helpful?

Conditions

conditionsince 5.0.0-a1

%messages% (is|are) using components v2

Whether the message is a components V2 message (containers, sections, text displays...).

mentioned inManaging messages

Helpful?

conditionsince 5.0.0-a1

%messages% (is|are) edited

Whether the message has been edited.

mentioned inManaging messages

Helpful?

conditionsince 5.0.0-a1

%messages% (is|are) pinned

Whether the message is pinned in its channel.

mentioned inManaging messages

Helpful?

conditionsince 5.0.0-a1

%messages% (is|are) ephemeral

Whether the message is ephemeral (only visible to one user).

mentioned inManaging messages

Helpful?

conditionsince 5.0.0-a1

%messages% (is|are) tts

Whether the message was sent using text-to-speech.

mentioned inManaging messages

Helpful?

conditionsince 5.0.0-a1

%messages% (is|are) from [a] guild

Whether the message was sent in a guild channel (rather than a private/DM channel).

mentioned inManaging messages

Helpful?

conditionsince 5.0.0-a1

%messages% (is|are) from [a] (dm|private message|direct message)

Whether the message was sent in a private (direct message) channel rather than in a guild.

mentioned inManaging messages

Helpful?

conditionsince 5.0.0-a1

%messages% (is|are) [a] voice message

Whether the message is a voice message. If it is, the 'attachment duration' expression can be used on its attachment.

mentioned inManaging messages

Helpful?

conditionsince 5.0.0-a1

%messages% (is|are) forwarded

Whether the message is a forwarded message, that is, a message originally sent in another channel and forwarded to this one.

mentioned inManaging messages

Helpful?

conditionsince 5.0.0-a1

%messages% (has|have) [a] poll

Whether the message has a poll attached to it.

mentioned inManaging messages Polls

Helpful?

Returned by

Syntaxes elsewhere in DiSky that return Message.

[the] last %number% [discord] messages (of|in|from) [the] [channel] %messagechannel%Core · Expressions message with id %string% (in|from) [the] [text] [channel] %messagechannel%Message [the] referenced message of %message%Message [the] referenced message of %messageaction%Message Builder [the] (build|built) result of [the] %messageaction%Message Builder [the] pinned messages of %messagechannel%Message Channel [the] start message of %threadchannel%Thread Channel [the] (build|built) result of [the] %webhookmessageaction%Webhook Message Builder

Documentation

Hand-written guides that cover Message.

Cache and awaitWhat the cache holds, the three rules that decide when a line needs await, and the reads that always do.Docs Getting entities by idLook a guild, role, user, member, channel or message up from its Discord id, from the cache or from Discord.Docs EmbedsBuild a Discord embed locally, set every property and its fields, then send it with post, reply with or a message builder.Docs File uploadsBuild a file from a local path, a url or a received attachment, attach it to a message, and read attachments back.Docs Managing messagesEdit, pin, publish, forward, purge and destroy a message you hold, and read everything it carries.Docs ReactionsReact to a message, remove a reaction, and read the reactions Discord tracks on it.Docs PollsRead a poll attached to a message, list its voters, end it early, and react when someone votes.Docs