Classseedcordv0.13.0

SelectHandler

Base class for a select menu handler.

Pass the select kind first and the customId definitions second, the same order as @SelectMenuRoute@SelectMenuRoute, so this.eventthis.event and this.event.valuesthis.event.values are narrowed to that kind. Read this.paramsthis.params for a single route or this.matchthis.match for several.

abstract class SelectHandler<
    Kind extends SelectMenuKind,
    Defs extends readonly AnyCustomId[],
    Cache extends CacheType = "cached"
> extends ComponentHandler<SelectMenuInteractionFor<Kind, Cache>, Defs>

abstract class SelectHandler<
    Kind extends SelectMenuKind,
    Defs extends readonly AnyCustomId[],
    Cache extends CacheType = "cached"
> extends ComponentHandler<SelectMenuInteractionFor<Kind, Cache>, Defs>

\@SelectMenuRoute(SelectMenuKind.User, AssignId)
class AssignSelect extends SelectHandler<SelectMenuKind.User, [typeof AssignId]> {
    async execute() {
        const { roleId } = this.params;
        await this.event.reply(`assigning ${this.event.values.length} member(s) to <@&${roleId}>`);
    }
}

\@SelectMenuRoute(SelectMenuKind.User, AssignId)
class AssignSelect extends SelectHandler<SelectMenuKind.User, [typeof AssignId]> {
    async execute() {
        const { roleId } = this.params;
        await this.event.reply(`assigning ${this.event.values.length} member(s) to <@&${roleId}>`);
    }
}

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the InteractionHandlerInteractionHandler class

InteractionHandler(event: Repliable, core: Core)

InteractionHandler(event: Repliable, core: Core)

Inherited from:InteractionHandler

Showing members with Protected visibility and higher.

Methods

execute()
match()

Kind

The select kind from SelectMenuKindSelectMenuKind, e.g. SelectMenuKind.UserSelectMenuKind.User.

Kind extends SelectMenuKind

Kind extends SelectMenuKind

Defs

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

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'

optional

__componentDefs

readonly __componentDefs: Defs

readonly __componentDefs: Defs

Inherited from:ComponentHandler

core

readonly core: Core

readonly core: Core

Inherited from:BaseHandler

event

protected readonly event: ValidEvent

protected readonly event: ValidEvent

Inherited from:BaseHandler

logger

protected readonly logger: 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.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

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()execute() from running.

abstract async execute(): Promise<void>

abstract async execute(): Promise<void>

Inherited from:BaseHandler

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 must cover every registered def, a missing prefix or an unknown key is a compile error. 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 handler 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.event.reply(`approved <@${userId}>`),
            reject: ({ userId }) => this.event.reply(`rejected <@${userId}>`)
        });
    }
}

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

Inherited from:ComponentHandler

Classseedcordv0.13.0

SelectHandler

Base class for a select menu handler.

abstract class SelectHandler<
    Kind extends SelectMenuKind,
    Defs extends readonly AnyCustomId[],
    Cache extends CacheType = "cached"
> extends ComponentHandler<SelectMenuInteractionFor<Kind, Cache>, Defs>

abstract class SelectHandler<
    Kind extends SelectMenuKind,
    Defs extends readonly AnyCustomId[],
    Cache extends CacheType = "cached"
> extends ComponentHandler<SelectMenuInteractionFor<Kind, Cache>, Defs>

\@SelectMenuRoute(SelectMenuKind.User, AssignId)
class AssignSelect extends SelectHandler<SelectMenuKind.User, [typeof AssignId]> {
    async execute() {
        const { roleId } = this.params;
        await this.event.reply(`assigning ${this.event.values.length} member(s) to <@&${roleId}>`);
    }
}

\@SelectMenuRoute(SelectMenuKind.User, AssignId)
class AssignSelect extends SelectHandler<SelectMenuKind.User, [typeof AssignId]> {
    async execute() {
        const { roleId } = this.params;
        await this.event.reply(`assigning ${this.event.values.length} member(s) to <@&${roleId}>`);
    }
}

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the InteractionHandlerInteractionHandler class

InteractionHandler(event: Repliable, core: Core)

InteractionHandler(event: Repliable, core: Core)

Inherited from:InteractionHandler

Showing members with Protected visibility and higher.

Properties

__componentDefs
core
event
logger
params

Methods

execute()
match()

Kind

The select kind from SelectMenuKindSelectMenuKind, e.g. SelectMenuKind.UserSelectMenuKind.User.

Kind extends SelectMenuKind

Kind extends SelectMenuKind

Defs

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

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'

optional

__componentDefs

readonly __componentDefs: Defs

readonly __componentDefs: Defs

Inherited from:ComponentHandler

core

readonly core: Core

readonly core: Core

Inherited from:BaseHandler

event

protected readonly event: ValidEvent

protected readonly event: ValidEvent

Inherited from:BaseHandler

logger

protected readonly logger: Logger

protected readonly logger: Logger

Inherited from:BaseHandler

params

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

protected params: SingleParams<Defs>

protected params: SingleParams<Defs>

Inherited from:ComponentHandler

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()execute() from running.

abstract async execute(): Promise<void>

abstract async execute(): Promise<void>

Inherited from:BaseHandler

match()

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

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

Parameter: arms

One handler 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.event.reply(`approved <@${userId}>`),
            reject: ({ userId }) => this.event.reply(`rejected <@${userId}>`)
        });
    }
}

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

Inherited from:ComponentHandler