Class: MessageBuilder
@sapphire/discord.js-utilities.MessageBuilder
A message builder class, it implements the MessageCreateOptions interface.
Implements
Constructors
constructor
• new MessageBuilder(options?): MessageBuilder
Parameters
| Name | Type |
|---|---|
options? | MessageBuilderResolvable |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/builders/MessageBuilder.ts:53
Properties
allowedMentions
• Optional allowedMentions: MessageMentionOptions
Which mentions should be parsed from the message content.
Implementation of
MessageCreateOptions.allowedMentions
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/builders/MessageBuilder.ts:45
components
• Optional components: (APIActionRowComponent<APIMessageActionRowComponent> | JSONEncodable<APIActionRowComponent<APIMessageActionRowComponent>> | ActionRowData<MessageActionRowComponentBuilder | MessageActionRowComponentData>)[]
The components for the message. If set to undefined and the builder is used to edit, the components will not be replaced.
Implementation of
MessageCreateOptions.components
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/builders/MessageBuilder.ts:40
content
• Optional content: string
The content for the message. If set to undefined and the builder is used to edit, the content will not be replaced.
Implementation of
MessageCreateOptions.content
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/builders/MessageBuilder.ts:29
embeds
• Optional embeds: (APIEmbed | JSONEncodable<APIEmbed>)[]
The embeds for the message. If set to undefined and the builder is used to edit, the embed will not be replaced.
Remark
There is a maximum of 10 embeds in 1 message
Implementation of
MessageCreateOptions.embeds
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/builders/MessageBuilder.ts:35
files
• Optional files: (Stream | Attachment | BufferResolvable | AttachmentBuilder | AttachmentPayload | JSONEncodable<APIAttachment>)[]
Files to send with the message. This should not be set when editing a message, as Discord does not support editing file attachments.
Implementation of
MessageCreateOptions.files
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/builders/MessageBuilder.ts:51
nonce
• Optional nonce: string | number
The nonce for the message.
Default
''
Implementation of
MessageCreateOptions.nonce
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/builders/MessageBuilder.ts:23
tts
• Optional tts: boolean
Whether or not the message should be spoken aloud.
Default
false
Implementation of
MessageCreateOptions.tts
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/builders/MessageBuilder.ts:17
defaults
▪ Static defaults: MessageBuilderResolvable = {}
The default values for all MessageBuilder instances.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/builders/MessageBuilder.ts:158
Methods
addFile
▸ addFile(file): this
Adds a new value for the MessageBuilder.files field array.
Parameters
| Name | Type | Description |
|---|---|---|
file | Stream | Attachment | BufferResolvable | AttachmentBuilder | AttachmentPayload | JSONEncodable<APIAttachment> | The file to add to the MessageBuilder.files field array. |
Returns
this
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/builders/MessageBuilder.ts:130
setAllowedMentions
▸ setAllowedMentions(allowedMentions?): this
Sets the value for the MessageBuilder.allowedMentions field.
Parameters
| Name | Type | Description |
|---|---|---|
allowedMentions? | MessageMentionOptions | Which mentions should be parsed from the message content. |
Returns
this
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/builders/MessageBuilder.ts:121
setComponents
▸ setComponents(components?): this
Sets the value for the MessageBuilder.components field.
Parameters
| Name | Type | Description |
|---|---|---|
components? | (APIActionRowComponent<APIMessageActionRowComponent> | JSONEncodable<APIActionRowComponent<APIMessageActionRowComponent>> | ActionRowData<MessageActionRowComponentBuilder | MessageActionRowComponentData>)[] | The components for the message. If set to undefined and the builder is used to edit, the components will not be replaced. |
Returns
this
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/builders/MessageBuilder.ts:112
setContent
▸ setContent(content?): this
Sets the value for the MessageBuilder.content field.
Parameters
| Name | Type | Description |
|---|---|---|
content? | string | The content for the message. If set to undefined and the builder is used to edit, the content will not be replaced. |
Returns
this
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/builders/MessageBuilder.ts:86
setEmbeds
▸ setEmbeds(embeds?): this
Sets the value for the MessageBuilder.embed field.
Parameters
| Name | Type | Description |
|---|---|---|
embeds? | (APIEmbed | JSONEncodable<APIEmbed>)[] | The embeds for the message. If set to undefined and the builder is used to edit, the embed will not be replaced. There is a maximum of 10 embeds per message |
Returns
this
Remark
When providing more than 10 embeds, the array will automatically be sliced down to the first 10.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/builders/MessageBuilder.ts:97
setFile
▸ setFile(file): this
Sets a single value for the MessageBuilder.files field array.
Parameters
| Name | Type | Description |
|---|---|---|
file | Stream | Attachment | BufferResolvable | AttachmentBuilder | AttachmentPayload | JSONEncodable<APIAttachment> | The file to send with the message. This should not be set when editing a message, as Discord does not support editing file attachments. |
Returns
this
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/builders/MessageBuilder.ts:140
setFiles
▸ setFiles(files?): this
Sets the value for the MessageBuilder.files field.
Parameters
| Name | Type | Description |
|---|---|---|
files? | (Stream | Attachment | BufferResolvable | AttachmentBuilder | AttachmentPayload | JSONEncodable<APIAttachment>)[] | The files to send with the message. This should not be set when editing a message, as Discord does not support editing file attachments. |
Returns
this
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/builders/MessageBuilder.ts:150
setNonce
▸ setNonce(nonce?): this
Sets the value for the MessageBuilder.nonce field.
Parameters
| Name | Type | Description |
|---|---|---|
nonce? | string | The nonce for the message. |
Returns
this
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/builders/MessageBuilder.ts:76
setTTS
▸ setTTS(tts?): this
Sets the value for the MessageBuilder.tts field.
Parameters
| Name | Type | Description |
|---|---|---|
tts? | boolean | Whether or not the message should be spoken aloud. |
Returns
this
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/builders/MessageBuilder.ts:67