Class

MessagePayload

Fluent message builder (camelCase setters → snake_case via toJSON). Prefer passing the builder to channel.send(payload) / prepareMessagePostPayload(payload) in @fluxerjs/core so defaults (allowed mentions, reply ping) apply. Use toJSON only for low-level REST bodies.

Constructor

new MessagePayload()

Properties

Name	Type	Description
ContentMaxLengthstaticread-only	`2000`	Max content length (2000 characters).
dataread-only	`MessagePayloadData`	Partial message data (built incrementally via setters).

Methods

.addEmbed(embed)

embed: RESTPostAPIEmbed | EmbedBuilder → this

Add an embed (up to 10 total). Existing embeds are preserved.

embed: RESTPostAPIEmbed | EmbedBuilderEmbed object or EmbedBuilder

messagePayload.addEmbed(embed);

static create(contentOrOptions?)

contentOrOptions?: string | MessagePayloadCreateOptions → MessagePayload

Create from string content or options object.

contentOrOptions?: string | MessagePayloadCreateOptionsText content or full payload options

MessagePayload.create();

.setAllowedMentions(allowedMentions)

allowedMentions: APIAllowedMentions | null → this

Set allowed mentions (controls who can be pinged). Pass null to clear.

allowedMentions: APIAllowedMentions | nullAllowed mention rules, or null

messagePayload.setAllowedMentions(allowedMentions);

.setAttachments(attachments)

attachments: AttachmentInput[] | null → this

Set attachments metadata (file bytes sent separately via multipart). Pass null to clear. Prefer AttachmentMeta for index metadata; AttachmentBuilder serializes via toJSON(id).

attachments: AttachmentInput[] | nullArray of AttachmentMeta, AttachmentBuilder, or plain objects, or null

messagePayload.setAttachments(attachments);

.setContent(content)

content: string | null → this

Set message content (max 2000 characters). Pass null to clear.

content: string | nullText content or null

messagePayload.setContent(content);

.setEmbeds(embeds)

embeds: (RESTPostAPIEmbed | EmbedBuilder)[] | null → this

Replace all embeds (max 10). Pass null or empty array to clear.

embeds: (RESTPostAPIEmbed | EmbedBuilder)[] | nullArray of embed objects or EmbedBuilder instances, or null

messagePayload.setEmbeds(embeds);

.setFlags(flags)

flags: number → this

Set message flags (e.g., suppress embeds).

flags: numberMessage flags bitfield

messagePayload.setFlags(flags);

.setReply(reference)

reference: ReplyInput | null → this

Set message reference (reply target). Pass null to clear.

reference: ReplyInput | nullReply target (channel/message IDs), or null

messagePayload.setReply(reference);

.setTTS(tts)

tts: boolean → this

Set text-to-speech flag.

tts: booleanWhether to use TTS

messagePayload.setTTS(tts);