Classgatewayv0.1.0-next.3

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, and reply through the handler members. Discord forbids opening a modal in response to a modal, so showModalshowModal fails compilation on this kind.

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]> {
    async execute() {
        const { guildId } = this.params;
        const name = this.event.fields.getTextInputValue('name');
        await this.reply(`saved ${name} for ${guildId}`);
    }
}

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

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the InteractionHandlerInteractionHandler class

InteractionHandler(
    event: Repliable,
    core: Core,
    dispatch?: DispatchContext
)

InteractionHandler(
    event: Repliable,
    core: Core,
    dispatch?: DispatchContext
)

Inherited from:InteractionHandler

Showing members with Protected visibility and higher.

Properties

params

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'

params

The decoded params of the single route this handler is registered for.

Reading this decodes this.event.customIdthis.event.customId once (cached after the first read) and throws StaleCustomIdStaleCustomId or InvalidCustomIdInvalidCustomId when the wire no longer matches the current shape, which the controller boundary turns into a reply. On a handler registered for several routes this is nevernever, so use matchmatch instead.

protected params: SingleParams<Defs>

protected params: SingleParams<Defs>

Inherited from:ComponentHandler

buildSender()

protected buildSender(
    event: Event,
    _core: Core,
    routeId: string
): ReplySender

protected buildSender(
    event: Event,
    _core: Core,
    routeId: string
): ReplySender

Inherited from:RepliableHandler

deferUpdate()

Acknowledge the component without changing the source message.

protected async deferUpdate(): Promise<void>

protected async deferUpdate(): Promise<void>

Inherited from:ComponentHandler

match()

Run the arm for whichever route the component was minted from. Use this only when the handler is registered for several routes. A single-route handler reads this.paramsthis.params directly. On a multi-route handler this.paramsthis.params is nevernever, so match is the only way to read the decoded params.

Provide one arm per registered route, keyed by its prefix, and each arm receives that route's own decoded params. The arms cover every registered route prefix, checked at compile time, and a prefix unmatched at runtime throws CustomIdMatchArmMissingCustomIdMatchArmMissing. Decoding runs before any arm, so a stale or corrupt wire throws before an arm body executes.

protected async match<Ret>(arms: MatchArms<Defs, Ret>): Promise<Ret>

protected async match<Ret>(arms: MatchArms<Defs, Ret>): Promise<Ret>

Parameter: arms

One callback per registered route, keyed by prefix.

\@ButtonRoute(Approve, Reject)
class ReviewButtons extends ButtonHandler<[typeof Approve, typeof Reject]> {
    async execute() {
        await this.match({
            approve: ({ userId }) => this.reply(`approved <@${userId}>`),
            reject: ({ userId }) => this.reply(`rejected <@${userId}>`)
        });
    }
}

\@ButtonRoute(Approve, Reject)
class ReviewButtons extends ButtonHandler<[typeof Approve, typeof Reject]> {
    async execute() {
        await this.match({
            approve: ({ userId }) => this.reply(`approved <@${userId}>`),
            reject: ({ userId }) => this.reply(`rejected <@${userId}>`)
        });
    }
}

Inherited from:ComponentHandler

showModal()

Open a modal. Must be the initial response to this interaction. The modal kind rejects this call at compile time (Discord forbids a modal in response to a modal).

protected async showModal(
    this: InteractionHandler<NonModalInteraction>,
    modal: ModalLike
): Promise<void>

protected async showModal(
    this: InteractionHandler<NonModalInteraction>,
    modal: ModalLike
): Promise<void>

Inherited from:InteractionHandler

update()

Rewrite the source message this component interaction came from.

protected async update(
    response: ReplyResponse | string
): Promise<SentMessage>

protected async update(
    response: ReplyResponse | string
): Promise<SentMessage>

Inherited from:ComponentHandler

Classgatewayv0.1.0-next.3

ModalHandler

Base class for a modal submit handler.

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]> {
    async execute() {
        const { guildId } = this.params;
        const name = this.event.fields.getTextInputValue('name');
        await this.reply(`saved ${name} for ${guildId}`);
    }
}

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

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the InteractionHandlerInteractionHandler class

InteractionHandler(
    event: Repliable,
    core: Core,
    dispatch?: DispatchContext
)

InteractionHandler(
    event: Repliable,
    core: Core,
    dispatch?: DispatchContext
)

Inherited from:InteractionHandler

Showing members with Protected visibility and higher.

Properties

params

Methods

buildSender()
deferUpdate()
match()
showModal()
update()

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'

params

The decoded params of the single route this handler is registered for.

protected params: SingleParams<Defs>

protected params: SingleParams<Defs>

Inherited from:ComponentHandler

buildSender()

protected buildSender(
    event: Event,
    _core: Core,
    routeId: string
): ReplySender

protected buildSender(
    event: Event,
    _core: Core,
    routeId: string
): ReplySender

Inherited from:RepliableHandler

deferUpdate()

Acknowledge the component without changing the source message.

protected async deferUpdate(): Promise<void>

protected async deferUpdate(): Promise<void>

Inherited from:ComponentHandler

match()

protected async match<Ret>(arms: MatchArms<Defs, Ret>): Promise<Ret>

protected async match<Ret>(arms: MatchArms<Defs, Ret>): Promise<Ret>

Parameter: arms

One callback per registered route, keyed by prefix.

\@ButtonRoute(Approve, Reject)
class ReviewButtons extends ButtonHandler<[typeof Approve, typeof Reject]> {
    async execute() {
        await this.match({
            approve: ({ userId }) => this.reply(`approved <@${userId}>`),
            reject: ({ userId }) => this.reply(`rejected <@${userId}>`)
        });
    }
}

\@ButtonRoute(Approve, Reject)
class ReviewButtons extends ButtonHandler<[typeof Approve, typeof Reject]> {
    async execute() {
        await this.match({
            approve: ({ userId }) => this.reply(`approved <@${userId}>`),
            reject: ({ userId }) => this.reply(`rejected <@${userId}>`)
        });
    }
}

Inherited from:ComponentHandler

showModal()

Open a modal. Must be the initial response to this interaction. The modal kind rejects this call at compile time (Discord forbids a modal in response to a modal).

protected async showModal(
    this: InteractionHandler<NonModalInteraction>,
    modal: ModalLike
): Promise<void>

protected async showModal(
    this: InteractionHandler<NonModalInteraction>,
    modal: ModalLike
): Promise<void>

Inherited from:InteractionHandler

update()

Rewrite the source message this component interaction came from.

protected async update(
    response: ReplyResponse | string
): Promise<SentMessage>

protected async update(
    response: ReplyResponse | string
): Promise<SentMessage>

Inherited from:ComponentHandler