Class MessageCollector

The message collector for a channel.

Example

new MessageCollector(channel);

Hierarchy

Collector<Message>
- MessageCollector

Index

Constructors

constructor

new MessageCollector(channel: ChatChannel, options?: CollectorOptions<Message>): MessageCollector
Parameters
- channel: ChatChannel
  
  The channel the message collector belongs to.
- Optional options: CollectorOptions<Message>
  
  The options of the message collector.
Returns MessageCollector
Overrides Collector.constructor
- Defined in guilded.ts/src/collectors/MessageCollector.ts:15

Properties

`Readonly` channel

channel: ChatChannel

The channel the message collector belongs to.

`Readonly` client

client: Client

The client the collector belongs to.

`Readonly` collected

collected: Collection<string, Message>

The collected data.

`Readonly` createdAt

createdAt: Date

The date the collector was created.

`Optional` endedAt

endedAt?: Date

The date the collector was ended.

`Readonly` options

options: CollectorOptions<Message> = {}

The options of the collector.

Accessors

createdTimestamp

get createdTimestamp(): number
The timestamp the collector was created.

Returns number
Inherited from Collector.createdTimestamp
- Defined in guilded.ts/src/collectors/Collector.ts:36

endedTimestamp

get endedTimestamp(): undefined | number
The timestamp the collector was ended.

Returns undefined | number
Inherited from Collector.endedTimestamp
- Defined in guilded.ts/src/collectors/Collector.ts:46

isEnded

get isEnded(): boolean
Whether the collector has ended.

Returns boolean
Inherited from Collector.isEnded
- Defined in guilded.ts/src/collectors/Collector.ts:41

uptime

get uptime(): number
The time the collector has been running.

Returns number
Inherited from Collector.uptime
- Defined in guilded.ts/src/collectors/Collector.ts:51

Methods

collect

collect(item: Message): Promise<undefined | Message>
Collect a item.

Returns
The collected item.

Example
```
collector.collect(item);
```
Parameters
- item: Message
  
  The item to collect.
Returns Promise<undefined | Message>
Inherited from Collector.collect
- Defined in guilded.ts/src/collectors/Collector.ts:73

dispose

dispose(itemId: string): undefined | Message
Dispose a collected item.

Returns
The disposed item.

Example
```
collector.dispose('abc');
```
Parameters
- itemId: string
  
  The ID of the item to dispose.
Returns undefined | Message
Inherited from Collector.dispose
- Defined in guilded.ts/src/collectors/Collector.ts:92

emit

emit<Event>(event: Event, ...args: CollectorEvents<Message>[Event]): boolean
Type Parameters
- Event extends keyof CollectorEvents<Model>
Parameters
- event: Event
- Rest ...args: CollectorEvents<Message>[Event]
Returns boolean
Inherited from Collector.emit
- Defined in guilded.ts/src/collectors/Collector.ts:117

end

end(): void
End the collector.

Example
```
collector.end();
```
Returns void
Inherited from Collector.end
- Defined in guilded.ts/src/collectors/Collector.ts:61

Class MessageCollector

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

channel: ChatChannel

Optional options: CollectorOptions<Message>

Returns MessageCollector

Properties

Readonly channel

Readonly client

Readonly collected

Readonly createdAt

Optional endedAt

Readonly options

Accessors

createdTimestamp

Returns number

endedTimestamp

Returns undefined | number

isEnded

Returns boolean

uptime

Returns number

Methods

collect

Returns

Example

Parameters

item: Message

Returns Promise<undefined | Message>

dispose

Returns

Example

Parameters

itemId: string

Returns undefined | Message

emit

Type Parameters

Event extends keyof CollectorEvents<Model>

Parameters

event: Event

Rest ...args: CollectorEvents<Message>[Event]

Returns boolean

end

Example

Returns void

Settings

Member Visibility

Theme

`Optional` options: CollectorOptions<Message>

`Readonly` channel

`Readonly` client

`Readonly` collected

`Readonly` createdAt

`Optional` endedAt

`Readonly` options

`Rest` ...args: CollectorEvents<Message>[Event]