大规模房间
最近更新时间:2022-01-25 15:55:47 星期二
大规模房间
- 可以在后台创建大规模房间。
- 当 普通一对多 的房间中用户人数达到 100人 时,此房间会自动升级成为大房间。可以在-(void)onRemotePubMsg(String id, String name, long ts, String dataJson, boolean inList, String fromId, String associatedMsgId, String associatedUserId)回调中监听 msgName,若"BigRoom"时,表示此时房间已升级为大房间。
- 以下接口均是在大房间情况的调用生效。
getUserList
简要描述 - 获取用户列表
接口名称
- - (int)Map<String, RoomUser> getUserList(RequestUserListParams params, boolean isSyncGet, final OnGetUserListListener listListener);
参数
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
params | 是 | RequestUserListParams | 获取规则 |
isSyncGet | 是 | boolean | 是否是同步 |
listListener | 是 | OnGetUserListListener | 返回数据接口 |
返回值说明
类型 | 说明 |
---|---|
int | 0:表示调用成功,非0:表示调用失败 |
getRoomUserNum
简要描述 - 获取大房间特定用户的人数
根据用户角色搜索用户,然后匹配用户昵称,返回人数 请求结果通过onGetRoomUserNumBack(int errorCode, int num)返回。
接口名称
1 |
|
参数
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
role | 是 | Array | 用户角色数组 |
search | 否 | NSString | 搜索条件:只匹配用户昵称 |
返回值说明
类型 | 说明 |
---|---|
int | 0:表示调用成功,非0:表示调用失败 |
batchChangeUserProperty
简要描述 - 大房间时,批量改变指定用户的属性
接口名称
1 2 3 |
|
参数
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
peerIDs | 是 | Array | 用户ID |
tellWhom | 是 | String | 需将此修改信令通知到的对象。 可以是某一用户ID,表示此信令只发送给该用户 |
property | 是 | Map | 被修改的用户属性 |
opt | 否 | Map | 扩展信息 |
返回值说明
类型 | 说明 |
---|---|
int | 0:表示调用成功,非0:表示调用失败 |
changeUserPropertyByRole
简要描述 - 大房间时,改变指定角色的用户属性
接口名称
1 2 3 |
|
参数
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
roles | 是 | Array | 用户角色 |
tellWhom | 否 | String | 需将此修改信令通知到的对象, 可以是某一用户ID,表示此信令只发送给该用户 |
property | 是 | Map | 被修改的用户属性 |
opt | 是 | Map | 扩展信息 |
返回值说明
类型 | 说明 |
---|---|
int | 0:表示调用成功,非0:表示调用失败 |