# MessageContextMenuHandler

`class` in `gateway` · v0.4.1

<https://docs.seedcord.org/packages/gateway/0.4.1/classes/message-context-menu-handler>

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

Pass the command name(s) as the generic, the same as `@MessageContextMenuRoute`. Read the right-clicked message from `this.target`.

```ts
abstract class MessageContextMenuHandler<
    Names extends NamesFor<ApplicationCommandType.Message>,
    Cache extends CacheType = MenuCacheFor<ApplicationCommandType.Message, Names>
> extends InteractionHandler<MessageContextMenuCommandInteraction<Cache>>
```

## Examples

```ts
\@MessageContextMenuRoute('Report Message')
class ReportMessage extends MessageContextMenuHandler<'Report Message'> {
    async execute() {
        const message = this.target;
    }
}
```

## Constructors

### constructor

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

Constructs a new instance of the `InteractionHandler` class

## Properties

### commandName

```ts
protected commandName: Names
```

Which of the registered commands fired.

### core

```ts
readonly core: TCore
```

### dispatch

```ts
protected readonly dispatch: DispatchContext | undefined
```

### event

```ts
protected readonly event: Event
```

### logger

```ts
protected readonly logger: Logger
```

### routeId

```ts
protected readonly routeId: string
```

### sender

```ts
readonly sender: TSender
```

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

### target

```ts
protected target: Message<BooleanCache<Cache>>
```

## Methods

### buildSender

```ts
protected buildSender(
    event: Event,
    core: Core,
    routeId: string
): ReplySender
```

### defer

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

Show a "thinking" placeholder, then fill it later with [`edit`](/packages/gateway/0.4.1/classes/user-context-menu-handler#edit).

### delete

```ts
protected async delete(target?: TMessage): Promise<void>
```

Delete the initial reply or deferred placeholder. Pass a target to delete a message a prior send returned.

### edit

```ts
protected async edit(
    response: ReplyResponse<TNative> | string
): Promise<TMessage>
```

```ts
protected async edit(
    target: TMessage,
    response: ReplyResponse<TNative> | string
): Promise<TMessage>
```

Rewrite the initial reply or deferred placeholder. The targeted form rewrites a message a prior send returned.

### execute

```ts
abstract async execute(): Promise<void>
```

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.

### followUp

```ts
protected async followUp(
    response: ReplyResponse<TNative> | string,
    opts?: SendOpts
): Promise<TMessage>
```

Send a new message once the interaction is acknowledged.

### match

```ts
protected async match<Ret>(
    arms: MessageMenuArms<Names, Ret>
): Promise<Ret>
```

Run the arm for whichever command fired. Use this only when the handler is registered for several names.

Provide one arm per registered name, keyed by the name Discord shows in the right-click menu. Each arm receives the clicked message, narrowed to the cache state of that one command. The arms must cover every name in the generic. A missing name or an unknown key is a compile error.

### reply

```ts
protected async reply(
    response: ReplyResponse<TNative> | string,
    opts?: SendOpts
): Promise<TMessage>
```

Send the initial response, exactly once.

### send

```ts
protected async send(
    response: ReplyResponse<TNative> | string,
    opts?: SendOpts
): Promise<TMessage>
```

Routes to reply, followUp, or edit based on the current ack state.

### showModal

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

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).