ModalInteraction

This is the base type interaction, all interaction types extend from this

Extends

BaseInteraction<APIModalSubmitInteraction>

Constructors

Constructor

new ModalInteraction(client, data, defaults): ModalInteraction

Parameters

Parameter	Type
`client`	`Client`
`data`	`APIModalSubmitInteraction`
`defaults`	`InteractionDefaults`

Properties

Property	Type	Default value	Description	Inherited from
`_deferred`	`boolean`	`false`	`Internal` Whether the interaction is deferred already	`BaseInteraction`.`_deferred`
`client`	`Client`	`undefined`	-	`BaseInteraction`.`client`
`customId`	`string`	`undefined`	-	-
`fields`	`FieldsHandler`	`undefined`	-	-
`rawData`	`APIModalSubmitInteraction`	`undefined`	The raw data of the interaction	`BaseInteraction`.`rawData`
`type`	`InteractionType`	`undefined`	The type of interaction	`BaseInteraction`.`type`
`userId`	`undefined` \| `string`	`undefined`	The user who sent the interaction	`BaseInteraction`.`userId`

Accessors

channel

Get Signature

get channel(): null | DmChannel<false> | GroupDmChannel<false> | GuildTextChannel<false> | GuildVoiceChannel<false> | GuildCategoryChannel<false> | GuildAnnouncementChannel<false> | GuildThreadChannel<ThreadChannelType, false> | GuildStageChannel<false> | GuildForumChannel<false> | GuildMediaChannel

Returns

embeds

Get Signature

get embeds(): null | Embed[]

guild

Get Signature

get guild(): null | Guild<true>

member

Get Signature

get member(): null | GuildMember<false, true>

message

Get Signature

get message(): null | Message<false>

user

Get Signature

get user(): null | User<false>

Methods

acknowledge()

acknowledge(): Promise<void>

Acknowledge the interaction, the user does not see a loading state. This can only be used for modals triggered from components

defer()

defer(__namedParameters): Promise<void>

Internal

Defer the interaction response. This is used automatically by commands that are set to defer. If the interaction is already deferred, this will do nothing.

Parameters

Parameter	Type
`__namedParameters`	{ `ephemeral?`: `boolean`; }
`__namedParameters.ephemeral?`	`boolean`

followUp()

followUp(reply): Promise<void>

Send a followup message to the interaction

Parameters

Parameter	Type
`reply`	`MessagePayload`

reply()

reply(data, overrideAutoRegister): Promise<Message<false>>

Reply to an interaction. If the interaction is deferred, this will edit the original response.

Parameters

Parameter	Type	Default value	Description
`data`	`MessagePayload`	`undefined`	The message data to send
`overrideAutoRegister`	`boolean`	`false`	-

replyAndWaitForComponent()

replyAndWaitForComponent(data, timeout): Promise<{ customId: string; success: true; values?: string[]; } | { reason: "timed out"; success: false; }>

This function will reply to the interaction and wait for a component to be pressed. Any components passed in the message will not have run() functions called and will only trigger the interaction.acknowledge() function. This function will also return a promise that resolves to the custom ID of the component that was pressed.

Parameters

Parameter	Type	Default value	Description
`data`	`MessagePayload`	`undefined`	The message data to send
`timeout`	`number`	`300000`	After this many milliseconds, the promise will resolve to null

showModal(modal): Promise<void>

Show a modal to the user This can only be used if the interaction is not deferred

Parameters

Parameter	Type
`modal`	`Modal`

update(data): Promise<void>

Update the original message of the component. This can only be used for modals triggered from components

Parameters

Parameter	Type
`data`	`MessagePayload`

Returns

Promise<void>

ModalInteraction

On this page