Interface MessagesReactions

Add, delete, and subscribe to message reactions.

interface MessagesReactions {
    delete(
        messageSerial: Serial,
        params?: DeleteMessageReactionParams,
    ): Promise<void>;
    send(
        messageSerial: Serial,
        params: AddMessageReactionParams,
    ): Promise<void>;
    subscribe(listener: MessageReactionListener): Subscription;
    subscribeRaw(listener: MessageRawReactionListener): Subscription;
}

Index

Methods

delete send subscribe subscribeRaw

Methods

delete

delete(
messageSerial: Serial,
params?: DeleteMessageReactionParams,
): Promise<void>
Delete a message reaction
Parameters
- messageSerial: Serial
  The serial of the message to remove the reaction from.
- Optionalparams: DeleteMessageReactionParams
  The type of reaction annotation and the specific reaction to remove. The reaction to remove is required for all types except MessageReactionType.Unique.
Returns Promise<void>
A promise that resolves when the reaction is deleted.
- Defined in src/core/messages-reactions.ts:93

send

send(messageSerial: Serial, params: AddMessageReactionParams): Promise<void>
Add a message reactions
Parameters
- messageSerial: Serial
  The serial of the message to react to
- params: AddMessageReactionParams
  Describe the reaction to add.
Returns Promise<void>
A promise that resolves when the reaction is added.
- Defined in src/core/messages-reactions.ts:85

subscribe(listener: MessageReactionListener): Subscription
Subscribe to message reaction summaries. Use this to keep message reaction counts up to date efficiently in the UI.
Parameters
- listener: MessageReactionListener
  The listener to call when a message reaction summary is received.
Returns Subscription
A subscription object that should be used to unsubscribe.
- Defined in src/core/messages-reactions.ts:101

subscribeRaw

subscribeRaw(listener: MessageRawReactionListener): Subscription
Subscribe to individual reaction events.
Parameters
- listener: MessageRawReactionListener
  The listener to call when a message reaction event is received.
Returns Subscription
A subscription object that should be used to unsubscribe.

Remarks
If you only need to keep track of reaction counts and clients, use subscribe instead.
- Defined in src/core/messages-reactions.ts:110