Web

User

Index

---

相关接口
all	获取当前所有的本地
(async) find	查找指定用户
(async) getUserAuth	获取用户权限
(async) getUserAuthByIndex	获取用户某一位权限
hasMore	是否还有更多 user 没有请求到本地
(async) kickOut	踢出用户
(async) requestMore	请求更多的 user
(async) search	模糊搜索用户名
(async) find	根据 UserId 寻找 User
(async) updateUser	更新用户信息
(async) updateUserAuth	全量更新 user 权限
(async) updateUserAuthByIndex	更新 user 的某一位权限

Methods

---

all
获取当前所有的本地 BRTMUser

all(): object[]

返回

• object[]

---

find
查找 user

find(userId: UserId): Promise‹BRTMUser›

参数

Name	Type	Description
userId	UserId	用户 id

返回

• Promise‹BRTMUser›

---

getUserAuth
获取用户权限

getUserAuth(userId: UserId): Promise‹boolean[]›

参数

Name	Type	Description
userId	UserId	用户 id

返回

• Promise‹boolean[]›

---

getUserAuthByIndex
获取用户某一位权限

getUserAuthByIndex(userId: UserId, index: number): Promise‹boolean›

参数

Name	Type	Description
userId	UserId	用户 id
index	number	位置 - 取值范围 [0, 63]

返回

• Promise‹boolean[]›

---

hasMore
是否还有更多 user 没有请求到本地

hasMore(): boolean

返回

• boolean

---

kickOut
踢出用户

kickOut(userId: UserId): Promise‹void›

参数

Name	Type	Description
userId	UserId	被踢的 user id

返回

• Promise‹void›

---

requestMore
请求更多的 user

requestMore(count?: number): Promise<{
        hasMore: boolean;
        userList: BRTMUser[];
    }

参数

Name	Type	Description
count	number	请求数量

返回

• hasMore 是否还有更多用户
• userList 请求到的用户列表

---

search
根据用户名搜索用户（模糊搜索）

search(name: string): Promise‹BRTMUser[]›

参数

Name	Type	Description
name	string	用户名称

返回

• Promise‹BRTMUser[]›

说明

• admin root 角色可以使用该功能

---

find
根据用户 id 查找用户）

find(id: UserId): Promise‹BRTMUser›

参数

Name	Type	Description
id	UserId	用户 id

返回

• Promise‹BRTMUser›

说明

• admin root 角色可以使用该功能

---

updateUser
更新用户信息

updateUser(userId: UserId, user: User): Promise‹void›

参数

Name	Type
userId	UserId
user	User)

返回

• Promise‹void›

---

updateUserAuth
全量更新 user 权限

updateUserAuth(userId: UserId, auth: Boolean[]): Promise‹void›

参数

Name	Type	Default	Description
userId	UserId	-	用户 id
auth	Boolean[]	[]	权限数组（64 位，可以只用传自己使用的位数，如我只是用了 8 位，auth 可传 8 位长度的数组）

返回

• Promise‹void›

---

updateUserAuthByIndex
更新 user 的某一位权限

updateUserAuthByIndex(userId: UserId, index: number, auth: Boolean): Promise‹void›

参数

Name	Type	Default	Description
userId	UserId	-	用户 id
index	number	-	位置 - 取值范围 [0, 63]
auth	Boolean	false	权限状态

返回

• Promise‹void›

userEvents

Index

---

USER_AUTH_CHANGED	USER_COUNT_CHANGED	USER_IN
USER_OUT	USER_REPORT

Variables

---

用户权限信息更新

client.on('user-auth-changed', auth => {
});

---

用户人数改变

client.on('user-count-changed', (event) => {
});

---

用户进入房间通知

client.on('user-in', event => {
  const userId = event.userId;
});

---

用户退出房间通知

client.on('user-out', event => {
  const userId = event.userId;
});

---

用户进出报告

client.on('user-report', (event) => {
});