# 管理群组属性

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

    # 技术原理

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

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

    # 前提条件

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

    # 实现方法

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

    # 修改群组名称

    仅群主和群管理员可以调用 changeGroupName 方法设置和修改群组名称,其他群成员会收到EMGroupChangeListener#onSpecificationChanged 回调。群名称的长度限制为 128 个字符。

    示例代码如下:

    // 同步方法,会阻塞当前线程。
    // 异步方法为 asyncChangeGroupName(String, String, EMCallBack)。
    EMClient.getInstance().groupManager().changeGroupName(groupId,changedGroupName);
    

    # 修改群组描述

    仅群主和群管理员可以调用 changeGroupDescription 方法设置和修改群组描述,其他群成员会收到EMGroupChangeListener#onSpecificationChanged 回调。群描述的长度限制为 512 个字符。

    示例代码如下:

    // 同步方法,会阻塞当前线程。
    // 异步方法为 asyncChangeGroupDescription(String, String, EMCallBack)。
    EMClient.getInstance().groupManager().changeGroupDescription(groupId,description);
    

    # 更新群公告

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

    示例代码如下:

    // 同步方法,会阻塞当前线程。
    // 异步方法为 asyncUpdateGroupAnnouncement(String, String, EMCallBack)。
    EMClient.getInstance().groupManager().updateGroupAnnouncement(groupId, announcement);
    

    # 获取群公告

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

    示例代码如下:

    // 同步方法,会阻塞当前线程。
    // 异步方法为 asyncFetchGroupAnnouncement(String, EMValueCallBack)。
    EMClient.getInstance().groupManager().fetchGroupAnnouncement(groupId);
    

    # 管理共享文件

    # 上传共享文件

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

    示例代码如下:

    // 同步方法,会阻塞当前线程。
    // 异步方法为 asyncUploadGroupSharedFile(String, String, EMValueCallBack)。
    EMClient.getInstance().groupManager().uploadGroupSharedFile(groupId, filePath, callBack);
    

    # 下载共享文件

    所有群成员均可调用 asyncDownloadGroupSharedFile 方法下载群组共享文件。

    // 同步方法,需要放到异步线程
    List<EMMucSharedFile> sharedFiles = EMClient.getInstance().groupManager().fetchGroupSharedFileList(groupId, pageNum, pageSize);
    // 获取需要的共享文件信息
    EMMucSharedFile sharedFile = sharedFiles.get(index);
    EMClient.getInstance().groupManager().asyncDownloadGroupSharedFile(groupId, sharedFile.getFileId(), savePath, new EMCallBack() {
        @Override
        public void onSuccess() {
            // 在这里处理 savePath 保存的文件
        }
    
        @Override
        public void onError(int code, String error) {
    
        }
    });
    

    # 删除共享文件

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

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

    示例代码如下:

    // 同步方法,会阻塞当前线程。
    // 异步方法为 asyncDeleteGroupSharedFile(String, String, EMCallBack)。
    EMClient.getInstance().groupManager().deleteGroupSharedFile(groupId, fileId);
    

    # 从服务器获取共享文件

    所有群成员均可以调用 fetchGroupSharedFileList 方法从服务器获取群组的共享文件列表。

    // 同步方法,会阻塞当前线程。
    // 异步方法为 asyncFetchGroupSharedFileList(String, int, int, EMValueCallBack)。
    EMClient.getInstance().groupManager().fetchGroupSharedFileList(groupId, pageNum, pageSize);
    

    # 更新群扩展字段

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

    示例代码如下:

    // 同步方法,会阻塞当前线程。
    EMClient.getInstance().groupManager().updateGroupExtension(groupId, extension);
    

    # 监听群组事件

    详见 监听群组事件

    更新时间:2023-02-03 12:13:12