Class GlobalReactionManager

A class representing a global reaction manager that extends the CacheableStructManager class.

Hierarchy

CacheableStructManager<string, MessageReaction>
- GlobalReactionManager

Index

Constructors

Properties

Accessors

shouldCacheReaction

Methods

awaitReactions create delete

Constructors

constructor

new GlobalReactionManager(client): GlobalReactionManager
Parameters
- client: Client
Returns GlobalReactionManager
Inherited from CacheableStructManager.constructor
- Defined in guilded.js/lib/managers/global/GlobalManager.ts:7

Properties

cache

cache: Collection<string, MessageReaction> = ...

`Readonly` client

client: Client

Accessors

shouldCacheReaction

get shouldCacheReaction(): boolean
Returns boolean
- Defined in guilded.js/lib/managers/global/ReactionManager.ts:10

Methods

awaitReactions

awaitReactions(messageId, options): Promise<CollectorReturnValue<MessageReaction>>
Wait & collect reactions on a message.

Example
```
const reactions = await client.reactions.awaitReactions('message-id-here', { max: 4, time: 60_000 });
```
Parameters
- messageId: string
  
  ID of the message to listen for reactions on
- options: CollectorOptions<MessageReaction>
  
  Configuration for the collector
Returns Promise<CollectorReturnValue<MessageReaction>>
A Promise that resolves with a collection of reactions collected, with the ID as the key and the reaction as the value
- Defined in guilded.js/lib/managers/global/ReactionManager.ts:56

create

create(channelId, messageId, emoteId): Promise<void>
Adds a reaction emote to a message.
Parameters
- channelId: string
  
  The ID of the channel where the message was sent.
- messageId: string
  
  The ID of the message.
- emoteId: number
  
  The ID of the emote to add.
Returns Promise<void>
A Promise that resolves with no value upon successful completion.
- Defined in guilded.js/lib/managers/global/ReactionManager.ts:22

delete

delete(channelId, messageId, emoteId, userId?): Promise<void>
Deletes either a whole reaction emote from a message or a specific user's if a userId is provided.
Parameters
- channelId: string
  
  The ID of the channel where the message was sent.
- messageId: string
  
  The ID of the message.
- emoteId: number
  
  The ID of the emote to delete.
- Optional userId: string
Returns Promise<void>
A Promise that resolves with no value upon successful completion.
- Defined in guilded.js/lib/managers/global/ReactionManager.ts:38

Generated using TypeDoc