====== 管理群组属性 ====== 更新时间:2022-09-07 群组是支持多人沟通的即时通讯系统,本文指导你如何使用环信即时通讯 IM Flutter SDK 在实时互动 app 中实现群组属性相关功能。 ===== 技术原理 ===== 环信即时通讯 IM Flutter SDK 提供 ''%%EMGroup%%''、''%%EMGroupManager%%'' 和 ''%%EMGroupEventHandler%%'' 类用于群组管理,支持你通过调用 API 在项目中实现如下功能: * 修改群组名称及描述 * 获取、更新群组公告 * 管理群组共享文件 * 更新群扩展字段 ===== 前提条件 ===== 开始前,请确保满足以下条件: * 完成 SDK 初始化,详见 [[https://docs-im.easemob.com/ccim/flutter/quickstart|快速开始]]; * 了解环信即时通讯 IM API 的接口调用频率限制,详见 [[https://docs-im.easemob.com/ccim/limitation|使用限制]]; * 了解群组和群成员的数量限制,详见 [[https://www.easemob.com/pricing/im|套餐包详情]]。 ===== 实现方法 ===== 本节介绍如何使用环信即时通讯 IM Flutter SDK 提供的 API 实现上述功能。 ==== 修改群组名称 ==== 仅群主和群管理员可以调用 ''%%EMGroupManager#changeGroupName%%'' 方法设置和修改群组名称,群名称的长度限制为 128 个字符。 示例代码如下: try { await EMClient.getInstance.groupManager.changeGroupName( groupId, newName, ); } on EMError catch (e) { } ==== 修改群组描述 ==== 仅群主和群管理员可以调用 ''%%EMGroupManager#changeGroupDescription%%'' 方法设置和修改群组描述,群描述的长度限制为 512 个字符。 示例代码如下: try { await EMClient.getInstance.groupManager.changeGroupDescription( groupId, newDesc, ); } on EMError catch (e) { } ==== 更新群公告 ==== 仅群主和群管理员可以调用 ''%%EMGroupManager#updateGroupAnnouncement%%'' 方法设置和更新群公告,群公告的长度限制为 512 个字符。群公告更新后,其他群成员收到 ''%%EMGroupEventHandler#onAnnouncementChangedFromGroup%%'' 事件。 示例代码如下: try { await EMClient.getInstance.groupManager.updateGroupAnnouncement( groupId, newAnnouncement, ); } on EMError catch (e) { } ==== 获取群公告 ==== 所有群成员均可以调用 ''%%EMGroupManager#fetchAnnouncementFromServer%%'' 方法从服务器获取群公告。 示例代码如下: try { String? announcement = await EMClient.getInstance.groupManager.fetchAnnouncementFromServer( groupId, ); } on EMError catch (e) { } ==== 管理共享文件 ==== === 上传共享文件 === 所有群组成员均可以调用 ''%%EMGroupManager#uploadGroupSharedFile%%'' 方法上传共享文件至群组,群共享文件大小限制为 10 MB。上传共享文件后,其他群成员收到 ''%%EMGroupEventHandler#onSharedFileAddedFromGroup%%'' 事件。 示例代码如下: try { await EMClient.getInstance.groupManager.uploadGroupSharedFile( groupId, filePath, ); } on EMError catch (e) { } === 删除共享文件 === 所有群成员均可以调用 ''%%EMGroupManager#removeGroupSharedFile%%'' 方法删除群共享文件。删除共享文件后,其他群成员收到 ''%%EMGroupEventHandler#onSharedFileDeletedFromGroup%%'' 事件。群主和群管理员可删除全部的群共享文件,群成员只能删除自己上传的群文件。 示例代码如下: try { await EMClient.getInstance.groupManager.removeGroupSharedFile( groupId, fileId, ); } on EMError catch (e) { } === 从服务器获取共享文件 === 所有群成员均可以调用 ''%%EMGroupManager#fetchGroupFileListFromServer%%'' 方法从服务器获取群组的共享文件列表。 示例代码如下: try { List list = await EMClient.getInstance.groupManager.fetchGroupFileListFromServer( groupId, pageNum: pageNum, pageSize: pageSize, ); } on EMError catch (e) { } ==== 更新群扩展字段 ==== 群主和群管理员可以调用 ''%%EMGroupManager#updateGroupExtension%%'' 方法更新群组的扩展字段,群组扩展字段设置 JSON 格式的数据,用于自定义更多群组信息。群扩展字段的长度限制为 8 KB。 示例代码如下: try { await EMClient.getInstance.groupManager.updateGroupExtension( groupId, extension, ); } on EMError catch (e) { } ==== 监听群组事件 ==== 详见 [[https://docs-im.easemob.com/ccim/flutter/group2#监听群组事件|监听群组事件]]。