Classseedcordv0.15.0

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)

InteractionHandler(event: Repliable, core: Core)

Inherited from:InteractionHandler

Showing members with Protected visibility and higher.

Methods

execute()

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'

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

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>

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

Classseedcordv0.15.0

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)

InteractionHandler(event: Repliable, core: Core)

Inherited from:InteractionHandler

Showing members with Protected visibility and higher.

Properties

core
event
logger
target
targetMember

Methods

execute()

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'

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

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>

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