房间管理

---

功能简介

ZIM SDK 提供多人房间聊天功能，支持用户向房间内发送文本消息或自定义消息，实现了多人在线交流、同步分享。

多人房间聊天功能可应用于小班课或者会议室等场景，房间成员数量上限请参考 计费说明。

前提条件

在实现“房间管理”功能之前，请确保：

• 已在 ZEGO 控制台 创建项目，获取到了接入 ZIM SDK 服务所需的 AppID、AppSign。ZIM 服务权限不是默认开启的，使用前，请先在 ZEGO 控制台 自助开通 ZIM 服务（详情请参考控制台的 服务配置 - 即时通讯 - 开通服务），若无法开通 ZIM 服务，请联系 ZEGO 技术支持开通。
• 已集成 ZIM SDK，详情请参考 快速开始 - 实现基本收发消息 的 “2 集成 SDK”。

实现流程

用户可以通过以下两种方式，创建房间并进入房间。

• 方式一：创建房间、加入房间：用户 A 调用 createRoom 接口，传入 ZIMRoomInfo 信息，即可创建并加入房间。其他用户调用 joinRoom 接口，传入由 A 创建的房间 roomID，即可加入房间。
• 方式二：进入房间：用户 X 调用 enterRoom 接口，传入 ZIMRoomInfo 信息，如果 roomID 不存在，会自动创建一个房间然后进入。其他用户需要调用 enterRoom 接口，传入由 X 创建的房间 roomID，进入房间。

房间内的用户，可以通过 sendRoomMessage 接口，向房间内发送消息，详情请参考 收发房间消息。

创建房间、加入房间

以下流程中，我们以客户端 A 创建并加入房间，客户端 B 和其他客户端加入房间为例。

1. 创建房间

客户端 A 登录后，创建一个房间，可以调用 createRoom 接口，传入 ZIMRoomInfo 信息，即可创建并加入房间。同时可以通过错误码 ZIMError 的参数值，判断是否创建成功。相关错误码请查看 常见错误码。

// roomID 最大 32 字节的字符串。仅支持数字，英文字符 和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
// roomName 最大 64 字节的字符串，无特殊字符限制。
ZIMRoomInfo zimRoomInfo = new ZIMRoomInfo();
zimRoomInfo.roomID = roomID;
zimRoomInfo.roomName = roomName;
zim.createRoom(zimRoomInfo, new ZIMRoomCreatedCallback() {
    @Override
    public void onRoomCreated(ZIMRoomFullInfo zimRoomFullInfo, ZIMError error) {
        if (error.code == ZIMErrorCode.SUCCESS) {
            // 创建成功             
        } else {
            // 创建失败             
        }                                
    }
});

2. 加入房间

客户端 B 和其他客户端先后加入房间，可以调用 joinRoom 接口，传入由 A 创建的房间 roomID，即可加入房间。同时可以根据错误码 ZIMError 的参数值，判断用户是否加入成功。相关错误码请查看 常见错误码。

zim.joinRoom(roomID, new ZIMRoomJoinedCallback() {
    @Override
    public void onRoomJoined(ZIMRoomFullInfo zimRoomFullInfo, ZIMError error) {
        if (error.code == ZIMErrorCode.SUCCESS) {
            // 加入房间成功。
        } else {
            // 加入房间失败。
        }     
    }
});

3. 房间成员变动通知

当房间有其他成员加入时，可以使用 setEventHandler 的回调接口 onRoomMemberJoined 方法，实现对其他房间成员加入的监听。

例如，当客户端 B 加入由 A 创建的房间时，A 将收到房间内成员变动的通知。

zim.setEventHandler(new ZIMEventHandler() {
    // 加入房间通知
    @Override
    public void onRoomMemberJoined(ZIM zim, ArrayList<ZIMUserInfo> memberList, final String roomID) {
    // 通过该通知收到加入房间的用户信息        
    }
});

进入房间

以下流程中，我们以客户端 X 创建并进入房间，客户端 Y 和其他客户端直接进入房间为例。

1. 客户端 X 登录后，调用 enterRoom 接口，传入 ZIMRoomInfo 信息，进入房间；如果传入的 roomID 不存在，将会自动创建一个房间并进入该房间。
2. 客户端 Y 及其他用户登录后，调用 enterRoom 接口，传入由 X 创建的房间 roomID，直接进入房间。
3. 房间内的用户，同样可以使用 setEventHandler 的回调接口 onRoomMemberJoined 方法，实现对房间内成员加入的监听。

ZIMRoomInfo zimRoomInfo = new ZIMRoomInfo();
zimRoomInfo.roomID = roomID;
zimRoomInfo.roomName = roomName;

ZIMRoomAdvancedConfig config = new ZIMRoomAdvancedConfig();

zim.enterRoom(zimRoomInfo, config, new ZIMRoomEnteredCallback() {
    @Override
    public void onRoomEntered(ZIMRoomFullInfo zimRoomFullInfo, ZIMError error) {
        if (error.code == ZIMErrorCode.SUCCESS) {
            // 进入成功             
        } else {
            // 进入失败             
        }                                
    }
});

离开房间

用户如果想要离开房间，可以调用 leaveRoom 接口，传入房间的 roomID，即可退出此房间；房间内的其他用户可以通过 setEventHandler 的回调接口 onRoomMemberLeft，收到成员变动通知。

离开房间后，将不能收到房间内的消息。

// 离开房间
zim.leaveRoom(roomID, new ZIMRoomLeftCallback() {
            @Override
            public void onRoomLeft(String roomID, ZIMError errorInfo) {

            }
});

zim.setEventHandler(new ZIMEventHandler() {
     // 离开房间通知
    @Override
    public void onRoomMemberLeft(ZIM zim, ArrayList<ZIMUserInfo> memberList, final String roomID) {
    // 通过该通知收到加入房间的用户信息        
    }
});