ModalHandler

Base class for a modal submit handler.

Register the customId definitions this handler decodes with @ModalRoute@ModalRoute, list the same ones in the generic, then read this.paramsthis.params for a single route or this.matchthis.match for several. Read the submitted inputs from this.event.fieldsthis.event.fields.

abstract class ModalHandler<
    Defs extends readonly AnyCustomId[],
    Cache extends CacheType = "cached"
> extends ComponentHandler<ModalSubmitInteraction<Cache>, Defs>

abstract class ModalHandler<
    Defs extends readonly AnyCustomId[],
    Cache extends CacheType = "cached"
> extends ComponentHandler<ModalSubmitInteraction<Cache>, Defs>

\@ModalRoute(ConfigId)
class ConfigModal extends ModalHandler<[typeof ConfigId]> {
    \@Catchable()
    async execute() {
        const { guildId } = this.params;
        const name = this.event.fields.getTextInputValue('name');
        await this.event.reply(`saved ${name} for ${guildId}`);
    }
}

\@ModalRoute(ConfigId)
class ConfigModal extends ModalHandler<[typeof ConfigId]> {
    \@Catchable()
    async execute() {
        const { guildId } = this.params;
        const name = this.event.fields.getTextInputValue('name');
        await this.event.reply(`saved ${name} for ${guildId}`);
    }
}

Member visibility

Filter class members by access level.

Showing members with Protected visibility and higher.

Defs

The customId definitions this handler decodes, e.g. [typeof ConfigId][typeof ConfigId].

Defs extends readonly AnyCustomId[]

Defs extends readonly AnyCustomId[]

Cache

The interaction cache state, 'cached''cached' by default.

Cache extends CacheType = 'cached'

Cache extends CacheType = 'cached'