Interfaceseedcordv0.13.0

InteractionGateContext

The interaction arm. RepliableRepliable is the interaction type the gate supports, inferred from the ctxctx annotation, so a gate reading button-specific fields is rejected on a slash handler. interactioninteraction is the reply target, so useruser is always present. Use NonModalInteractionNonModalInteraction to exclude ModalSubmit when the gate needs a reliable caller member or channel.

interface InteractionGateContext<
    Repliable extends Repliables = Repliables
> extends GateContextBase

interface InteractionGateContext<
    Repliable extends Repliables = Repliables
> extends GateContextBase

import type { ButtonInteraction } from 'discord.js';

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

import type { ButtonInteraction } from 'discord.js';

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

Repliable

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

Repliable extends Repliables = Repliables

Repliable extends Repliables = Repliables

channelId

The channel id, or null when the source carries none.

readonly channelId: string | null

readonly channelId: string | null

Inherited from:GateContextBase

core

The running framework, for reaching the bot, config, the rate limiter, and the bus.

readonly core: Core

readonly core: Core

Inherited from:GateContextBase

guild

The guild the action happened in, or null in a DM or a guildless event.

readonly guild: Guild | null

readonly guild: Guild | null

Inherited from:GateContextBase

guildId

The guild id, or null outside a guild.

readonly guildId: string | null

readonly guildId: string | null

Inherited from:GateContextBase

interaction

The interaction being handled, which is the reply target.

readonly interaction: Repliable

readonly interaction: Repliable

kind

Marks the interaction arm, narrow on it before reading interactioninteraction.

readonly kind: 'interaction'

readonly kind: 'interaction'

member

The acting member, or null outside a guild or when uncached.

readonly member: GuildMember | null

readonly member: GuildMember | null

Inherited from:GateContextBase

user

The invoking user, always present on an interaction.

readonly user: User

readonly user: User

Interfaceseedcordv0.13.0

InteractionGateContext

interface InteractionGateContext<
    Repliable extends Repliables = Repliables
> extends GateContextBase

interface InteractionGateContext<
    Repliable extends Repliables = Repliables
> extends GateContextBase

import type { ButtonInteraction } from 'discord.js';

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

import type { ButtonInteraction } from 'discord.js';

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

Properties

channelId
core
guild
guildId
interaction
kind
member
user

Repliable

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

Repliable extends Repliables = Repliables

Repliable extends Repliables = Repliables

channelId

The channel id, or null when the source carries none.

readonly channelId: string | null

readonly channelId: string | null

Inherited from:GateContextBase

core

The running framework, for reaching the bot, config, the rate limiter, and the bus.

readonly core: Core

readonly core: Core

Inherited from:GateContextBase

guild

The guild the action happened in, or null in a DM or a guildless event.

readonly guild: Guild | null

readonly guild: Guild | null

Inherited from:GateContextBase

guildId

The guild id, or null outside a guild.

readonly guildId: string | null

readonly guildId: string | null

Inherited from:GateContextBase

interaction

The interaction being handled, which is the reply target.

readonly interaction: Repliable

readonly interaction: Repliable

kind

Marks the interaction arm, narrow on it before reading interactioninteraction.

readonly kind: 'interaction'

readonly kind: 'interaction'

member

The acting member, or null outside a guild or when uncached.

readonly member: GuildMember | null

readonly member: GuildMember | null

Inherited from:GateContextBase

user

The invoking user, always present on an interaction.

readonly user: User

readonly user: User