Interfacehttpv0.1.0-next.0

InteractionGateContext

The interaction gate context on the HTTP transport. It extends the scalar GateContextBaseGateContextBase with the raw interaction payload and the user and member the payload carries. RepliableRepliable narrows which handlers a gate attaches to, inferred from the ctxctx annotation, so a gate reading button fields is rejected on a slash handler.

The http transport delivers no role-derived permission sets, so memberGuildPermissionsmemberGuildPermissions and appGuildPermissionsappGuildPermissions are absent. A gate requiring GuildPermissionsContextGuildPermissionsContext (a permission gate with in: 'guild'in: 'guild') is a compile error on an http handler.

interface InteractionGateContext<
    Repliable extends Repliables = Repliables
> extends GateContextBase

interface InteractionGateContext<
    Repliable extends Repliables = Repliables
> extends GateContextBase

import type { APIMessageComponentButtonInteraction } from 'discord-api-types/v10';

// a button-only gate: the Repliable generic narrows which handlers accept it
const ButtonGate = defineGate('btn', (ctx: InteractionGateContext<APIMessageComponentButtonInteraction>) => {
    void ctx.interaction; // APIMessageComponentButtonInteraction
});

import type { APIMessageComponentButtonInteraction } from 'discord-api-types/v10';

// a button-only gate: the Repliable generic narrows which handlers accept it
const ButtonGate = defineGate('btn', (ctx: InteractionGateContext<APIMessageComponentButtonInteraction>) => {
    void ctx.interaction; // APIMessageComponentButtonInteraction
});

Repliable

The interaction type the gate reads, narrowing which handlers accept it.

Repliable extends Repliables = Repliables

Repliable extends Repliables = Repliables

core

readonly core: Core

readonly core: Core

interaction

The raw interaction payload, which is the reply target.

readonly interaction: Repliable

readonly interaction: Repliable

kind

Narrow on this before reading interactioninteraction.

readonly kind: 'interaction'

readonly kind: 'interaction'

member

The invoking member, or null in a DM.

readonly member: APIInteractionGuildMember | null

readonly member: APIInteractionGuildMember | null

user

Every repliable interaction contains a user, so this is never null.

readonly user: APIUser

readonly user: APIUser