Skip to main content

CreateMessageOptions

@discordeno/bot


Documentation / @discordeno/bot / CreateMessageOptions

Interface: CreateMessageOptions

Defined in: packages/types/dist/types/discordeno.d.ts:4

https://discord.com/developers/docs/resources/channel#create-message-jsonform-params

Properties

allowedMentions?

optional allowedMentions: AllowedMentions

Defined in: packages/types/dist/types/discordeno.d.ts:14

Allowed mentions for the message


attachments?

optional attachments: Pick<{ contentType: string; description: string; durationSecs: number; ephemeral: boolean; filename: string; flags: AttachmentFlags; height: null | number; id: string; proxyUrl: string; size: number; title: string; url: string; waveform: string; width: null | number; }, "id"> & Omit<Partial<{ contentType: string; description: string; durationSecs: number; ephemeral: boolean; filename: string; flags: AttachmentFlags; height: null | number; id: string; proxyUrl: string; size: number; title: string; url: string; waveform: string; width: null | number; }>, "id">[]

Defined in: packages/types/dist/types/discordeno.d.ts:31


components?

optional components: MessageComponents

Defined in: packages/types/dist/types/discordeno.d.ts:35

The components you would like to have sent in this message


content?

optional content: string

Defined in: packages/types/dist/types/discordeno.d.ts:6

The message contents (up to 2000 characters)


embeds?

optional embeds: object[]

Defined in: packages/types/dist/types/discordeno.d.ts:12

Embedded rich content (up to 6000 characters)

author?

optional author: object

author.iconUrl?

optional author.iconUrl: string

author.name

author.name: string

author.proxyIconUrl?

optional author.proxyIconUrl: string

author.url?

optional author.url: string

color?

optional color: number

description?

optional description: string

fields?

optional fields: object[]

optional footer: object

footer.iconUrl?

optional footer.iconUrl: string

footer.proxyIconUrl?

optional footer.proxyIconUrl: string

footer.text

footer.text: string

image?

optional image: object

image.height?

optional image.height: number

image.proxyUrl?

optional image.proxyUrl: string

image.url

image.url: string

image.width?

optional image.width: number

provider?

optional provider: object

provider.name?

optional provider.name: string

provider.url?

optional provider.url: string

thumbnail?

optional thumbnail: object

thumbnail.height?

optional thumbnail.height: number

thumbnail.proxyUrl?

optional thumbnail.proxyUrl: string

thumbnail.url

thumbnail.url: string

thumbnail.width?

optional thumbnail.width: number

timestamp?

optional timestamp: string

title?

optional title: string

type?

optional type: EmbedTypes

url?

optional url: string

video?

optional video: object

video.height?

optional video.height: number

video.proxyUrl?

optional video.proxyUrl: string

video.url?

optional video.url: string

video.width?

optional video.width: number


enforceNonce?

optional enforceNonce: boolean

Defined in: packages/types/dist/types/discordeno.d.ts:41

If true and nonce is present, it will be checked for uniqueness in the past few minutes. If another message was created by the same author with the same nonce, that message will be returned and no new message will be created.


files?

optional files: FileContent[]

Defined in: packages/types/dist/types/discordeno.d.ts:33

The contents of the files being sent


flags?

optional flags: MessageFlags

Defined in: packages/types/dist/types/discordeno.d.ts:39

Message flags combined as a bitfield, only SUPPRESS_EMBEDS and SUPPRESS_NOTIFICATIONS can be set


messageReference?

optional messageReference: object

Defined in: packages/types/dist/types/discordeno.d.ts:16

Include to make your message a reply or a forward

channelId?

optional channelId: BigString

id of the originating message's channel Note: channel_id is optional when creating a reply, but will always be present when receiving an event/response that includes this data model.

failIfNotExists

failIfNotExists: boolean

When sending, whether to error if the referenced message doesn't exist instead of sending as a normal (non-reply) message, default true

guildId?

optional guildId: BigString

id of the originating message's guild

messageId?

optional messageId: BigString

id of the originating message

type?

optional type: DiscordMessageReferenceType

Type of reference


nonce?

optional nonce: string | number

Defined in: packages/types/dist/types/discordeno.d.ts:8

Can be used to verify a message was sent (up to 25 characters). Value will appear in the Message Create event.


poll?

optional poll: CreatePoll

Defined in: packages/types/dist/types/discordeno.d.ts:43

A poll object


stickerIds?

optional stickerIds: [BigString] | [BigString, BigString] | [BigString, BigString, BigString]

Defined in: packages/types/dist/types/discordeno.d.ts:37

IDs of up to 3 stickers in the server to send in the message


tts?

optional tts: boolean

Defined in: packages/types/dist/types/discordeno.d.ts:10

true if this is a TTS message