消息表情回复

表情符号被广泛用于实时聊天，允许用户以直接和生动的方式表达自己的感受。在即时通讯 IM 中，消息表情回复（下文统称 “Reaction”）允许用户在单聊和群聊中使用表情符号对消息进行快速回复。在群聊中，Reaction 也可用于投票，例如，计算对消息回复的各种表情符号的数量确认投票。

下图展示如何将 Reaction 添加到消息、添加了 Reaction 的会话以及获取 Reaction 列表（带有相关信息）。

本页介绍如何使用即时通讯 IM SDK 在项目中实现 Reaction 功能。

技术原理

即时通讯 IM SDK 支持你通过调用方法实现如下功能：

• 在消息上添加 Reaction；
• 删除消息的 Reaction；
• 获取消息的 Reaction 列表；
• 获取 Reaction 详情；
• 获取漫游消息中的 Reaction。

前提条件

开始前，请确保满足以下条件：

• 完成 SDK 初始化，详见 iOS 快速开始。
• 了解即时通讯 IM 的使用限制。

每个版本的套餐包都支持 Reaction 功能，因此在声网控制台中启用即时通讯 IM 会默认开启 Reaction 功能。

实现方法

在消息上添加 Reaction

调用 addReaction 方法在消息上添加 Reaction，在 messageReactionDidChange 监听事件中会收到该消息的最新 Reaction 概览。

示例代码如下：

// 添加 Reaction。
[AgoraChatClient.sharedClient.chatManager addReaction:"reaction" toMessage:"messageId" completion:^(AgoraChatError * _Nullable error) {
    refreshBlock(error, changeSelectedStateHandle);
}];

// 监听 Reaction 更新。
- (void)messageReactionDidChange:(NSArray<AgoraChatMessageReactionChange *> *)changes
{

}

删除消息的 Reaction

调用 removeReaction 方法删除指定消息的 Reaction，在 onReactionChange 监听事件中会收到该消息的最新 Reaction 概览。

示例代码如下：

// 删除 Reaction。
[AgoraChatClient.sharedClient.chatManager removeReaction:"reaction" fromMessage:"messageId" completion:^(AgoraChatError * _Nullable error) {
    refreshBlock(error, changeSelectedStateHandle);
}];

// 监听 Reaction 更新。
- (void)messageReactionDidChange:(NSArray<AgoraChatMessageReactionChange *> *)changes
{

}

获取消息的 Reaction 列表

调用 getReactionList 从服务器获取指定消息的 Reaction 概览列表，列表内容包含 Reaction 内容，添加或移除 Reaction 的用户数量，以及添加或移除 Reaction 的前三个用户的用户 ID。示例代码如下：

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

}];

获取 Reaction 详情

调用 getReactionDetail 可以从服务器获取指定 Reaction 的详情，包括 Reaction 内容，添加或移除 Reaction 的用户数量以及添加或移除 Reaction 的全部用户列表。示例代码如下：

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

}];

后续步骤

即时通讯 IM UIKit 也支持 Reaction 功能，其中包含更丰富的表情符号。你可以使用 UIKit 在项目中实现 Reaction 功能。