Classgatewayv0.9.0

UserContextMenuHandler

Base class for a user context-menu command handler (right-click a user).

Pass the command name(s) as the generic, the same as @UserContextMenuRoute. Read the right-clicked user from this.target and that same user's guild member from this.targetMember.

abstract class UserContextMenuHandler<
    Names extends NamesFor<ApplicationCommandType.User>,
    Cache extends CacheType = MenuCacheFor<ApplicationCommandType.User, Names>
> extends InteractionHandler<UserContextMenuCommandInteraction<Cache>>

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the InteractionHandler class

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

Inherited from:InteractionHandler

Showing members with Protected visibility and higher.

Methods

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

Names

One or more command names from the generated user registry.

Names extends NamesFor<ApplicationCommandType.User>

Cache

The interaction cache state. The command's contexts set it.

Cache extends CacheType = MenuCacheFor<ApplicationCommandType.User, Names>

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

route

The selected context-menu command's name, without the interaction-kind prefix.

protected readonly route: Names

sender

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

readonly sender: TSender

Inherited from:RepliableHandler

target

protected target: User

targetMember

The right-clicked user's guild member, null outside a guild.

protected targetMember: CacheTypeReducer<Cache, GuildMember, APIInteractionGuildMember> | null

user

The user who sent this interaction.

protected user: User

Inherited from:RepliableHandler

defer()

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

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

Inherited from:RepliableHandler

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 the selected command. Use this only when the handler is registered for several names.

Provide one case per registered name, keyed by the name Discord shows in the right-click menu. Each case receives the clicked user and that user's guild member, both narrowed to the cache state of that one command. The cases must cover every name in the generic. A missing name or an unknown key is a compile error.

protected async match<Ret, Cases>(
    cases: OnlyCases<Cases, UserMenuCases<Names, Ret>>
): Promise<MatchResult<Ret, Cases>>

Parameter: cases

One handler per registered command name.

Type parameter: Ret

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

\@UserContextMenuRoute('View Profile', 'Warn')
class Moderation extends UserContextMenuHandler<'View Profile' | 'Warn'> {
    async execute() {
        await this.match({
            'View Profile': (user) => this.reply(`Profile for ${user.tag}.`),
            Warn: (user, member) => this.reply(`Warned ${member?.displayName ?? user.tag}.`)
        });
    }
}

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<NonModalInteraction>,
    modal: ModalLike
): Promise<void>

Inherited from:InteractionHandler