getGroupOnlineMemberCount
功能介绍
获取指定群在线人数
目前仅直播群(AVChatRoom)支持获取群在线人数。
SDK 调用频率限制为 60 秒 1 次。
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupID | string | 是 | 需要查询的群组id |
返回模板
V2TimValueCallback<number>
{
code : number
desc : string
data : number
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | number | 请求结果错误码 |
desc | string | 请求结果描述符 |
data | number | 查询到的群在线人数 |
代码示例
import { TencentImSDKPlugin } from 'react-native-tim-js';
// 获取指定群在线人数
const getGroupOnlineMemberCountRes = await TencentImSDKPlugin.v2TIMManager
.getGroupManager()
.getGroupOnlineMemberCount('groupID');
if (getGroupOnlineMemberCountRes.code === 0) {
// 查询成功
getGroupOnlineMemberCountRes.data; // 查询到的群在线人数
}