消息-管理子区消息

更新时间:2022-08-10

子区消息消息类型属于群聊消息类型,与普通群组消息的区别是需要添加 isChatThread 标记。本文介绍 即时通讯 IM React Native SDK 如何发送、接收以及撤回子区消息。

即时通讯 IM React Native SDK 提供 ChatManagerChatMessageChatMessageThread 类,用于管理子区消息,支持你通过调用 API 在项目中实现如下功能:

  • 发送子区消息
  • 接收子区消息
  • 撤回子区消息
  • 获取子区消息

img

如上图所示,消息收发流程如下:

  1. 用户 A 发送一条消息到消息服务器;
  2. 对于子区消息,服务器投递给子区内其他每一个成员;
  3. 用户收到消息。

子区创建和查看如下图:

img

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

  • 已集成 1.0.5 及以上版本 SDK 的基本功能,完成 SDK 初始化,详见 快速开始SDK 集成概述
  • 了解即时通讯 IM 的使用限制,详见 使用限制
  • 联系商务开通子区功能。

本节介绍如何使用即时通讯 IM React Native SDK 提供的 API 实现上述功能。

发送子区消息

发送子区消息和发送群组消息的方法基本一致,详情请参考 发送消息。唯一不同的是,发送子区消息需要指定标记 isChatThreadtrue

示例代码如下:

// targetId: 消息接收对象 ID
// content: 文本消息内容
// chatType: 会话类型
// isChatThread: 是否是子区消息,这里设置为 `true`,即是子区消息
ChatMessage message = ChatMessage.createTextMessage(targetId, content, chatType, {isChatThread});
// 发送消息时可以设置回调,接收消息的发送状态和结果
// 详见 [2.4.6.2](./2.4.6.2messages_RN)
const callback = new ChatMessageCallback();
// 发送消息。
ChatClient.getInstance()
  .chatManager.sendMessage(message, callback)
  .then(() => {
    // 消息发送动作完成,会在这里打印日志。
    // 消息的发送结果通过回调返回
    console.log("send message operation success.");
  })
  .catch((reason) => {
    // 消息发送动作失败,会在这里打印日志。
    console.log("send message operation fail.", reason);
  });

接收子区消息

接收消息的具体逻辑,请参考接收消息,此处只介绍子区消息和其他消息的区别。

子区有新增消息时,子区所属群组的所有成员收到 ChatMessageEventListener#onChatMessageThreadUpdated 回调,子区成员收到 ChatMessageEventListener#onMessagesReceived 回调。

示例代码如下:

// 继承并实现 `ChatMessageEventListener`
class ChatMessageEvent implements ChatMessageEventListener {
  onMessagesReceived(messages: ChatMessage[]): void {
    console.log(`onMessagesReceived: `, messages);
  }
  onChatMessageThreadUpdated(msgThread: ChatMessageThreadEvent): void {
    console.log(`onChatMessageThreadUpdated: `, msgThread);
  }
  // 其他回调接收省略,实际开发需添加
}

// 注册监听器
const listener = new ChatMessageEvent();
ChatClient.getInstance().chatManager.addMessageListener(listener);

// 移除监听器
ChatClient.getInstance().chatManager.removeMessageListener(listener);

// 移除所有监听器。
ChatClient.getInstance().chatManager.removeAllMessageListener();

撤回子区消息

接收消息的具体逻辑,请参考撤回消息,此处只介绍子区消息和其他消息的区别。

子区有消息撤回时,子区所属群组的所有成员收到 ChatMessageEventListener#onChatMessageThreadUpdated 回调,子区成员收到 ChatMessageEventListener#onMessagesRecalled 回调。

示例代码如下:

// 继承并实现 `ChatMessageEventListener`
class ChatMessageEvent implements ChatMessageEventListener {
  onMessagesRecalled(messages: ChatMessage[]): void {
    console.log(`onMessagesRecalled: `, messages);
  }
  onChatMessageThreadUpdated(msgThread: ChatMessageThreadEvent): void {
    console.log(`onChatMessageThreadUpdated: `, msgThread);
  }
  // 其他回调接收省略,实际开发中需添加
}

从服务器获取子区消息 (消息漫游)

从服务器获取子区消息,请参考 从服务器获取消息 (消息漫游)