消息表情回复 Reaction iOS

更新时间:2022-06-14

消息表情回复(下文统称 “Reaction” )支持用户在单聊和群聊场景中对单条消息回复表情,从而丰富用户聊天互动方式。在群组中,Reaction 作为社交互动工具支持用户在沟通时直观地进行情绪表达。

注意:目前 Reaction 仅适用于单聊和群组。聊天室暂不支持 Reaction 功能。

SDK 支持你通过调用 API 在项目中实现如下功能:

  • addReaction 在消息上添加 Reaction;
  • removeReaction 删除消息的 Reaction;
  • getReactionList 获取消息的 Reaction 列表;
  • getReactionDetail 获取 Reaction 详情;
  • EMChatMessage.reactionListEMChatMessage 对象获取 Reaction 列表。

Reaction 场景示例如下:

分别展示如何添加 Reaction,群聊中 Reaction 的效果,以及查看 Reaction 列表。

开始前,请确保满足以下条件:

  1. 完成 HyphenateChat 3.9.2.1 以上版本 SDK 初始化,详见 快速开始
  2. 了解环信即时通讯 IM API使用限制
  3. 已联系商务开通 Reaction 功能。

在消息上添加 Reaction

调用 addReaction 在消息上添加 Reaction,在 messageReactionDidChange 监听事件中会收到这条消息的最新 Reaction 概览。

示例代码如下:

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

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

}

删除消息的 Reaction

调用 removeReaction 删除消息的 Reaction,在 onReactionChange 监听事件中会收到这条消息的最新 Reaction 概览。

示例代码如下:

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

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

}

获取消息的 Reaction 列表

调用 getReactionList 从服务器获取指定消息的 Reaction 概览列表,列表内容包含 Reaction 内容,用户数量,用户列表(概要数据,即前三个用户信息)。示例代码如下:

[EMClient.sharedClient.chatManager getReactionList:@["messageId"] groupId:@"groupId" chatType:EMChatTypeChat completion:^(NSDictionary<NSString *, EMMessageReaction *> * _Nonnull, EMError * _Nullable) {
                    
}];

获取 Reaction 详情

调用 getReactionDetail 可以从服务器获取指定 Reaction 的详情,包括 Reaction 内容,用户数量和全部用户列表。示例代码如下:

[EMClient.sharedClient.chatManager getReactionDetail:@"messageId" reaction:@"reaction" cursor:nil pageSize:30 completion:^(EMMessageReaction * _Nonnull, NSString * _Nullable cursor, EMError * _Nullable) {
            
}];