创建和管理聊天室以及监听器介绍

更新时间：2022-07-15

聊天室是支持多人沟通的即时通讯系统。聊天室中的成员没有固定关系，用户离线后，超过 5 分钟会自动退出聊天室。聊天室成员在离线后，不会收到推送消息。聊天室可以应用于直播、消息广播等。

本文介绍如何使用环信即时通讯 IM SDK 在实时互动 app 中创建和管理聊天室，并实现聊天室的相关功能。

消息相关内容见 消息管理。

环信即时通讯 IM SDK 提供 EMChatRoomManager 类 和 EMChatRoom 类用于聊天室管理，支持你通过调用 API 在项目中实现如下功能：

• 创建聊天室
• 从服务器获取聊天室列表
• 加入聊天室
• 获取聊天室详情
• 退出聊天室
• 解散聊天室
• 监听聊天室事件

开始前，请确保满足以下条件：

• 完成 SDK 初始化，详见 快速开始。
• 了解环信即时通讯 IM 的 使用限制。
• 了解环信即时通讯 IM 不同版本的聊天室相关数量限制，详见 环信即时通讯 IM 价格。
• 只有超级管理员才有创建聊天室的权限，因此你还需要确保已调用 RESTful API 添加了超级管理员，详见 添加聊天室超级管理员。
• 聊天室创建者和管理员的数量之和不能超过 100，即管理员最多可添加 99 个。

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

仅 超级管理员 可以调用 createChatRoom 方法创建聊天室，并设置聊天室的名称、描述、最大成员数等信息。成功创建聊天室后，该超级管理员为该聊天室的所有者。

你也可以直接调用 REST API 从服务端创建聊天室。

示例代码如下：

// 异步方法
EMChatRoom  chatRoom = EMClient.getInstance().chatroomManager().createChatRoom(subject, description, welcomMessage, maxUserCount, members);

用户申请加入聊天室的步骤如下：

1. 调用 fetchPublicChatRoomsFromServer 方法从服务器获取聊天室列表，查询到想要加入的聊天室 ID。
2. 调用 joinChatRoom 方法传入聊天室 ID，申请加入对应聊天室。新成员加入聊天室时，其他成员收到 onMemberJoined 回调。

示例代码如下：

// 获取公开聊天室列表，每次最多可获取 1,000 个。
EMPageResult<EMChatRoom> chatRooms = EMClient.getInstance().chatroomManager().
                            fetchPublicChatRoomsFromServer(pageNumber, pageSize);

// 加入聊天室
EMClient.getInstance().chatroomManager().joinChatRoom(chatRoomId, new EMValueCallBack<EMChatRoom>() {
    @Override
    public void onSuccess(EMChatRoom value) {

    }

    @Override
    public void onError(int error, String errorMsg) {

    }

});

聊天室所有成员均可调用 fetchChatRoomFromServer 获取聊天室的详情，包括聊天室 ID、聊天室名称，聊天室描述、聊天室公告、管理员列表、最大成员数、聊天室所有者、是否全员禁言以及聊天室角色类型。成员列表、黑名单列表、禁言列表需单独调用接口获取。

示例代码如下：

// 异步方法
EMChatRoom chatRoom = EMClient.getInstance().chatroomManager().fetchChatRoomFromServer(chatRoomId);

聊天室所有成员均可以调用 leaveChatRoom 方法退出当前聊天室。成员退出聊天室时，其他成员收到 onMemberExited 回调。

示例代码如下：

EMClient.getInstance().chatroomManager().leaveChatRoom(chatRoomId);

退出聊天室时，SDK 默认删除该聊天室所有本地消息，若要保留这些消息，可在 SDK 初始化时将 EMOptions#setDeleteMessagesAsExitChatRoom 设置为 false。

示例代码如下：

EMOptions options = new EMOptions();
options.setDeleteMessagesAsExitChatRoom(false);

与群主无法退出群组不同，聊天室所有者可以离开聊天室，例如所有者从服务器下线则 5 分钟后自动离开聊天室。如果所有者重新进入聊天室仍是该聊天室的所有者。

仅聊天室所有者可以调用 destroyChatRoom 方法解散聊天室。聊天室解散时，其他成员收到 onChatRoomDestroyed 回调并被踢出聊天室。

示例代码如下：

// 异步方法。
EMClient.getInstance().chatroomManager().destroyChatRoom(chatRoomId);

EMChatRoomChangeListener 类中提供了聊天室事件的监听接口。你可以通过注册聊天室监听器，获取聊天室事件，并作出相应处理。如不再使用该监听器，需要移除，防止出现内存泄露。

示例代码如下：

// 注册聊天室回调
EMClient.getInstance().chatroomManager().addChatRoomChangeListener(chatRoomChangeListener);
// 移除聊天室回调
EMClient.getInstance().chatroomManager().removeChatRoomListener(chatRoomChangeListener);

具体事件如下：

public interface EMChatRoomChangeListener {
    // 聊天室被解散
    void onChatRoomDestroyed(final String roomId, final String roomName);

    // 有用户加入聊天室
    void onMemberJoined(final String roomId, final String participant);

    // 有成员离开聊天室
    void onMemberExited(final String roomId, final String roomName, final String participant);

    /**
     * 有成员被移出聊天室
     *
     * @param reason        用户被移出聊天室的原因：
     *                        - xxx BE_KICKED：该用户被聊天室管理员移出；
     *                        - xxxBE_LICKED)FOR_OFFLINE：该用户由于当前设备断网被服务器移出聊天室。
     */
    void onRemovedFromChatRoom(final int reason, final String roomId, final String roomName, final String participant);

    // 有成员被加入禁言列表
    void onMuteListAdded(final String chatRoomId, final List<String> mutes, final long expireTime);

    // 有成员被移出禁言列表
    void onMuteListRemoved(final String chatRoomId, final List<String> mutes);

    // 有成员被加入白名单列表
    void onWhiteListAdded(final String chatRoomId, final List<String> whitelist);

    // 有成员被移出白名单列表
    void onWhiteListRemoved(final String chatRoomId, final List<String> whitelist);

    // 全员禁言状态变更
    void onAllMemberMuteStateChanged(final String chatRoomId, final boolean isMuted);

    // 有成员被设为管理员
    void onAdminAdded(final String chatRoomId, final String admin);

    // 有成员被移除管理员权限
    void onAdminRemoved(final String chatRoomId, final String admin);

  // 聊天室所有者变更
    void onOwnerChanged(final String chatRoomId, final String newOwner, final String oldOwner);

   // 聊天室公告变更
    void onAnnouncementChanged(String chatRoomId, String announcement);

}

你可以参考如下文档，在项目中实现更多的聊天室相关功能：

• 聊天室概述
• 管理聊天室成员
• 管理聊天室属性