Reaction

Updated

Show the implementation of adding a reaction to a message.

Emojis are widely used in real-time chats because they allow users to express their feelings in a direct and vivid way. In 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.

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.
  • getReactionDetail: Retrieves the details of the reaction from the server.
  • AgoraChatMessage.reactionlist: Retrieves a list of reactions from the AgoraChatMessage objects in the local database.

Prerequisites

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

The reaction feature is supported by all types of Pricing Plans and is enabled by default once you have enabled Chat in Agora Console.

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. In a one-to-one conversation, the peer user receives the messageReactionDidChange event. In a group conversation, other group members than the operator receive this event. This event contains the conversation ID, message ID, reaction list of the message, and reaction operation list (reaction ID, user ID of the user that adds the reaction, and the addition operation).

For a reaction, a user can add only once, or the error 1301 is reported for repeated addition.

// Add a reaction
[AgoraChatClient.sharedClient.chatManager addReaction:"reaction" toMessage:"messageId" completion:^(AgoraChatError * _Nullable error) {
  refreshBlock(error, changeSelectedStateHandle);
}];
// Listen for the state of the reaction.
- (void)messageReactionDidChange:(NSArray *)changes
{

}

Remove a reaction

Call removeReaction to remove the specified reaction. In a one-to-one conversation, the peer user receives the messageReactionDidChange event. In a group conversation, other group members than the operator receive this event. This event contains the conversation ID, message ID, reaction list of the message, and reaction operation list (ID of the removed reaction, user ID of the user that removes the reaction, and the removal operation).

// Remove the reaction.
[AgoraChatClient.sharedClient.chatManager removeReaction:"reaction" fromMessage:"messageId" completion:^(AgoraChatError * _Nullable error) {
  refreshBlock(error, changeSelectedStateHandle);
}];
// Listen for reaction state change.
- (void)messageReactionDidChange:(NSArray *)changes
{

}

Retrieve a list of reactions

Call getReactionList to retrieve a list of reactions of messages 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.

[AgoraChatClient.sharedClient.chatManager getReactionList:@["messageId"] groupId:@"groupId" chatType:AgoraChatTypeChat completion:^(NSDictionary * _Nonnull, AgoraChatError * _Nullable) {

}];

Retrieve the details of the reaction

Call getReactionDetail 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.

[AgoraChatClient.sharedClient.chatManager getReactionDetail:@"messageId" reaction:@"reaction" cursor:nil pageSize:30 completion:^(AgoraChatMessageReaction * _Nonnull, NSString * _Nullable cursor, AgoraChatError * _Nullable) {

}];

Next steps

Reactions are also supported in the Chat UIKit, which contains a wider range of emojis. You can also use the Chat SDK to implement reactions in your project.