Collects interactions. Will automatically stop if the message ( or ), channel (), or guild () is deleted. Interaction collectors that do not specify
idlemay be prone to always running. Ensure your interaction collectors end via either of these options or manual cancellation.
Emitted whenever an interaction is collected.
|interaction||BaseInteraction||No||The interaction that was collected|
Emitted whenever an interaction is disposed of.
|interaction||BaseInteraction||No||The interaction that was disposed of|
Emitted whenever an element is not collected by the collector.
|args||*||No||The arguments emitted by the listener|
The items collected by this collectorInherited from Collector
The reason this collector has ended with, or null if it hasn't ended yetInherited from Collector
The filter applied to this collectorInherited from Collector
The Date at which this collector last collected an itemInherited from Collector
The timestamp at which this collector last collected an itemInherited from Collector
The message interaction id from which to collect interactions, if provided
Returns a promise that resolves with the next collected element; rejects with collected elements if the collector finishes without receiving a next elementInherited from Collector
The options of this collector
The total number of interactions collected
Checks whether the collector should end, and if so, ends it.Inherited from Collector
ReturnsWhether the collector ended or not
Handles an incoming interaction for possible collection.
|interaction||Interaction||No||The interaction to possibly collect|
Handles an interaction for possible disposal.
|interaction||Interaction||No||The interaction that could be disposed of|
Empties this interaction collector.
Call this to handle an event as a collectable element. Accepts any event data as parameters.Inherited from Collector
Call this to remove an element from the collection. Accepts any event data as parameters.Inherited from Collector
Resets the collector's timeout and idle timer.Inherited from Collector
Stops this collector and emits theInherited from Collector