本页包含 IBRTMUserListener、IBRTMOnlineUserManager、IUserModel 接口/回调说明。涵盖了关于房间内用户相关的各种操作以及相关事件回调监听。

IBRTMUserListener

IBRTMUserListener 提供用户信息变更回调。包括用户列表变更、用户进出教室监听、用户被踢监听、用户权限变更等.

函数列表	描述
onResponseUserUpdateWithAuth	用户权限变更监听
onUserListUpdate	当前用户列表更新监听
onBlockUserListUpdate	黑名单列表更新监听
onUserIn	用户进入房间监听
onUserOut	用户退出房间监听
onSearchUserResult	搜索用户结果返回监听
onKickOut	被踢出教室监听

---

onResponseUserUpdateWithAuth

用户权限变更监听

void onResponseUserUpdateWithAuth(IUserModel user, Map<Integer, Boolean> updateValue)

参数

Name	Type	Description
user	IUserModel	用户对象
updateValue	Map<Integer, Boolean>	本次更新的数据集，key:本次更新的权限 index、value:更新后是否启用此权限

返回

---

onUserListUpdate

当前用户列表更新监听

 void onUserListUpdate(List<IUserModel> onlineUserList)

参数

Name	Type	Description
onlineUserList	List	更新后的用户列表

返回

---

onBlockUserListUpdate

黑名单列表更新监听

void onBlockUserListUpdate(List<IUserModel> blockUserList);

参数

Name	Type	Description
blockUserList	List	更新后的黑名单列表

返回

---

onUserIn

用户进入房间监听

void onUserIn(IUserModel userModel)

参数

Name	Type	Description
userModel	IUserModel	进入房间的用户对象

返回

---

onUserOut

用户退出房间监听

 void onUserOut(IUserModel userModel)

参数

Name	Type	Description
userModel	IUserModel	离开房间的用户对象

返回

---

onSearchUserResult

搜索用户结果返回监听 。

void onSearchUserResult(List<IUserModel> userModel)

参数

Name	Type	Description
userModel	IUserModel	成功则为对应的用户，失败则为 null

返回

无

---

onKickOut

被踢出教室监听

void onKickOut(BRTMError kickOutMessage)

参数

Name	Type	Description
kickOutMessage	BRTMError	被踢信息

返回

无

---

IBRTMOnlineUserManager

IBRTMOnlineUserManager 提供和用户有关的操作，例如获取用户列表信息、检索用户、踢人、设置权限等等。

函数列表	描述
setUserAuthWithIndex	修改第 index 位对应的权限
getUserAuthAtIndex	获取 index 位对应的权限
loadMoreUser	获取更多在线用户
getOnlineUser	获取当前在线用户列表
getRootUser	获取当前房间的超级管理员
getBlockedUserList	获取当前所有的黑名单用户列表
searchUserByUserId	通过 userId 搜索用户
requestKickOutUser	将指定 userId 的用户踢出教室

---

setUserAuthWithIndex

修改第 index 位对应的权限

BRTMError setUserAuthWithIndex(String userId, int index, boolean enableAuth);

参数

Name	Type	Description
userId	String	要修改的人的 userId
index	int	要修改的权限下标
enableAuth	boolean	将此位权限修改为 enableAuth

返回

BRTMError

---

getUserAuthAtIndex

获取 index 位对应的权限

仅支持获取已加载到本地的用户的权限

boolean getUserAuthAtIndex(String userId, int index) throws BRTMError

参数

Name	Type	Description
userId	String	要获取权限的人的 userId
index	int	要获取的权限的 index
enableAuth	boolean	将此位权限修改为 enableAuth

返回

• 此方法可能在 index 参数不合法、用户列表为空或本地没有任何数据的情况下抛出异常错误（BRTMError）
• boolean：指定 index 位置的权限是否处于启用状态（true 表示启用）

---

loadMoreUser

获取更多在线用户

void loadMoreUser()

参数

无

返回

无

说明

调用此方法后，您会通过 IBRTMUserListener.onUserListUpdate() 获取到新的用户列表信息。

---

getOnlineUser

获取当前在线用户列表

List<IUserModel> getOnlineUser()

参数

无

返回

List : 当前的用户列表及用户信息

---

getRootUser

获取当前房间的超级管理员

IUserModel getRootUser()

参数

无

返回

IUserModel: 如果房间存在 root 用户，则返回用户对象，否则返回 null

---

getBlockedUserList

获取当前所有的黑名单用户列表

List<IUserModel> getBlockedUserList()

参数

无

返回

List : 当前所有的黑名单用户

---

searchUserByUserId

通过 userId 搜索用户

搜索的结果在 IBRTMUserListener.onSearchUserResult() 中返回

void searchUserByUserId(String userId)

参数

Name	Type	Description
userId	String	要搜索的用户的 userId

返回

无

---

requestKickOutUser

将指定 userId 的用户踢出教室

仅支持踢出已加载到本地的用户

BRTMError requestKickOutUser(String userId)

参数

Name	Type	Description
userId	String	要踢出的 userId

返回

BRTMError

---

IUserModel

IUserModel 是一个具体的用户对象的信息封装模型。您可以通过它来获取某个用户的详细属性。

函数列表	描述
getUserId	服务器分配的 userId
getNumber	用户唯一的 number
getRole	用户角色
getName	用户名称
getAvatar	用户头像
getGroup	用户所在组id
getEndType	用户终端类型

---

getUserId

获取此用户本次进房使用的用户 ID

String getUserId()

参数

无

返回

用户 ID 字符串

---

getNumber

获取用户在房间内的唯一的用户标识

UserNumber 和 UserId 的区别是：UserNumber 是唯一的，而 UserId 在用户每次离房再进房会发生变化。

String getNumber()

参数

无

返回

唯一的用户标识字符串

---

getRole

获取此用户在房间内的角色

BRTMConstants.BRTMUserRole getRole()

参数

无

返回

• BRTMUserRole : 返回用户角色

---

getName

获取用户名称

String getName()

参数

无

返回

用户名称字符串

---

getAvatar

获取用户头像

String getAvatar()

参数

无

返回

用户头像（通常是一个图片）的字符串信息（如图片 URL）

---

getGroup

获取用户所在组 ID

int getGroup()

参数

无

返回

组 ID 整数

---

getEndType

获取用户终端类型

BRTMConstants.BRTMClientType getEndType()

参数

无

返回

BRTMClientType