ButtonHandler
Base class for a button interaction handler.
Register the customId definitions this handler decodes with @ButtonRoute, list the same ones in the generic, then read this.params for a single route or this.match for several. Reply through the handler members, or rewrite the source message with this.update. Passing different definitions to the decorator and the generic is a compile error.
abstract class ButtonHandler<
Defs extends readonly AnyCustomId[],
Cache extends CacheType = "cached"
> extends ComponentHandler<ButtonInteraction<Cache>, Defs>Member visibility
Filter class members by access level.
constructor
Constructs a new instance of the InteractionHandler class
InteractionHandler(
event: Repliable,
core: Core,
dispatch?: DispatchContext
)Inherited from:InteractionHandler
Showing members with Protected visibility and higher.
Properties
Methods
Defs
The customId definitions this handler decodes, e.g. [typeof ApproveId].
Defs extends readonly AnyCustomId[]Cache
The interaction cache state, 'cached' by default.
Cache extends CacheType = 'cached'params
The decoded params of the single route this handler is registered for.
Reading this decodes this.event.customId once (cached after the first read) and throws StaleCustomId or InvalidCustomId 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 never. Use match instead.
protected params: SingleParams<Defs>Inherited from:ComponentHandler
buildSender()
protected buildSender(
event: Event,
core: Core,
routeId: string
): ReplySenderInherited from:RepliableHandler
deferUpdate()
Acknowledge the component without changing the source message.
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.params directly. On a multi-route handler this.params is never, leaving match as 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 CustomIdMatchArmMissing. 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>armsOne callback per registered route, keyed by prefix.
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>Inherited from:InteractionHandler
update()
Rewrite the source message this component interaction came from.
protected async update(
response: GatewayReplyResponse | string
): Promise<SentMessage>Inherited from:ComponentHandler