Classhttpv0.1.0-next.0

ModalHandler

Base class for a modal submit handler on the HTTP transport.

Register the customId definitions this handler decodes with @ModalRoute@ModalRoute and list the same ones in the generic. Read the submitted inputs off this.event.data.componentsthis.event.data.components. 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[]
> extends ComponentHandler<APIModalSubmitInteraction, Defs>

abstract class ModalHandler<
    Defs extends readonly AnyCustomId[]
> extends ComponentHandler<APIModalSubmitInteraction, Defs>

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the InteractionHandlerInteractionHandler class

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

InteractionHandler(
    event: Event,
    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[]

params

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

Reading this decodes this.event.data.custom_idthis.event.data.custom_id once (cached after the first read) and throws StaleCustomIdStaleCustomId or InvalidCustomIdInvalidCustomId when the wire no longer matches the current shape, which the dispatcher 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()

Silently acknowledge, leaving the source message untouched.

protected async deferUpdate(): Promise<void>

protected async deferUpdate(): Promise<void>

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<
        Exclude<Repliables, APIModalSubmitInteraction>
    >,
    modal: ModalLike
): Promise<void>

protected async showModal(
    this: InteractionHandler<
        Exclude<Repliables, APIModalSubmitInteraction>
    >,
    modal: ModalLike
): Promise<void>

Inherited from:InteractionHandler

update()

Rewrite the message this modal was opened from (only when a component opened it).

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

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

Classhttpv0.1.0-next.0

ModalHandler

Base class for a modal submit handler on the HTTP transport.

abstract class ModalHandler<
    Defs extends readonly AnyCustomId[]
> extends ComponentHandler<APIModalSubmitInteraction, Defs>

abstract class ModalHandler<
    Defs extends readonly AnyCustomId[]
> extends ComponentHandler<APIModalSubmitInteraction, Defs>

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the InteractionHandlerInteractionHandler class

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

InteractionHandler(
    event: Event,
    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[]

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()

Silently acknowledge, leaving the source message untouched.

protected async deferUpdate(): Promise<void>

protected async deferUpdate(): Promise<void>

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<
        Exclude<Repliables, APIModalSubmitInteraction>
    >,
    modal: ModalLike
): Promise<void>

protected async showModal(
    this: InteractionHandler<
        Exclude<Repliables, APIModalSubmitInteraction>
    >,
    modal: ModalLike
): Promise<void>

Inherited from:InteractionHandler

update()

Rewrite the message this modal was opened from (only when a component opened it).

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

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