discord.js | MessageBuilder

Search...

MessageBuilder

export declare class MessageBuilder implements JSONEncodable<RESTPostAPIChannelMessageJSONBody>

export declare class MessageBuilder implements JSONEncodable<RESTPostAPIChannelMessageJSONBody>

No summary provided.

Implements

JSONEncodable<RESTPostAPIChannelMessageJSONBody>

constructor(data?)

Creates new attachment builder from API data.

Name	Type	Optional	Description
data	Partial<RESTPostAPIChannelMessageJSONBody>	Yes	The API data to create this attachment with

Readonly

attachments:readonly AttachmentBuilder[]

Gets the attachments of this message.

Readonly

components:readonly ActionRowBuilder[]

Gets the components of this message.

Readonly

embeds:readonly EmbedBuilder[]

Gets the embeds of this message.

addAttachments(...attachments):this

Adds attachments to this message.

Name	Type	Optional	Description
...attachments	RestOrArray<APIAttachment \| AttachmentBuilder \| ((builder: AttachmentBuilder) => AttachmentBuilder)>	No	The attachments to add

addComponents(...components):this

Adds components to this message.

Name	Type	Optional	Description
...components	RestOrArray<ActionRowBuilder \| APIActionRowComponent<APIMessageActionRowComponent> \| ((builder: ActionRowBuilder) => ActionRowBuilder)>	No	The components to add

addEmbeds(...embeds):this

Appends embeds to this message.

Remarks

The maximum amount of embeds that can be added is 10.

Example

Using an array:

const embeds: APIEmbed[] = ...;
const message = new MessageBuilder()
	.addEmbeds(embeds);

const embeds: APIEmbed[] = ...;
const message = new MessageBuilder()
	.addEmbeds(embeds);

Example

Using rest parameters (variadic):

const message = new MessageBuilder()
	.addEmbeds(
		{ title: 'Embed 1' },
		{ title: 'Embed 2' },
	);

const message = new MessageBuilder()
	.addEmbeds(
		{ title: 'Embed 1' },
		{ title: 'Embed 2' },
	);

Name	Type	Optional	Description
...embeds	RestOrArray<APIEmbed \| EmbedBuilder \| ((builder: EmbedBuilder) => EmbedBuilder)>	No	The embeds to add

addStickerIds(...stickerIds):this

Adds sticker ids to this message.

Name	Type	Optional	Description
...stickerIds	RestOrArray<Snowflake>	No	The ids of the stickers to add

clearAllowedMentions():this

Clears the allowed mentions for this message.

clearContent():this

Clears the content of the message.

clearFlags():this

Clears the flags for this message.

clearMessageReference():this

Clears the message reference for this message.

clearNonce():this

Clears the nonce of the message.

clearPoll():this

Clears the poll for this message.

setAllowedMentions(allowedMentions):this

Sets the allowed mentions for this message.

Name	Type	Optional	Description
allowedMentions	AllowedMentionsBuilder \| APIAllowedMentions \| ((builder: AllowedMentionsBuilder) => AllowedMentionsBuilder)	No	The allowed mentions to set

setAttachments(...attachments):this

Sets attachments for this message.

Name	Type	Optional	Description
...attachments	RestOrArray<APIAttachment \| AttachmentBuilder \| ((builder: AttachmentBuilder) => AttachmentBuilder)>	No	The attachments to set

setComponents(...components):this

Sets the components of this message.

Name	Type	Optional	Description
...components	RestOrArray<ActionRowBuilder \| APIActionRowComponent<APIMessageActionRowComponent> \| ((builder: ActionRowBuilder) => ActionRowBuilder)>	No	The components to set

setContent(content):this

Sets the content of the message.

Name	Type	Optional	Description
content	string	No	The content to set

setEnforceNonce(enforceNonce?):this

Sets enforce_nonce for this message.

Name	Type	Optional	Description
enforceNonce	boolean	Yes	None

setFlags(flags):this

Sets the flags for this message.

Name	Type	Optional	Description
flags	MessageFlags	No	None

setMessageReference(reference):this

Sets the message reference for this message.

Name	Type	Optional	Description
reference	APIMessageReference \| MessageReferenceBuilder \| ((builder: MessageReferenceBuilder) => MessageReferenceBuilder)	No	The reference to set

setNonce(nonce):this

Sets the nonce of the message.

Name	Type	Optional	Description
nonce	number \| string	No	The nonce to set

setPoll(poll):this

Sets the poll for this message.

Name	Type	Optional	Description
poll	APIPoll \| PollBuilder \| ((builder: PollBuilder) => PollBuilder)	No	The poll to set

setStickerIds(...stickerIds):this

Sets the sticker ids of this message.

Name	Type	Optional	Description
...stickerIds	RestOrArray<Snowflake>	No	The ids of the stickers to set

