Message Builder

type

A message that has not been sent yet: configure it, then send it with 'the build result of'. Nothing reaches Discord until then, so setting its properties costs no request, and the result is the sent message itself.

15 syntaxesnet.dv8tion.jda.api.requests.restaction.MessageCreateAction

15 / 15

Properties

propertyText since 5.0.0-a1

[the] discord content of %messageaction%

%messageaction%'s discord content

The raw text of the message being built. Setting it replaces whatever content the builder already carries.

change modes set

mentioned inSending messages

Helpful?

propertyEmbedbuilder since 5.0.0-a1

[the] embed of %messageaction%

%messageaction%'s embed

The embed of the message being built. Setting it replaces every embed the builder already carries.

change modes set

mentioned inSending messages

Helpful?

propertylist of Embedbuilder since 5.0.0-b1

[the] embeds of %messageaction%

%messageaction%'s embeds

Every embed of the message being built, in display order (10 at most, Discord's limit).

Setting it replaces the embeds the builder already carries, adding appends to them and deleting removes them all. Each embed is snapshotted when it is set or added: editing it afterwards changes nothing. Embeds have no id, so removing a single one is not supported: set the list again.

The list cannot be read back from a builder; read 'embeds of' the sent message instead.

change modes setadddelete

Helpful?

propertyPoll Builder since 5.0.0-a2

Feeling lost? This is covered in the guide Creating polls

[the] attached poll of %messageaction%

%messageaction%'s attached poll

The poll of the message being built (a message carries one poll at most; setting it replaces the previous one). The poll is validated and snapshotted when set.

A poll cannot be combined with components V2 (containers, sections, text displays...).

change modes set

mentioned inSending messages

Helpful?

propertyBoolean since 5.0.0-a1

[the] tts of %messageaction%

%messageaction%'s tts

Whether the message being built is read out loud by Discord's text-to-speech.

change modes set

mentioned inSending messages

Helpful?

propertyBoolean since 5.0.0-a1

[the] suppressed embeds of %messageaction%

%messageaction%'s suppressed embeds

Whether Discord hides the embeds of the message being built, including the previews it generates from links.

change modes set

mentioned inSending messages

Helpful?

propertyBoolean since 5.0.0-a1

[the] suppressed notifications of %messageaction%

%messageaction%'s suppressed notifications

Whether the message being built is sent silently, without pinging anyone's device.

change modes set

mentioned inSending messages

Helpful?

propertyMessage since 5.0.0-a1

[the] referenced message of %messageaction%

%messageaction%'s referenced message

The message the one being built replies to.

change modes set

mentioned inSending messages

Helpful?

propertyBoolean since 5.0.0-a1

[the] mention replied user of %messageaction%

%messageaction%'s mention replied user

Whether replying pings the author of the referenced message. Has no effect unless a referenced message is set.

change modes set

mentioned inSending messages

Helpful?

propertyBoolean since 5.0.0-a1

[the] fail on invalid reply of %messageaction%

%messageaction%'s fail on invalid reply

Whether sending fails when the referenced message no longer exists. When false, the message is sent as a normal one instead.

change modes set

mentioned inSending messages

Helpful?

propertylist of Textsince 5.0.0-a1

Feeling lost? This is covered in the guide File uploads

[the] attachments of %messageaction%

%messageaction%'s attachments

The files attached to the message being built, read back as their names.

Add file uploads to it (see 'a new file upload'); remove one by its name.

change modes setaddremovedelete

Helpful?

propertylist of Component

[the] components of %messageaction%

%messageaction%'s components

change modes setaddremovedelete

Helpful?

Expressions

expressionMessage Buildersince 5.0.0-a1

Feeling lost? This is covered in the guide Sending messages

[a] new message with [the] content %string% in [the] [channel] %messagechannel%

Creates a message builder from a piece of text. The message is only sent once you read 'the build result of' it, which requires 'await'.

Helpful?

expressionMessage Buildersince 5.0.0-a1

[a] new message with [the] embed %embedbuilder% in [the] [channel] %messagechannel%

Creates a message builder from an embed. The message is only sent once you read 'the build result of' it, which requires 'await'.

Helpful?

expressionMessage since 5.0.0-a1

Feeling lost? This is covered in the guide Sending messages

[the] (build|built) result of [the] %messageaction%

[the] built message [from] [the] %messageaction%

Sends the message and returns it. Requires 'await'.

Sending the same builder twice sends two messages.

Helpful?

Returned by

Syntaxes elsewhere in DiSky that return Message Builder.

[a] new message with [the] content %string% in [the] [channel] %messagechannel%Message Builder [a] new message with [the] embed %embedbuilder% in [the] [channel] %messagechannel%Message Builder

Documentation

Hand-written guides that cover Message Builder.

BuildersConfigure a role, channel, message or invite locally, then create it on Discord in one line.Docs Sending messagesPost to a channel, reply to the current event, or build a message you can edit and pin later.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 Creating pollsBuild a poll with its question, answers and duration, then post it alone or on a message.Docs