Classgatewayv0.1.0-next.3

ContextMenuHandler

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

Pass the kind from discord.jsdiscord.js's ApplicationCommandType as the generic, the same value as @ContextMenuRoute@ContextMenuRoute. Read the right-clicked entity from this.targetthis.target, a UserUser for a user menu and a MessageMessage for a message menu. Context menus carry no options, so a handler registered for several names reads this.targetthis.target uniformly with no per-name branch.

abstract class ContextMenuHandler<
    Kind extends ContextMenuKind,
    Cache extends CacheType = "cached"
> extends InteractionHandler<InteractionFor<Kind, Cache>>

abstract class ContextMenuHandler<
    Kind extends ContextMenuKind,
    Cache extends CacheType = "cached"
> extends InteractionHandler<InteractionFor<Kind, Cache>>

\@ContextMenuRoute(ApplicationCommandType.Message, 'Report Message')
class ReportMessage extends ContextMenuHandler<ApplicationCommandType.Message> {
    async execute() {
        const message = this.target;
    }
}

\@ContextMenuRoute(ApplicationCommandType.Message, 'Report Message')
class ReportMessage extends ContextMenuHandler<ApplicationCommandType.Message> {
    async execute() {
        const message = this.target;
    }
}

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the InteractionHandlerInteractionHandler class

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

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

Inherited from:InteractionHandler

Showing members with Protected visibility and higher.

Methods

buildSender()
showModal()

Kind

ApplicationCommandType.UserApplicationCommandType.User or ApplicationCommandType.MessageApplicationCommandType.Message.

Kind extends ContextMenuKind

Kind extends ContextMenuKind

Cache

The interaction cache state, 'cached''cached' by default.

Cache extends CacheType = 'cached'

Cache extends CacheType = 'cached'

target

protected target: TargetFor<Kind, Cache>

protected target: TargetFor<Kind, Cache>

targetMember

The invoking guild member, resolved only on user menus. Reading it on a message menu is a compile error since the type is nevernever there.

protected targetMember: TargetMemberFor<Kind, Cache>

protected targetMember: TargetMemberFor<Kind, Cache>

buildSender()

protected buildSender(
    event: Event,
    _core: Core,
    routeId: string
): ReplySender

protected buildSender(
    event: Event,
    _core: Core,
    routeId: string
): ReplySender

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>

protected async showModal(
    this: InteractionHandler<NonModalInteraction>,
    modal: ModalLike
): Promise<void>

Inherited from:InteractionHandler

Classgatewayv0.1.0-next.3

ContextMenuHandler

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

abstract class ContextMenuHandler<
    Kind extends ContextMenuKind,
    Cache extends CacheType = "cached"
> extends InteractionHandler<InteractionFor<Kind, Cache>>

abstract class ContextMenuHandler<
    Kind extends ContextMenuKind,
    Cache extends CacheType = "cached"
> extends InteractionHandler<InteractionFor<Kind, Cache>>

\@ContextMenuRoute(ApplicationCommandType.Message, 'Report Message')
class ReportMessage extends ContextMenuHandler<ApplicationCommandType.Message> {
    async execute() {
        const message = this.target;
    }
}

\@ContextMenuRoute(ApplicationCommandType.Message, 'Report Message')
class ReportMessage extends ContextMenuHandler<ApplicationCommandType.Message> {
    async execute() {
        const message = this.target;
    }
}

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the InteractionHandlerInteractionHandler class

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

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

Inherited from:InteractionHandler

Showing members with Protected visibility and higher.

Properties

target
targetMember

Methods

buildSender()
showModal()

Kind

ApplicationCommandType.UserApplicationCommandType.User or ApplicationCommandType.MessageApplicationCommandType.Message.

Kind extends ContextMenuKind

Kind extends ContextMenuKind

Cache

The interaction cache state, 'cached''cached' by default.

Cache extends CacheType = 'cached'

Cache extends CacheType = 'cached'

target

protected target: TargetFor<Kind, Cache>

protected target: TargetFor<Kind, Cache>

targetMember

The invoking guild member, resolved only on user menus. Reading it on a message menu is a compile error since the type is nevernever there.

protected targetMember: TargetMemberFor<Kind, Cache>

protected targetMember: TargetMemberFor<Kind, Cache>

buildSender()

protected buildSender(
    event: Event,
    _core: Core,
    routeId: string
): ReplySender

protected buildSender(
    event: Event,
    _core: Core,
    routeId: string
): ReplySender

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>

protected async showModal(
    this: InteractionHandler<NonModalInteraction>,
    modal: ModalLike
): Promise<void>

Inherited from:InteractionHandler