getUserStatus
功能介绍
获取用户在线状态
4.0.3版本开始支持
web不支持
参数详解
参数名称 | 参数类型 | 是否必填 | 平台 | 描述 |
---|---|---|---|---|
userIDList | List< String > | 是 | 全部 | 需要查询用户在线状态的用户id列表 |
返回模板
V2TimValueCallback<List<V2TimUserStatus>>
{
code : int
desc : String
data : List<V2TimUserStatus>//查询到的用户在线状态列表
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | int | 请求结果错误码 |
desc | String | 请求结果描述符 |
data | List< V2TimUserStatus > | 查询到的用户在线状态列表 |
代码示例
//获取用户在线状态
V2TimValueCallback<List<V2TimUserStatus>> getUserStatusRes =
await TencentImSDKPlugin.v2TIMManager.getUserStatus(userIDList: []);// 需要查询用户在线状态的用户id列表
if (getUserStatusRes.code == 0) {
//查询成功
getUserStatusRes.data?.forEach((element) {
element.customStatus;//此条为此API查询的用户在线状态字段
element.statusType;//用户在线状态类型 1:在线状态 2:离线状态 3:未登录(如主动调用 logout 接口,或者账号注册后还未登录)
element.userID;//用户id
});
}