Class MessageReactionCollector

The reaction collector for a message.

Example

new MessageReactionCollector(message);

Hierarchy

Constructors

constructor

Properties

client collected createdAt endedAt? message options

Accessors

createdTimestamp endedTimestamp isEnded uptime

Methods

collect dispose emit end

Constructors

constructor

Properties

Readonly client

client: Client

Readonly collected

collected: Collection<number, MessageReaction>

The collected data.

Readonly createdAt

createdAt: Date

The date the collector was created.

Optional endedAt

endedAt?: Date

The date the collector was ended.

Readonly message

message: Message

Readonly options

options: CollectorOptions<MessageReaction>

Accessors

createdTimestamp

  • get createdTimestamp(): number

  • The timestamp the collector was created.

    Returns number

endedTimestamp

  • get endedTimestamp(): undefined | number

  • The timestamp the collector was ended.

    Returns undefined | number

isEnded

  • get isEnded(): boolean

  • Whether the collector has ended.

    Returns boolean

uptime

  • get uptime(): number

  • The time the collector has been running.

    Returns number

Methods

collect

dispose

  • Dispose a collected item.

    Returns

    The disposed item.

    Example

    collector.dispose('abc');

    Parameters

    • itemId: number

      The ID of the item to dispose.

    Returns undefined | MessageReaction

emit

end

  • End the collector.

    Example

    collector.end();

    Returns void

Settings

Member Visibility

Theme