管理子区
管理子区
子区是群组成员的子集,是支持多人沟通的即时通讯系统,子区让用户能够在群组中的特定消息上创建单独的会话,以保持主聊天界面整洁。
本文介绍如何使用环信即时通讯 IM Flutter SDK 在实时互动 app 中创建和管理子区,并实现子区相关功能。
技术原理
环信即时通讯 IM Flutter SDK 提供 EMChatThreadManager
、EMChatThread
、EMChatThreadEventHandler
和 EMChatThreadEvent
类,用于管理子区,支持你通过调用 API 在项目中实现如下功能:
- 创建、解散子区
- 加入、退出子区
- 子区踢人
- 修改子区名称
- 获取子区详情
- 获取子区成员列表
- 获取子区列表
- 批量获取子区中的最新消息
- 监听子区事件
前提条件
开始前,请确保满足以下条件:
实现方法
本节介绍如何使用环信即时通讯 IM Flutter SDK 提供的 API 实现上述功能。
创建子区
所有群成员均可以调用 EMChatThreadManager#createChatThread
方法,基于一条群组消息新建子区。
单设备登录时,子区所属群组的所有成员均会收到 EMChatThreadEventHandler#onChatThreadCreate
事件;多设备登录时,其他设备会同时收到 EMMultiDeviceEventHandler#onChatThreadEvent
事件,回调事件为 EMMultiDevicesEvent#CHAT_THREAD_CREATE
。
示例代码如下:
// name: 即将创建的子区的名字
// messageId: 子区的父消息 ID
// parentId: 子区的父节点,通常是群组 ID
try {
EMChatThread chatThread =
await EMClient.getInstance.chatThreadManager.createChatThread(
name: name,
messageId: messageId,
parentId: parentId,
);
} on EMError catch (e) {
}
解散子区
仅子区所在群组的群主和群管理员可以调用 EMChatThreadManager#destroyChatThread
方法解散子区。
单设备登录时,子区所属群组的所有成员均会收到 EMChatThreadEventHandler#onChatThreadDestroy
事件;多设备登录时,其他设备会同时收到 EMMultiDeviceEventHandler#onChatThreadEvent
事件,回调事件为 EMMultiDevicesEvent#CHAT_THREAD_DESTROY
。
提示
解散子区或解散子区所在的群组后,将删除本地数据库及内存中关于该子区的全部数据,需谨慎操作。
示例代码如下:
// chatThreadId: 子区 ID
// 执行子区销毁,请谨慎使用。
try {
await EMClient.getInstance.chatThreadManager.destroyChatThread(
chatThreadId: chatThreadId,
);
} on EMError catch (e) {
}
加入子区
子区所在群组的所有成员均可以调用 EMChatThreadManager#joinChatThread
方法加入群组,
加入子区的具体步骤如下:
- 收到
EMChatThreadManagerEventHandler#onChatThreadCreate
事件或EMChatThreadManagerEventHandler#onChatThreadUpdate
事件,或调用fetchChatThreadWithParentId
方法从服务器获取指定群组的子区列表,从中获取到想要加入的子区 ID。 - 调用
joinChatThread
传入子区 ID 加入对应子区。
多设备登录时,其他设备会同时收到 EMMultiDeviceEventHandler#onChatThreadEvent
事件,回调事件为 EMMultiDevicesEvent#CHAT_THREAD_JOIN
。
示例代码如下:
// chatThreadId: 子区 ID
try {
EMChatThread chatThead =
await EMClient.getInstance.chatThreadManager.joinChatThread(
chatThreadId: chatThreadId,
);
} on EMError catch (e) {
}
退出子区
子区成员均可以主动调用 EMChatThreadManager#leaveChatThread
方法退出子区,退出子区后,该成员将不会再收到子区消息。
多设备登录时,其他设备会同时收到 EMMultiDeviceEventHandler#onThreadEvent
事件,回调事件为 EMMultiDevicesEvent#CHAT_THREAD_LEAVE
。
示例代码如下:
// chatThreadId: 子区 ID
try {
await EMClient.getInstance.chatThreadManager.leaveChatThread(
chatThreadId: chatThreadId,
);
} on EMError catch (e) {
}
从子区移出成员
仅群主和群管理员可以调用 EMChatThreadManager#removeMemberFromChatThread
方法将指定成员 (群管理员或普通成员) 踢出子区,被踢出子区的成员将不再接收到子区消息。
被踢出子区的成员会收到 EMChatThreadEventHandler#onUserKickOutOfChatThread
事件;多设备登录时,执行踢人操作的成员的其他设备会同时收到 EMMultiDeviceEventHandler#onThreadEvent
事件,回调事件为 EMMultiDevicesEvent#CHAT_THREAD_KICK
。
示例代码如下:
// chatThreadId: 子区 ID
// memberId: 子区成员的用户 ID
try {
await EMClient.getInstance.chatThreadManager.removeMemberFromChatThread(
memberId: memberId,
chatThreadId: chatThreadId,
);
} on EMError catch (e) {
}
修改子区名称
仅群主和群管理员以及子区的创建者可以调用 EMChatThreadManager#updateChatThreadName
方法修改子区名称。
单设备登录时,子区所属群组的所有成员会收到 EMChatThreadManagerEventHandler#onChatThreadUpdate
事件;多设备登录时,其他设备会同时收到 EMMultiDeviceEventHandler#onThreadEvent
事件,回调事件为 EMMultiDevicesEvent#CHAT_THREAD_UPDATE
。
示例代码如下:
// chatThreadId: 子区 ID
// name: 修改的子区名称,长度不超过 64 个字符
try {
await EMClient.getInstance.chatThreadManager.updateChatThreadName(
newName: name,
chatThreadId: chatThreadId,
);
} on EMError catch (e) {
}
获取子区详情
子区所属群组的所有成员均可以调用 EMChatThreadManager#fetchChatThread
从服务器获取子区详情。
示例代码如下:
// chatThreadId: 子区 ID
try {
EMChatThread? chatThread =
await EMClient.getInstance.chatThreadManager.fetchChatThread(
chatThreadId: chatThreadId,
);
} on EMError catch (e) {
}
获取子区成员列表
子区所属群组的所有成员均可以调用 EMChatThreadManager#fetchChatThreadMember
方法从服务器分页获取子区成员列表。
// chatThreadId: 子区 ID
// limit: 单次请求返回的成员数,取值范围为 [1, 50]
// cursor: 开始获取数据的游标位置,首次调用方法时传 `null` 或空字符串
try {
List<String> members =
await EMClient.getInstance.chatThreadManager.fetchChatThreadMember(
chatThreadId: chatThreadId,
limit: limit,
cursor: cursor,
);
} on EMError catch (e) {
}
获取子区列表
- 用户可以调用
EMChatThreadManager#fetchJoinedChatThreads
方法从服务器分页获取自己加入和创建的子区列表:
// limit: 单次请求返回的子区数,取值范围为 [1, 50]
// cursor: 开始获取数据的游标位置,首次调用方法时传 `null` 或空字符串
try {
EMCursorResult<EMChatThread> chatThreads =
await EMClient.getInstance.chatThreadManager.fetchJoinedChatThreads(
limit: limit,
cursor: cursor,
);
} on EMError catch (e) {
}
- 用户可以调用
EMChatThreadManager#fetchChatThreadsWithParentId
方法从服务器分页获取指定群组的子区列表:
// parentId: 群组 ID
// limit: 单次请求返回的子区数,取值范围为 [1, 50]
// cursor: 开始获取数据的游标位置,首次调用方法时传 `null` 或空字符串
try {
EMCursorResult<EMChatThread> chatThreads = await EMClient
.getInstance.chatThreadManager
.fetchChatThreadsWithParentId(
parentId: parentId,
limit: limit,
cursor: cursor,
);
} on EMError catch (e) {
}
- 用户还可以调用
EMChatThreadManager#fetchJoinedChatThreadsWithParentId
方法从服务器分页获取指定群组的子区列表:
// parentId: 群组 ID
// limit: 单次请求返回的子区数,取值范围为 [1, 50]
// cursor: 开始获取数据的游标位置,首次调用方法时传 `null` 或空字符串
try {
EMCursorResult<EMChatThread> chatThreads = await EMClient
.getInstance.chatThreadManager
.fetchJoinedChatThreadsWithParentId(
parentId: parentId,
limit: limit,
cursor: cursor,
);
} on EMError catch (e) {
}
批量获取子区中的最新一条消息
用户可以调用 EMChatThreadManager#fetchLatestMessageWithChatThreads
方法从服务器批量获取子区中的最新一条消息。
示例代码如下:
// chatThreadIds: 要查询的子区 ID 列表,每次最多可传入 20 个子区 ID
try {
Map<String, EMMessage> map = await EMClient.getInstance.chatThreadManager
.fetchLatestMessageWithChatThreads(
chatThreadIds: chatThreadIds,
);
} on EMError catch (e) {
}
监听子区事件
EMChatThreadManager
类中提供子区事件的监听接口。开发者可以通过设置此监听,获取子区中的事件,并做出相应处理。如果不再使用该监听,需要移除,防止出现内存泄漏。
示例代码如下:
// 注册监听
EMClient.getInstance.chatThreadManager.addEventHandler(
"UNIQUE_HANDLER_ID",
EMChatThreadEventHandler(),
);
// 移除监听
EMClient.getInstance.chatThreadManager.removeEventHandler("UNIQUE_HANDLER_ID");