Interface CreateMessageOptions

interface CreateMessageOptions {
    allowedMentions?: AllowedMentions;
    attachments?: MessageAttachment[];
    components?: MessageActionRow[];
    content?: string;
    embeds?: EmbedOptions[];
    files?: File[];
    flags?: number;
    messageReference?: MessageReference;
    poll?: MessagePollOptions;
    stickerIDs?: string[];
    tts?: boolean;
}

Properties

allowedMentions? attachments? components? content? embeds? files? flags? messageReference? poll? stickerIDs? tts?

Properties

Optional allowedMentions

allowedMentions?: AllowedMentions

An object that specifies the allowed mentions in this message.

Optional attachments

attachments?: MessageAttachment[]

An array of partial attachments related to the sent files.

Optional components

components?: MessageActionRow[]

An array of components to send. snake_case keys should be converted to camelCase, or passed through Util#rawMessageComponents.

Optional content

content?: string

The content of the message.

Optional embeds

embeds?: EmbedOptions[]

An array of embeds to send. snake_case keys should be converted to camelCase, or passed through Util#rawEmbeds.

Optional files

files?: File[]

The files to send.

Optional flags

flags?: number

The flags to send with the message.

Optional messageReference

messageReference?: MessageReference

Reply to a message.

Optional poll

poll?: MessagePollOptions

A poll to send.

Note

As of 3/22/24:

  • content, components, and many other fields cannot be sent alongside a poll.
    • This means we cannot set allowedMentions. If in the future content can be sent alongside a poll, allowedMentions will not be set automatically, and must be set manually.
  • Messages with a poll cannot be edited.

Optional stickerIDs

stickerIDs?: string[]

The IDs of up to 3 stickers from the current guild to send.

Optional tts

tts?: boolean

If the message should be spoken aloud.

Settings

Member Visibility

Theme

On This Page