setTTS(tts?):this

Sets whether the message is TTS.

Name	Type	Optional	Description
tts	boolean	Yes	None

spliceAttachments(start, deleteCount, ...attachments):this

Removes, replaces, or inserts attachments for this message.

Remarks

This method behaves similarly to Array.prototype.splice().It's useful for modifying and adjusting order of the already-existing attachments of a message.

Example

Remove the first attachment:

message.spliceAttachments(0, 1);

message.spliceAttachments(0, 1);

Example

Remove the first n attachments:

const n = 4;
message.spliceAttachments(0, n);

const n = 4;
message.spliceAttachments(0, n);

Example

Remove the last attachment:

message.spliceAttachments(-1, 1);

message.spliceAttachments(-1, 1);

Name	Type	Optional	Description
start	number	No	The index to start at
deleteCount	number	No	The amount of attachments to remove
...attachments	RestOrArray<APIAttachment \| AttachmentBuilder \| ((builder: AttachmentBuilder) => AttachmentBuilder)>	No	The attachments to insert

spliceComponents(start, deleteCount, ...components):this

Removes, replaces, or inserts components for this message.

Remarks

This method behaves similarly to Array.prototype.splice().It's useful for modifying and adjusting order of the already-existing components of a message.

Example

Remove the first component:

message.spliceComponents(0, 1);

message.spliceComponents(0, 1);

Example

Remove the first n components:

const n = 4;
message.spliceComponents(0, n);

const n = 4;
message.spliceComponents(0, n);

Example

Remove the last component:

message.spliceComponents(-1, 1);

message.spliceComponents(-1, 1);

Name	Type	Optional	Description
start	number	No	The index to start at
deleteCount	number	No	The amount of components to remove
...components	RestOrArray<ActionRowBuilder \| APIActionRowComponent<APIMessageActionRowComponent> \| ((builder: ActionRowBuilder) => ActionRowBuilder)>	No	The components to insert

spliceEmbeds(start, deleteCount, ...embeds):this

Removes, replaces, or inserts embeds for this message.

Remarks

This method behaves similarly to Array.prototype.splice().It's useful for modifying and adjusting order of the already-existing embeds of a message.

Example

Remove the first embed:

message.spliceEmbeds(0, 1);

message.spliceEmbeds(0, 1);

Example

Remove the first n embeds:

const n = 4;
message.spliceEmbeds(0, n);

const n = 4;
message.spliceEmbeds(0, n);

Example

Remove the last embed:

message.spliceEmbeds(-1, 1);

message.spliceEmbeds(-1, 1);

Name	Type	Optional	Description
start	number	No	The index to start at
deleteCount	number	No	The amount of embeds to remove
...embeds	RestOrArray<APIEmbed \| EmbedBuilder \| ((builder: EmbedBuilder) => EmbedBuilder)>	No	The embeds to insert

spliceStickerIds(index, deleteCount, ...stickerIds):this

Removes, replaces, or inserts sticker ids for this message.

Remarks

This method behaves similarly to Array.prototype.splice().It's useful for modifying and adjusting order of the already-existing sticker ids of a message.

Example

Remove the first sticker id:

message.spliceStickerIds(0, 1);

message.spliceStickerIds(0, 1);

Example

Remove the first n sticker ids:

const n = 4;
message.spliceStickerIds(0, n);

const n = 4;
message.spliceStickerIds(0, n);

Example

Remove the last sticker id:

message.spliceStickerIds(-1, 1);

message.spliceStickerIds(-1, 1);

Name	Type	Optional	Description
index	number	No	The index to start at
deleteCount	number	No	The amount of sticker ids to remove
...stickerIds	RestOrArray<Snowflake>	No	The sticker ids to insert

toJSON(validationOverride?):RESTPostAPIChannelMessageJSONBody

Serializes this builder to API-compatible JSON data.Note that by disabling validation, there is no guarantee that the resulting object will be valid.

Name	Type	Optional	Description
validationOverride	boolean	Yes	Force validation to run/not run regardless of your global preference

updateAllowedMentions(updater):this

Updates the allowed mentions for this message (and creates it if it doesn't exist)

Name	Type	Optional	Description
updater	(builder: AllowedMentionsBuilder) => AllowedMentionsBuilder	No	The function to update the allowed mentions with

updateMessageReference(updater):this

Updates the message reference for this message (and creates it if it doesn't exist)

Name	Type	Optional	Description
updater	(builder: MessageReferenceBuilder) => MessageReferenceBuilder	No	The function to update the message reference with

updatePoll(updater):this

Updates the poll for this message (and creates it if it doesn't exist)

Name	Type	Optional	Description
updater	(builder: PollBuilder) => PollBuilder	No	The function to update the poll with