SHARDWIRE
ReferenceEvent & Data Models

EventSubscriptionFilter

Reference for `EventSubscriptionFilter`, exported as part of the public Shardwire surface.

interface exported from src/discord/types.ts.

Summary

Reference for EventSubscriptionFilter, exported as part of the public Shardwire surface.

Signature

export interface EventSubscriptionFilter {
	guildId?: Snowflake | readonly Snowflake[];
	channelId?: Snowflake | readonly Snowflake[];
	userId?: Snowflake | readonly Snowflake[];
	messageId?: Snowflake | readonly Snowflake[];
	interactionId?: Snowflake | readonly Snowflake[];
	commandName?: string | readonly string[];
	/** Matches `BridgeInteraction.customId` when present (components, modals). */
	customId?: string | readonly string[];
	/** Matches `BridgeInteraction.kind`. */
	interactionKind?: BridgeInteractionKind | readonly BridgeInteractionKind[];
	/** Matches reaction emoji by identifier/name/string form where available. */
	emoji?: string | readonly string[];
	/** Matches Discord `ChannelType` when present on the payload (messages, interactions, bulk delete). */
	channelType?: number | readonly number[];
	/** Matches `BridgeMessage.parentChannelId` / thread parent / channel parent when present. */
	parentChannelId?: Snowflake | readonly Snowflake[];
	/** Matches guild thread channels only: same as message `channelId` when `channelType` is a guild thread. */
	threadId?: Snowflake | readonly Snowflake[];
	/** Matches the active voice channel id for `voiceStateUpdate` payloads when present. */
	voiceChannelId?: Snowflake | readonly Snowflake[];
}

Structure

On this page