InteractionCollector

classe · Source

Collects interactions. Will automatically stop if the message (messageDelete or messageDeleteBulk), channel (channelDelete), or guild (guildDelete) 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

Constructor

new InteractionCollector(client: Client, options?: InteractionCollectorOptions)

Parameters

Name	Type	Description
client	Client	The client on which to collect interactions
options?	InteractionCollectorOptions	The options to apply to this collector Default: {}.

Properties

messageId

nullable

messageId: Snowflake

The message from which to collect interactions, if provided Source

channelId

nullable

channelId: Snowflake

The channel from which to collect interactions, if provided Source

guildId

nullable

guildId: Snowflake

The guild from which to collect interactions, if provided Source

interactionType

nullable

interactionType: InteractionType

The type of interaction to collect Source

componentType

nullable

componentType: MessageComponentType

The type of component to collect Source

users

users: Collection<Snowflake, User>

The users that have interacted with this collector Source

total

total: number

The total number of interactions collected Source

endReason

readonly · nullable

endReason: string

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

client

readonly

client: Client

The client that instantiated this Collector Source

filter

filter: CollectorFilter

The filter applied to this collector Source

options

options: CollectorOptions

The options of this collector Source

collected

collected: Collection

The items collected by this collector Source

ended

ended: boolean

Whether this collector has finished collecting Source

_timeout

nullable · private

_timeout: Timeout

Timeout for cleanup Source

_idletimeout

nullable · private

_idletimeout: Timeout

Timeout for cleanup due to inactivity Source

next

readonly

next: Promise

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

Methods

collect

private

collect(interaction: Interaction): Snowflake

Handles an incoming interaction for possible collection. Parameters

Name	Type	Description
interaction	Interaction	The interaction to possibly collect

Returns: SnowflakeSource

dispose

dispose(interaction: Interaction): Snowflake

Handles an interaction for possible disposal. Parameters

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

Returns: SnowflakeSource

empty

empty()

Empties this interaction collector. Source

_handleMessageDeletion

private

_handleMessageDeletion(message: Message): void

Handles checking if the message has been deleted, and if so, stops the collector with the reason 'messageDelete'. Parameters

Name	Type	Description
message	Message	The message that was deleted

Returns: voidSource

_handleChannelDeletion

private

_handleChannelDeletion(channel: GuildChannel): void

Handles checking if the channel has been deleted, and if so, stops the collector with the reason 'channelDelete'. Parameters

Name	Type	Description
channel	GuildChannel	The channel that was deleted

Returns: voidSource

_handleThreadDeletion

private

_handleThreadDeletion(thread: ThreadChannel): void

Handles checking if the thread has been deleted, and if so, stops the collector with the reason 'threadDelete'. Parameters

Name	Type	Description
thread	ThreadChannel	The thread that was deleted

Returns: voidSource

_handleGuildDeletion

private

_handleGuildDeletion(guild: Guild): void

Handles checking if the guild has been deleted, and if so, stops the collector with the reason 'guildDelete'. Parameters

Name	Type	Description
guild	Guild	The guild that was deleted

Returns: voidSource

handleCollect

async

async handleCollect(args: *): Promise<void>

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

Name	Type	Description
args	*	The arguments emitted by the listener

Returns: Promise<void>Source

handleDispose

async

async handleDispose(args: *): Promise<void>

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

Name	Type	Description
args	*	The arguments emitted by the listener

Returns: Promise<void>Source

stop

stop(reason?: string)

Stops this collector and emits the end event. Parameters

Name	Type	Description
reason?	string	The reason this collector is ending Default: 'user'.
Source

resetTimer

resetTimer(options?: CollectorResetTimerOptions)

Resets the collector's timeout and idle timer. Parameters

Name	Type	Description
options?	CollectorResetTimerOptions	Options for resetting
Source

checkEnd

checkEnd(): boolean

Checks whether the collector should end, and if so, ends it. Returns: boolean — Whether the collector ended or not Source

Events

collect

collect: unknown

Emitted whenever an interaction is collected. Parameters

Name	Type	Description
interaction	Interaction	The interaction that was collected
Source

dispose

dispose: unknown

Emitted whenever an interaction is disposed of. Parameters

Name	Type	Description
interaction	Interaction	The interaction that was disposed of
Source

end

end: unknown

Emitted when the collector is finished collecting. Parameters

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