Reaction

Emojis are widely used in real-time chats because they allow users to express their feelings in a direct and vivid way. In Agora Chat, "reactions" allow users to quickly react to a message using emojis in one-to-one chats and chat groups. In group chats, reactions can also be used to cast a vote, for example, by calculating the number of different emojis attached to the message.

The following illustration shows the implementation of adding a reaction to a message, how a conversation looks with reactions, and what retrieving a list of reactions (with related information) looks like.

This page shows how to use the Agora Chat SDK to implement reactions in your project.

Understand the tech

The SDK provides the following APIs to implement reaction functionalities:

• addReaction: Adds a reaction to the specified message.
• removeReaction: Removes the reaction from the specified message.
• getReactionList: Retrieves a list of reactions from the server.
• fetchReactionDetail: Retrieves the details of the reaction from the server.

Prerequisites

Before proceeding, ensure that your environment meets the following requirements:

• The project integrates a version of the Agora Chat SDK later than v3.9.3.1 and has implemented the basic real-time chat functionalities.
• You understand the API call frequency limit as described in Limitations.

Implementation

This section introduces how to implement reaction functionalities in your project.

Add a reaction

Call addReaction to add a reaction to the specified message. You can use onMessageReactionDidChange to listen for the state of adding the reaction.

// reaction: Reaction ID
// msgId: The message ID
// Adds a reaction to the specified message
ChatClient.getInstance()
  .chatManager.addReaction(reaction, msgId)
  .then((result) => {
    console.log("success: ", result);
  })
  .catch((error) => {
    console.log("fail: ", error);
  });

Remove a reaction

Call removeReaction to remove the specified reaction. You can also listen for the reaction change in onMessageReactionDidChange.

// reaction: Reaction ID
// msgId: The message ID
ChatClient.getInstance()
  .chatManager.removeReaction(reaction, msgId)
  .then((result) => {
    console.log("success: ", result);
  })
  .catch((error) => {
    console.log("fail: ", error);
  });

Retrieve a list of reactions

Call getReactionList to retrieve a list of reactions from the server. This method also returns the basic information of the reactions, including the content of the reaction, the number of users that added or removed the reaction, and a list of the first three user IDs that added or removed the reaction.

// msgId: The message ID
ChatClient.getInstance()
  .chatManager.getReactionList(msgId)
  .then((result) => {
    console.log("success: ", result);
  })
  .catch((error) => {
    console.log("fail: ", error);
  });

You can also use the reactionList member in ChatMessage to quickly retrieve the reactions of the specified message.

const msg = ChatMessage.createTextMessage(targetId, content);
msg.reactionList
  .then((result) => {
    console.log("success: ", result);
  })
  .catch((error) => {
    console.log("fail: ", error);
  });

Retrieve the details of the reaction

Call fetchReactionDetail to get the detailed information of the reaction from the server. The detailed information includes the reaction content, the number of users that added or removed the reaction, and the complete list of user IDs that added or removed the reaction.

// reaction: Reaction ID
// msgId: The message ID
// pageSize: The number of reactions returned for rach method call. The value range is [1,50]
// cursor: The index from which to get the reaction detail. Pass `null` or an empty string for the first method call.
ChatClient.getInstance()
  .chatManager.fetchReactionDetail(msgId, reaction, cursor, pageSize)
  .then((result) => {
    console.log("success: ", result);
  })
  .catch((error) => {
    console.log("fail: ", error);
  });

Listen for reaction status

Use onMessageReactionDidChange to listen for changes or status of the reaction.

// Listen for reaction updates
class ChatMessageEvent implements ChatMessageEventListener {
  onMessageReactionDidChange(_list: ChatMessageReactionEvent[]): void {
    throw new Error("Method not implemented.");
  }
  // Add other callbacks according to your business logic
}
// Adds the message status listener
const listener = new ChatMessageEvent();
ChatClient.getInstance().chatManager.addMessageListener(listener);
// Removes the listener
ChatClient.getInstance().chatManager.removeMessageListener(listener);
// Removes all listeners
ChatClient.getInstance().chatManager.removeAllMessageListener();