Preview environment

interface InteractionCollectorOptions

export interface InteractionCollectorOptions<Interaction extends CollectedInteraction, Cached extends CacheType = CacheType,> extends CollectorOptions<[Interaction, Collection<Snowflake, Interaction>]>

Type Parameters

Interaction extends CollectedInteraction

optional
Cached? extends CacheType = CacheType

optional
channel? : TextBasedChannelResolvable

The channel to listen to interactions from

optional
componentType? : ComponentType

The type of component to listen for

optional
dispose? : boolean

Whether to dispose data when it's deleted

Inherited from: CollectorOptions

optional
filter? : CollectorFilter<FilterArguments>

The filter applied to this collector

Inherited from: CollectorOptions

optional
guild? : GuildResolvable

The guild to listen to interactions from

optional
idle? : number

How long to stop the collector after inactivity in milliseconds

Inherited from: CollectorOptions

optional
interactionResponse? : InteractionResponse<BooleanCache<Cached>>

The interaction response to listen to message component interactions from

optional
interactionType? : InteractionType

The type of interaction to listen for

optional
max? : number

The maximum total amount of interactions to collect

optional
maxComponents? : number

The maximum number of components to collect

optional
maxUsers? : number

The maximum number of users to interact

optional
message? : CacheTypeReducer<Cached, Message, APIMessage>

The message to listen to interactions from

optional
time? : number

How long to run the collector for in milliseconds

Inherited from: CollectorOptions