====== 管理聊天室成员 ====== 聊天室是支持多人沟通的即时通讯系统。本文介绍如何使用环信即时通讯 IM SDK 在实时互动 app 中管理聊天室成员,并实现聊天室的相关功能。 ===== 技术原理 ===== 环信即时通讯 IM SDK 提供 ''%%Room%%''、''%%IRoomManager%%'' 和 ''%%IRoomManagerDelegate%%'' 类,支持对聊天室成员的管理,包括获取、添加和移出聊天室成员等,主要方法如下: * 获取聊天室成员列表 * 将成员移出聊天室 * 管理聊天室黑名单 * 管理聊天室白名单 * 管理聊天室禁言列表 * 开启和关闭聊天室全员禁言 * 管理聊天室所有者及管理员 ===== 前提条件 ===== 开始前,请确保满足以下条件: * 完成 SDK 初始化,详见 [[https://docs-im.easemob.com/ccim/unity/quickstart|快速开始]]; * 了解环信即时通讯 IM 的 [[https://docs-im.easemob.com/ccim/limitation|使用限制]]。 * 了解环信即时通讯 IM 聊天室相关限制,详见 [[https://www.easemob.com/pricing/im|环信即时通讯 IM 价格]]。 ===== 实现方法 ===== 本节介绍如何使用环信即时通讯 IM SDK 提供的 API 实现上述功能。 ==== 获取聊天室成员列表 ==== 所有聊天室成员均可调用 ''%%FetchRoomMembers%%'' 方法获取当前聊天室的成员列表。 示例代码如下: SDKClient.Instance.RoomManager.FetchRoomMembers(roomId, cursor, pageSize, handle: new ValueCallBack>( // members 类型为 CursorResult。 onSuccess: (members) => { }, onError: (code, desc) => { } )); ==== 将成员移出聊天室 ==== 仅聊天室所有者和管理员可调用 ''%%DeleteRoomMembers%%'' 方法将指定成员移出聊天室。 被移出后,该成员收到 ''%%OnRemovedFromRoom%%'' 回调,其他成员收到 ''%%OnMemberExitedFromRoom%%'' 回调。 被移出的成员可以重新进入聊天室。 示例代码如下: SDKClient.Instance.RoomManager.DeleteRoomMembers(roomId, members, new CallBack( onSuccess: () => { }, onError: (code, desc) => { } )); ==== 管理聊天室黑名单 ==== === 将成员加入聊天室黑名单 === 仅聊天室所有者和管理员可调用 ''%%BlockRoomMembers%%'' 方法将指定成员添加至黑名单。被加入黑名单后,该成员收到 ''%%OnRemovedFromRoom%%'' 回调,其他成员收到 ''%%OnMemberExitedFromRoom%%'' 回调。被加入黑名单后,该成员无法再收发聊天室消息并被移出聊天室,黑名单中的成员如想再次加入聊天室,聊天室所有者或管理员必须先将其移出黑名单列表。 示例代码如下: SDKClient.Instance.RoomManager.BlockRoomMembers(roomId, members, new CallBack( onSuccess: () => { }, onError: (code, desc) => { } )); === 将成员移出聊天室黑名单 === 仅聊天室所有者和管理员可以调用 ''%%UnBlockRoomMembers%%'' 方法将成员移出聊天室黑名单。 示例代码如下: SDKClient.Instance.RoomManager.UnBlockRoomMembers(roomId, members, new CallBack( onSuccess: () => { }, onError: (code, desc) => { } )); === 获取聊天室黑名单列表 === 仅聊天室所有者和管理员可以调用 ''%%FetchRoomBlockList%%'' 方法获取当前聊天室黑名单。 示例代码如下: SDKClient.Instance.RoomManager.FetchRoomBlockList(roomId, pageNum, pageSize, handle: new ValueCallBack>( // list 类型为 List。 onSuccess: (list) => { }, onError: (code, desc) => { } )); ==== 管理聊天室禁言列表 ==== === 添加成员至聊天室禁言列表 === 仅聊天室所有者和管理员可以调用 ''%%MuteRoomMembers%%'' 方法将指定成员添加至聊天室禁言列表。被禁言后,该成员和其他未操作的聊天室管理员或聊天室所有者收到 ''%%OnMuteListAddedFromRoom%%'' 回调。 **注意** 聊天室所有者可禁言聊天室所有成员,聊天室管理员可禁言聊天室普通成员。 示例代码如下: SDKClient.Instance.RoomManager.MuteRoomMembers(roomId, members, new CallBack( onSuccess: () => { }, onError: (code, desc) => { } )); === 将成员移出聊天室禁言列表 === 仅聊天室所有者和管理员可以调用 ''%%UnMuteRoomMembers%%'' 方法将成员移出聊天室禁言列表。被解除禁言后,其他成员收到 ''%%OnMuteListRemovedFromRoom%%'' 回调。 **注意**: 聊天室所有者可对聊天室所有成员解除禁言,聊天室管理员可对聊天室普通成员解除禁言。 示例代码如下: SDKClient.Instance.RoomManager.UnMuteRoomMembers(roomId, members, new CallBack( onSuccess: () => { }, onError: (code, desc) => { } )); === 获取聊天室禁言列表 === 仅聊天室所有者和管理员可调用 ''%%FetchRoomMuteList%%'' 方法获取当前聊天室的禁言列表。 示例代码如下: SDKClient.Instance.RoomManager.FetchRoomMuteList(roomId, pageSize, pageNum, handle: new ValueCallBack>( // list 类型为 List onSuccess: (list) => { }, onError: (code, desc) => { } )); ==== 管理聊天室所有者和管理员 ==== === 变更聊天室所有者 === 仅聊天室所有者可以调用 ''%%ChangeRoomOwner%%'' 方法将权限移交给聊天室中指定成员。成功移交后,原聊天室所有者变为聊天室成员,新的聊天室所有者和聊天室管理员收到 ''%%OnOwnerChangedFromRoom%%'' 回调。 示例代码如下: SDKClient.Instance.RoomManager.ChangeRoomOwner(roomId, newOwner, new CallBack( onSuccess: () => { }, onError: (code, desc) => { } )); === 添加聊天室管理员 === 仅聊天室所有者可以调用 ''%%AddRoomAdmin%%'' 方法添加聊天室管理员。成功添加后,新管理员及其他管理员收到 ''%%OnAdminAddedFromRoom%%'' 回调。 示例代码如下: SDKClient.Instance.RoomManager.AddRoomAdmin(roomId, adminId, new CallBack( onSuccess: () => { }, onError: (code, desc) => { } )); === 移除聊天室管理员 === 仅聊天室所有者可以调用 ''%%RemoveRoomAdmin%%'' 方法移除聊天室管理员。成功移除后,被移除的管理员及其他管理员收到 ''%%OnAdminRemovedFromRoom%%'' 回调。 示例代码如下: SDKClient.Instance.RoomManager.RemoveRoomAdmin(roomId, adminId, new CallBack( onSuccess: () => { }, onError: (code, desc) => { } )); ==== 监听聊天室事件 ==== 详见 [[https://docs-im.easemob.com/ccim/unity/chatroom2#监听聊天室事件|监听聊天室事件]]。