Classhttpv0.12.0

ComponentHandler

Shared base the customId-routed component handlers extend on the HTTP transport.

Not a public entry point. Extend ButtonHandler, ModalHandler, or one of the select menu bases instead. This class defines the customId decode, the route matching, and the source-message verbs update and deferUpdate.

abstract class ComponentHandler<
    Event extends APIMessageComponentInteraction | APIModalSubmitInteraction,
    Defs extends readonly AnyCustomId[]
>
    extends InteractionHandler<Event>
    implements HasComponentDefs<Defs>

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the InteractionHandler class

InteractionHandler(
    event: Event,
    core: Core,
    dispatch: DispatchContext,
    sender: ReplySender
)

Inherited from:InteractionHandler

Showing members with Protected visibility and higher.

Methods

defer()
deferUpdate()
delete()
edit()
execute()
followUp()
match()
reply()
send()
showModal()
update()

Event

The component or modal interaction type this handler processes

Event extends APIMessageComponentInteraction | APIModalSubmitInteraction

Defs

The customId route definitions registered on the concrete handler

Defs extends readonly AnyCustomId[]

api

Typed Discord REST API (@discordjs/core/http-only) over core.rest, one instance per core. The interaction callbacks on api.interactions bypass the reply surface. The no-raw-interaction-acks rule flags them in handler classes.

protected api: API

Inherited from:RepliableHandler

core

readonly core: TCore

Inherited from:BaseHandler

dispatch

The bag for this dispatch. Each interaction gets its own. Every handler for one event shares a single bag.

protected readonly dispatch: DispatchContext

Inherited from:BaseHandler

event

protected readonly event: Event

Inherited from:BaseHandler

logger

protected readonly logger: Logger

Inherited from:BaseHandler

params

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

Reading this decodes this.event.data.custom_id once and caches the result. On a handler registered for several routes this is never. Use match instead.

protected params: SingleParams<Defs>

Throws:

A StaleCustomId when the wire was encoded under an older shape. The dispatcher boundary turns it into a reply.
An InvalidCustomId when the wire is corrupt. The dispatcher boundary turns it into a reply.

route

The matched custom-ID prefix, such as approve, without encoded params.

protected readonly route: Defs[number]['prefix']

sender

The reply surface for this interaction. Pass the handler to reply from outside its class.

readonly sender: TSender

Inherited from:RepliableHandler

user

The user who sent this interaction, read from member.user in a guild and user in a DM.

protected user: APIUser

Inherited from:RepliableHandler

defer()

Show a "thinking" placeholder, then fill it later with edit.

protected async defer(opts?: DeferOpts): Promise<void>

Inherited from:RepliableHandler

deferUpdate()

Acknowledge the component without changing the source message.

protected async deferUpdate(): Promise<void>

delete()

Delete the initial reply or deferred placeholder. Pass a target to delete a message a prior send returned.

protected async delete(target?: TMessage): Promise<void>

Inherited from:RepliableHandler

edit()

Rewrite the initial reply or deferred placeholder. The targeted form rewrites a message a prior send returned.

protected async edit(
    response: ReplyResponse<TNative> | string
): Promise<TMessage>

Inherited from:RepliableHandler

execute()

Holds the main logic of your handler. The dispatcher calls it after the handler's gates pass, so a gate that refuses stops execute() from running.

abstract execute(): Promisable<void>

Inherited from:BaseHandler

followUp()

Send a new message once the interaction is acknowledged.

protected async followUp(
    response: ReplyResponse<TNative> | string,
    opts?: SendOpts
): Promise<TMessage>

Inherited from:RepliableHandler

match()

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

Provide one case per registered route, keyed by its prefix, and each case receives that route's own decoded params. The compiler checks that the cases cover every registered route prefix. match decodes the wire before it runs a case.

protected async match<Ret, Cases>(
    cases: OnlyCases<Cases, MatchCases<Defs, Ret>>
): Promise<MatchResult<Ret, Cases>>

Parameter: cases

One callback per registered route, keyed by prefix.

Type parameter: Ret

The type that every case must return. Leave it out to get the union of what the cases return.

Throws:

A SeedcordTypeError with MatchCaseMissing when the wire's prefix doesn't have a case.

Throws:

A StaleCustomId when the wire was encoded under an older shape.

Throws:

An InvalidCustomId when the wire is corrupt.

\@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}>`)
        });
    }
}

reply()

Send the initial response, exactly once.

protected async reply(
    response: ReplyResponse<TNative> | string,
    opts?: SendOpts
): Promise<TMessage>

Inherited from:RepliableHandler

send()

Routes to reply, followUp, or edit based on the current ack state.

protected async send(
    response: ReplyResponse<TNative> | string,
    opts?: SendOpts
): Promise<TMessage>

Inherited from:RepliableHandler

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>

Inherited from:InteractionHandler

update()

Rewrite the source message this component interaction came from.

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