Presence
- Android
更新时间
Presence 提供用户在线状态查询、频道成员查询,以及临时状态管理和变更通知能力。通过 Presence,你可以获取以下信息:
- 查询当前 App ID 下指定用户的 RTM 在线状态
- 用户加入或离开指定频道的实时事件通知
- 自定义临时用户状态及其变更实时事件通知
- 查询指定用户加入或订阅了哪些频道
- 查询指定频道有哪些用户加入及其用户临时状态数据
信息
Presence 的频道相关能力适用于 Message Channel 和 Stream Channel。
getUserOnlineStatus
接口描述
查询当前 App ID 下指定用户是否存在有效的 RTM 登录连接。每次查询一个 User ID,支持查询自己;查询方和目标用户均无需加入或订阅频道。
接口方法
void getUserOnlineStatus(String userId, ResultCallback<UserOnlineStatus> resultCallback);| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
userId | String | 必填 | - | 目标用户的精确 User ID,须符合 RTM User ID 规则。查询自己时也须传入完整 User ID,空字符串不代表自己。 |
resultCallback | ResultCallback<UserOnlineStatus> | 必填 | - | 成功时通过 onSuccess 返回 UserOnlineStatus,失败时通过 onFailure 返回 ErrorInfo。 |
注意事项
- 调用方须具有可用的 MESSAGE service,且 MESSAGE session 已连接。该查询不依赖 Presence 服务开关或 Sync Database 就绪。
- 结果是服务端响应时刻的状态快照。异常断网后,服务端需要经过失联检测窗口才能判定用户离线。该接口不提供最后在线时间或在线状态变更订阅。
logout会取消在途请求;release会清理请求资源,不保证客户端释放后仍会回调。重复或晚到的响应不会使同一请求重复完成。
基本用法
以下示例假设客户端已初始化、登录成功且 session 已连接。
rtmClient.getPresence().getUserOnlineStatus("targetUserId", new ResultCallback<UserOnlineStatus>() {
@Override
public void onSuccess(UserOnlineStatus status) {
if (status.isOnline()) {
System.out.println(status.getUserId() + " is online");
} else {
System.out.println(status.getUserId() + " is offline or does not exist");
}
}
@Override
public void onFailure(ErrorInfo errorInfo) {
System.err.println("Query failed: " + errorInfo);
}
});使用说明见查询用户在线状态。
错误码
| 数值 | 名称 | 触发条件 |
|---|---|---|
-10006 | INVALID_USER_ID | userId 为 null、空字符串或非法 UID。 |
-10025 | NOT_CONNECTED | 调用方 session 未连接。 |
-10022 | SERVICE_NOT_SUPPORTED | 私有配置的 service 未包含 MESSAGE。 |
-10021 | OPERATION_RATE_EXCEED_LIMITATION | 本接口调用频率超过限制。默认每个 RtmClient 实例内独立计数,限额为 20 次/秒,不与其他 API 共用配额。 |
-13012 | PRESENCE_OPERATION_TIMEOUT | 5 秒内未收到有效响应,SDK 不做超时重试。 |
-13013 | PRESENCE_OPERATION_FAILED | 响应条目数不是 1,或返回的 UID 与请求不匹配。 |
-13015 | PRESENCE_PENDING_REQUEST_CANCELLED | logout 取消在途请求。 |
UserOnlineStatus
查询成功时通过 onSuccess 返回以下字段;失败时通过 onFailure 返回错误,不表示目标用户离线。
| 属性 | 类型 | 描述 |
|---|---|---|
userId | String | 被查询的 UID。 通过 getUserId() 读取。 |
online | boolean | true:存在有效的 RTM 登录连接;false:用户离线或不存在。 通过 isOnline() 读取。 |
whoNow
接口描述
调用 whoNow 方法,你可以实时查询指定频道的在线用户数量、在线用户列表及在线用户的临时状态等信息。
接口方法
你可以通过以下方式调用 whoNow 方法:
void whoNow(
String channelName,
RtmChannelType channelType,
PresenceOptions options,
ResultCallback<WhoNowResult> resultCallback
);| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
channelName | string | 必填 | - | 频道名称。 |
channelType | RtmChannelType | 必填 | - | 频道类型。详见 RtmChannelType。 |
options | PresenceOptions | 必填 | - | 查询附加选项。 |
resultCallback | ResultCallback<WhoNowResult> | 必填 | - | 调用结果回调:
|
options 参数包含以下属性:
| 属性 | 类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
includeUserId | boolean | 选填 | true | 返回结果中是否包含在线成员的用户 ID。 |
includeState | boolean | 选填 | false | 返回结果中是否包含在线用户的临时状态数据。 |
page | String | 选填 | - | 页码书签。如果不填写,则 SDK 默认返回第一页结果。你可以在返回值中查看是否还有下一页。 |
WhoNowResult 数据包含以下属性:
| 属性 | 类型 | 描述 |
|---|---|---|
NextPage | String | 下一页书签。通过该属性可以确认是否有下一页:
|
UserStateList | ArrayList<UserState> | 频道在线用户及其临时状态信息列表。 |
totalOccupancy | long | UserStateList 列表长度,当 whoNow 属性中 includeUserId、includeState 属性都设置为 false 时,此值表示频道当前总在线人数。 |
UserState 数据类型包含如下属性:
| 属性 | 类型 | 描述 |
|---|---|---|
userId | String | 用户 ID。 |
states | HashMap<String, String> | 用户临时状态数组。 |
基本用法
PresenceOptions options = new PresenceOptions();
options.setIncludeUserId(true);
options.setIncludeState(true);
options.setPage("yourBookMark");
rtmClient.getPresence().whoNow("channelName", RtmChannelType.MESSAGE, options, new ResultCallback<WhoNowResult>() {
@Override
public void onSuccess(WhoNowResult result) {
log(CALLBACK, "whoNow success");
for (UserState state : result.getUserStateList()) {
log(INFO, "user id: " + state.getUserId());
state.getStates().forEach((key, value) -> {
log(INFO, "key: " + key + ", value: " + value);
});
}
}
@Override
public void onFailure(ErrorInfo errorInfo) {
log(ERROR, errorInfo.toString());
}
});whereNow
接口描述
在数据统计、App 调试等场景中,你可能需要了解指定用户订阅或加入的所有频道。调用 whereNow 方法,你可以实时获取指定用户所在频道的列表。
接口方法
你可以通过以下方式调用 whereNow 方法:
void whereNow(
String userId,
ResultCallback<ArrayList<ChannelInfo>> resultCallback
);| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
userId | string | 必填 | - | 用户 ID。 |
resultCallback | ResultCallback<ArrayList<ChannelInfo>> | 必填 | - | 调用结果回调:
|
ChannelInfo数据类型包含以下属性:
| 属性 | 类型 | 描述 |
|---|---|---|
channelName | String | 频道名称。 |
channelType | RtmChannelType | 频道类型。详见 RtmChannelType。 |
基本用法
rtmClient.getPresence().whereNow("Tony", new ResultCallback<ArrayList<ChannelInfo>>() {
@Override
public void onSuccess(ArrayList<ChannelInfo> channels) {
log(CALLBACK, "get " + queryUserId + " whereNow success");
for (ChannelInfo channel : channels) {
log(INFO, channel.toString());
}
}
@Override
public void onFailure(ErrorInfo errorInfo) {
log(ERROR, errorInfo.toString());
}
});setState
接口描述
为满足不同业务场景对用户状态的设置需求,RTM 提供 setState 方法自定义临时用户状态。用户可以为自己添加分数、游戏状态、位置、心情、连麦状态等自定义状态。
设置成功后,只要用户保持订阅频道并一直在线,自定义状态就会在频道中持续存在。setState 方法设置的是临时用户状态,当用户离开频道或断开与 RTM 的连接时,状态会消失。如果需要在重新加入频道或者重新连接时恢复用户状态,你需要实时在本地缓存该数据。如果你希望永久保存用户状态数据,声网推荐改用 Storage 功能的 setUserMetadata 方法。
如果用户修改了临时用户状态,RTM 会实时触发 REMOTE_STATE_CHANGED 类型的 onPresenceEvent 事件通知。你可以通过订阅频道并配置对应属性来接收该事件。
接口方法
你可以通过以下方式调用 setState 方法:
void setState(
String channelName,
RtmChannelType channelType,
Map<String, String> items,
ResultCallback<Void> resultCallback
);| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
channelName | String | 必填 | - | 频道名称 |
channelType | RtmChannelType | 必填 | - | 频道类型。详见 RtmChannelType。 |
items | Map<String, String> | 必填 | - | 用户状态键值对。 |
resultCallback | ResultCallback<Void> | 必填 | - | 调用结果回调:
|
基本用法
HashMap<String, String> stateItems = new HashMap<String, String>();
stateItems.put("mood", "pumped");
rtmClient.getPresence().setState("channelName", RtmChannelType.MESSAGE, stateItems, new ResultCallback<Void>() {
@Override
public void onSuccess(Void responseInfo) {
log(CALLBACK, "set state success");
}
@Override
public void onFailure(ErrorInfo errorInfo) {
log(ERROR, errorInfo.toString());
}
});getState
接口描述
如需获取指定频道中指定用户的临时用户状态,你可以调用 getState 方法。
接口方法
你可以通过以下方式调用 getState 方法:
void getState(
String channelName,
RtmChannelType channelType,
String userId,
ResultCallback<UserState> resultCallback
)| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
channelName | String | 必填 | - | 频道名称。 |
channelType | RtmChannelType | 必填 | - | 频道类型。详见 RtmChannelType。 |
userId | String | 必填 | - | 用户 ID。 |
resultCallback | ResultCallback<UserState> | 必填 | - | 调用结果回调:
|
UserState 数据类型包含如下属性:
| 属性 | 类型 | 描述 |
|---|---|---|
userId | String | 用户 ID。 |
states | HashMap<String, String> | 用户临时状态数组。 |
基本用法
rtmClient.getPresence().getState("channelName", RtmChannelType.MESSAGE, "Tony", new ResultCallback<UserState>() {
@Override
public void onSuccess(UserState state) {
log(CALLBACK, "get users(" + state.getUserId() + ") state success");
state.getStates().forEach((key, value) -> {
log(INFO, "key: " + key + ", value: " + value);
});
}
@Override
public void onFailure(ErrorInfo errorInfo) {
log(ERROR, errorInfo.toString());
}
});removeState
接口描述
当不再需要某个临时用户状态时,你可以调用 removeState 方法删除自己的一个或多个临时状态。成功删除用户状态后,订阅该频道且开启 Presence 事件监听的用户会收到 REMOTE_STATE_CHANGED 类型的 onPresenceEvent 事件通知,详见事件监听。
接口方法
你可以通过以下方式调用 removeState 方法:
void removeState(
String channelName,
RtmChannelType channelType,
ArrayList<String> keys,
ResultCallback<Void> resultCallback
);| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
channelName | String | 必填 | - | 频道名称 |
channelType | RtmChannelType | 必填 | - | 频道类型。详见 RtmChannelType。 |
keys | ArrayList<String> | 必填 | - | 需要删除状态的 key 列表。如果不填写,则删除全部状态。 |
resultCallback | ResultCallback<Void> | 必填 | - | 调用结果回调:
|
基本用法
ArrayList<String> keys = new ArrayList<>(Arrays.asList("A", "B", "C"));
rtmClient.getPresence().removeState("channelName", RtmChannelType.MESSAGE, keys, new ResultCallback<Void>() {
@Override
public void onSuccess(Void responseInfo) {
log(CALLBACK, "remove state success");
}
@Override
public void onFailure(ErrorInfo errorInfo) {
log(ERROR, errorInfo.toString());
}
});