Skip to main content

EditWebhookMessageOptions

@discordeno/bot


Documentation / @discordeno/bot / EditWebhookMessageOptions

Interface: EditWebhookMessageOptions

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

https://discord.com/developers/docs/resources/webhook#edit-webhook-message

Properties

allowedMentions?

optional allowedMentions: AllowedMentions

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

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:991

Attached files to keep and possible descriptions for new files


components?

optional components: MessageComponents

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

The components to include with the message

Remarks

Application-owned webhooks can always send components. Non-application-owned webhooks cannot send interactive components, and the components field will be gnored unless they set the with_components query param.


content?

optional content: string

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

The message contents (up to 2000 characters)


embeds?

optional embeds: object[]

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

Embedded rich content

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


files?

optional files: FileContent[]

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

The contents of the files being sent


poll?

optional poll: CreatePoll

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

A poll!

Remarks

Polls can only be added when editing a deferred interaction response.


threadId?

optional threadId: BigString

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

Id of the thread the message is in


withComponents?

optional withComponents: boolean

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

Whether to respect the components field of the request. When enabled, allows application-owned webhooks to use all components and non-owned webhooks to use non-interactive components.

Default

false