在线状态

查询单用户/批量用户的在线状态；支持多端在线聚合。

平台调用风格

异步风格：Future<RcResult<T>>；错误码在 res.code，不使用异常表达业务失败。

接口一览​

操作语义传输返回
getOnlineStatus查询单个用户在线状态。REST（客户端）{userId:string, online:bool, sessionCount:uint32}
getOnlineStatusBatch批量在线状态（<=100）。REST（客户端）{items:[{userId:string,online:bool,sessionCount:uint32}]}

本页 2 个操作，其中 2 个在本平台绑定中声明了方法签名。

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
getOnlineStatusgetOnlineStatusgetOnlineStatusgetOnlineStatusgetOnlineStatusgetOnlineStatus—func
getOnlineStatusBatchgetOnlineStatusBatchgetOnlineStatusBatchgetOnlineStatusBatchgetOnlineStatusBatchgetOnlineStatusBatch—func

方法名在 GA 平台之间保持一致（规则 A）；Native C ABI 只覆盖部分操作，其余操作以 — 标注。

getOnlineStatus​

查询单个用户在线状态。

getOnlineStatus(String userId)
REST（客户端）since 1.0.0
参数
参数类型说明
userIdstring必填；用户 ID
返回

{userId:string, online:bool, sessionCount:uint32} 单用户在线状态

示例
Dart
final res = await engine.getOnlineStatus('user2');
if (res.code != 0) throw Exception(res.msg);
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1004USER_NOT_FOUND客户端 / 参数 / 权限404否用户不存在

getOnlineStatusBatch​

批量在线状态（<=100）。

getOnlineStatusBatch(List<String> userIds)
REST（客户端）since 1.0.0
参数
参数类型说明
userIdsstring[]必填；用户 ID 列表（批量接口通常有上限）
返回

{items:[{userId:string,online:bool,sessionCount:uint32}]} 批量在线状态

示例
Dart
final res = await engine.getOnlineStatusBatch(['user2']);
if (res.code != 0) throw Exception(res.msg);
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误

相关文档​