discord.js | InteractionCollector

Search...

InteractionCollector

export class InteractionCollector<T extends CollectedInteraction> extends Collector<
  Snowflake,
  T,
  [Collection<Snowflake, T>]
>

export class InteractionCollector<T extends CollectedInteraction> extends Collector<
  Snowflake,
  T,
  [Collection<Snowflake, T>]
>

Collects interactions. Will automatically stop if the message ( or ), channel (), or guild () is deleted. Interaction collectors that do not specify time or idle may be prone to always running. Ensure your interaction collectors end via either of these options or manual cancellation.

Extends

Collector<Snowflake, T, [Collection<Snowflake, T>]>

Name	Constraints	Optional	Default	Description
T	CollectedInteraction	No		None

constructor(client, options?)

Name	Type	Optional	Description
client	Client<true>	No	None
options	InteractionCollectorOptions<T>	Yes	None

collect(interaction)

Emitted whenever an interaction is collected.

Name	Type	Optional	Description
interaction	BaseInteraction	No	The interaction that was collected

dispose(interaction)

Emitted whenever an interaction is disposed of.

Name	Type	Optional	Description
interaction	BaseInteraction	No	The interaction that was disposed of

end(collected, reason)

Emitted when the collector is finished collecting.

Name	Type	Optional	Description
collected	Collection	No	The elements collected by the collector
reason	string	No	The reason the collector ended

ignore(args)

Emitted whenever an element is not collected by the collector.

Name	Type	Optional	Description
args	*	No	The arguments emitted by the listener

channelId:Snowflake | null

The channel from which to collect interactions, if provided

Readonly

client:Client

The client that instantiated this Collector

Inherited from Collector

collected:Collection<K, V>

The items collected by this collector

Inherited from Collector

componentType:ComponentType | null

The type of component to collect

ended:boolean

Whether this collector has finished collecting

Inherited from Collector

Readonly

endReason:string | null

The reason this collector has ended with, or null if it hasn't ended yet

Inherited from Collector

filter:CollectorFilter<[V, ...F]>

The filter applied to this collector

Inherited from Collector

guildId:Snowflake | null

The guild from which to collect interactions, if provided

interactionType:InteractionType | null

The type of interaction to collect

Readonly

lastCollectedAt:Date | null

The Date at which this collector last collected an item

Inherited from Collector

lastCollectedTimestamp:number | null

The timestamp at which this collector last collected an item

Inherited from Collector

Protected

listener:(...args: any[]) => void

Inherited from Collector

messageId:Snowflake | null

The message from which to collect interactions, if provided

messageInteractionId:Snowflake | null

The message interaction id from which to collect interactions, if provided

Readonly

next:Promise<V>

Returns a promise that resolves with the next collected element; rejects with collected elements if the collector finishes without receiving a next element

Inherited from Collector

options:InteractionCollectorOptions<T>

The options of this collector

total:number

The total number of interactions collected

users:Collection<Snowflake, User>

The users that have interacted with this collector

[Symbol.asyncIterator]():AsyncIterableIterator<[V, ...F]>

checkEnd():boolean

Checks whether the collector should end, and if so, ends it.

Returns

Whether the collector ended or not

Inherited from Collector

collect(interaction):Snowflake

Handles an incoming interaction for possible collection.

Returns

Name	Type	Optional	Description
interaction	Interaction	No	The interaction to possibly collect

dispose(interaction):Snowflake

Handles an interaction for possible disposal.

Returns

Name	Type	Optional	Description
interaction	Interaction	No	The interaction that could be disposed of

empty():void

Empties this interaction collector.

handleCollect(...args):Promise<void>

Call this to handle an event as a collectable element. Accepts any event data as parameters.

Name	Type	Optional	Description
...args	unknown[]	No	The arguments emitted by the listener

Inherited from Collector

handleDispose(...args):Promise<void>

Call this to remove an element from the collection. Accepts any event data as parameters.

Name	Type	Optional	Description
...args	unknown[]	No	The arguments emitted by the listener

Inherited from Collector

on(event, listener):this

Name	Type	Optional	Description
event	'collect' \| 'dispose' \| 'ignore'	No	None
listener	(interaction: T) => Awaitable<void>	No	None

once(event, listener):this

Name	Type	Optional	Description
event	'collect' \| 'dispose' \| 'ignore'	No	None
listener	(interaction: T) => Awaitable<void>	No	None

resetTimer(options?):void

Resets the collector's timeout and idle timer.

Name	Type	Optional	Description
options	CollectorResetTimerOptions	Yes	Options for resetting

Inherited from Collector

stop(reason?):void

Stops this collector and emits the end event.

Name	Type	Optional	Description
reason	string	Yes	The reason this collector is ending

Inherited from Collector

toJSON():unknown