管理群组属性

更新时间:2022-07-13

群组是支持多人沟通的即时通讯系统,本文指导你如何使用环信即时通讯 IM SDK 在实时互动 app 中实现群组属性相关功能。

环信即时通讯 IM iOS SDK 提供 IEMGroupManager 类和 EMGroup 类用于群组管理,支持你通过调用 API 在项目中实现如下功能:

  • 修改群组名称及描述
  • 获取、更新群组公告
  • 管理群组共享文件
  • 更新群扩展字段

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

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

修改群组名称

仅群主和群管理员可以调用 changeGroupSubject 方法设置和修改群组名称,群名称的长度限制为 128 个字符。

[[EMClient sharedClient].groupManager changeGroupSubject:@"subject"

修改群组描述

仅群主和群管理员可以调用 changeDescription 方法设置和修改群组描述,群描述的长度限制为 512 个字符。

[[EMClient sharedClient].groupManager changeDescription:@"desc"
                                                                                                            forGroup:@"groupID"
                                                                                                              error:nil];

更新群公告

仅群主和群管理员可以调用 updateGroupAnnouncementWithId 方法设置和更新群公告,群公告的长度限制为 512 个字符。群公告更新后,其他群成员收到 EMGroupManagerDelegate#groupAnnouncementDidUpdate 回调。

示例代码如下:

[[EMClient sharedClient].groupManager updateGroupAnnouncementWithId:@"groupID"
                                                                                                                       announcement:@"announcement"
                                                                                                                                error:nil];

获取群公告

所有群成员均可以调用 getGroupAnnouncementWithId 方法从服务器获取群公告。

示例代码如下:

[[EMClient sharedClient].groupManager getGroupAnnouncementWithId:@"groupID"
                                                                                                                                  error:nil];

管理共享文件

上传共享文件

所有群组成员均可以调用 uploadGroupSharedFileWithId 方法上传共享文件至群组,群共享文件大小限制为 10 MB。上传共享文件后,其他群成员收到 EMGroupManagerDelegate#addedSharedFile 回调。

示例代码如下:

[[EMClient sharedClient].groupManager uploadGroupSharedFileWithId:@"groupID"
                                                                                                                              filePath:@"filePath"
                                                                                                                            progress:nil
                                                                                                                          completion:nil];

删除共享文件

所有群成员均可以调用 removeGroupSharedFileWithId 方法删除群共享文件。删除共享文件后,其他群成员收到 EMGroupManagerDelegate#groupFileListDidUpdate 回调。

群主和群管理员可删除全部的群共享文件,群成员只能删除自己上传的群文件。

[[EMClient sharedClient].groupManager removeGroupSharedFileWithId:@"groupID"
                                                                                                                    sharedFileId:@"fileID"
                                                                                                                               error:nil];

从服务器获取群组的共享文件

所有群成员均可以调用 getGroupFileListWithId 方法获取群共享文件。

[[EMClient sharedClient].groupManager getGroupFileListWithId:@"groupID"
                                                                                                                pageNumber:pageNumber
                                                                                                                  pageSize:pageSize
                                                                                                                         error:nil];

更新群扩展字段

仅群主和群管理员可以调用 updateGroupExtWithId 方法更新群组的扩展字段,群组扩展字段设置 JSON 格式的数据,用于自定义更多群组信息。群扩展字段的长度限制为 8 KB。

示例代码如下:

[[EMClient sharedClient].groupManager updateGroupExtWithId:@"groupID"
                                                                                                                            ext:@"ext"
                                                                                                                        error:nil];

更多操作

你可以参考如下文档,在项目中实现更多的群组相关功能: