Presence

  • C++

更新时间

Presence 提供用户在线状态查询、频道成员查询,以及临时状态管理和变更通知能力。通过 Presence,你可以获取以下信息:

  • 查询当前 App ID 下指定用户的 RTM 在线状态
  • 用户加入或离开指定频道的实时事件通知
  • 自定义临时用户状态及其变更实时事件通知
  • 查询指定用户加入或订阅了哪些频道
  • 查询指定频道有哪些用户加入及其用户临时状态数据

信息

Presence 的频道相关能力适用于 Message Channel 和 Stream Channel。

getUserOnlineStatus

接口描述

查询当前 App ID 下指定用户是否存在有效的 RTM 登录连接。每次查询一个 User ID,支持查询自己;查询方和目标用户均无需加入或订阅频道。

接口方法

C++
virtual void getUserOnlineStatus(const char* userId, uint64_t& requestId) = 0;
参数类型是否必填默认值描述
userIdconst char*必填-目标用户的精确 User ID,须符合 RTM User ID 规则。查询自己时也须传入完整 User ID,空字符串不代表自己。
requestIduint64_t&必填-输出请求 ID,用于关联结果回调。
表格内容超出当前宽度,可横向滚动查看更多列。

注意事项

  • 调用方须具有可用的 MESSAGE service,且 MESSAGE session 已连接。该查询不依赖 Presence 服务开关或 Sync Database 就绪。
  • 结果是服务端响应时刻的状态快照。异常断网后,服务端需要经过失联检测窗口才能判定用户离线。该接口不提供最后在线时间或在线状态变更订阅。
  • logout 会取消在途请求;release 会清理请求资源,不保证客户端释放后仍会回调。重复或晚到的响应不会使同一请求重复完成。

基本用法

以下示例假设客户端已初始化、登录成功且 session 已连接。

初始化客户端前,通过 RtmConfig.eventHandler 注册处理器,并确保处理器在客户端使用期间持续有效。参见初始化。下面的回调复制 UID 字符串和布尔值;仅浅拷贝 UserOnlineStatus 会保留借用的指针。

C++
#include <cstdio>
#include <string>

class RtmEventHandler : public IRtmEventHandler {
public:
    void onGetUserOnlineStatusResult(const uint64_t requestId,
                                    const UserOnlineStatus* status,
                                    RTM_ERROR_CODE errorCode) override {
        if (errorCode != RTM_ERROR_OK) {
            std::printf("Query %llu failed: %d\n",
                        static_cast<unsigned long long>(requestId), errorCode);
            return;
        }
        if (status == nullptr) {
            std::printf("No usable result\n");
            return;
        }
        // Copy both fields before returning from the callback.
        const std::string userId(status->userId);
        const bool online = status->online;
        if (online) {
            std::printf("%s is online\n", userId.c_str());
        } else {
            std::printf("%s is offline or does not exist\n", userId.c_str());
        }
    }
};
C++
uint64_t requestId;
rtmClient->getPresence()->getUserOnlineStatus("targetUserId", requestId);

使用说明见查询用户在线状态。

错误码

数值名称触发条件
-10006RTM_ERROR_INVALID_USER_IDuserId 为 nullptr、空字符串或非法 UID。
-10025RTM_ERROR_NOT_CONNECTED调用方 session 未连接。
-10022RTM_ERROR_SERVICE_NOT_SUPPORTED私有配置的 service 未包含 MESSAGE。
-10021RTM_ERROR_OPERATION_RATE_EXCEED_LIMITATION本接口调用频率超过限制。默认每个 RtmClient 实例内独立计数,限额为 20 次/秒,不与其他 API 共用配额。
-13012RTM_ERROR_PRESENCE_OPERATION_TIMEOUT5 秒内未收到有效响应,SDK 不做超时重试。
-13013RTM_ERROR_PRESENCE_OPERATION_FAILED响应条目数不是 1,或返回的 UID 与请求不匹配。
-13015RTM_ERROR_PRESENCE_PENDING_REQUEST_CANCELLEDlogout 取消在途请求。
表格内容超出当前宽度,可横向滚动查看更多列。

UserOnlineStatus

查询成功时通过结果回调返回以下字段;失败时 status 为 nullptr,没有可用的在线状态。

属性类型描述
userIdconst char*被查询的 UID。
onlinebooltrue:存在有效的 RTM 登录连接;false:用户离线或不存在。
表格内容超出当前宽度,可横向滚动查看更多列。

status 及 status->userId 仅在回调期间有效。如需保留结果,应用必须复制字符串和布尔值。

onGetUserOnlineStatusResult

单次 getUserOnlineStatus 请求的结果回调,不是在线状态变更事件。

C++
virtual void onGetUserOnlineStatusResult(const uint64_t requestId,
                                        const UserOnlineStatus* status,
                                        RTM_ERROR_CODE errorCode);
参数类型描述
requestIdconst uint64_t方法输出的请求 ID。
statusconst UserOnlineStatus*成功时非空,失败时为 nullptr。对象及其 userId 字符串仅在本次回调期间有效。
errorCodeRTM_ERROR_CODE成功时为 RTM_ERROR_OK,否则为上表所列错误码。
表格内容超出当前宽度,可横向滚动查看更多列。

whoNow

接口描述

调用 whoNow 方法,你可以实时查询指定频道的在线用户数量、在线用户列表及在线用户的临时状态等信息。

接口方法

你可以通过以下方式调用 whoNow 方法:

C++
virtual void whoNow(const char* channelName, RTM_CHANNEL_TYPE channelType, const PresenceOptions& options, uint64_t& requestId) = 0;
参数类型是否必填默认值描述
channelNameconst char*必填-频道名称。
channelTypeRTM_CHANNEL_TYPE必填-频道类型。详见 RTM_CHANNEL_TYPE。
optionsconst PresenceOptions&必填-查询附加选项。
requestIduint64_t&必填-(输出参数)请求标识符,后续用于识别和处理相应的请求。
表格内容超出当前宽度,可横向滚动查看更多列。

PresenceOptions 数据类型包含以下属性:

属性类型是否必填默认值描述
includeUserIdbool选填true返回结果中是否包含在线成员的用户 ID。
includeStatebool选填false返回结果中是否包含在线用户的临时状态数据。
pageconst char*选填NULL页码书签。如果不填写,则 SDK 默认返回第一页结果。你可以在返回值中查看是否还有下一页。
表格内容超出当前宽度,可横向滚动查看更多列。

异步回调

调用该方法后,SDK 会触发 onWhoNowResult 回调并通过以下参数返回 API 调用结果:

参数类型描述
requestIdconst uint64_t请求标识符。
userStateListconst UserState*频道在线用户及其临时状态信息列表。
countconst size_tUserState 列表长度,当 whoNow 属性中 includeUserId、includeState 属性都设置为 false 时,此值表示频道当前总在线人数。
nextPageconst char*

下一页书签。通过该属性可以确认是否有下一页:

  • 值为空表示没有下一页。
  • 值不为空表示有下一页。你可以将该值填写在 whoNow 的 page 属性中,从而查询下一页结果。
errorCodeRTM_ERROR_CODE错误码,详见错误排查。
表格内容超出当前宽度,可横向滚动查看更多列。

UserState 数据类型包含以下属性:

属性类型描述
userIdconst char*用户 ID。
statesconst StateItem*频道在线用户及其临时状态信息列表。
statesCountsize_t用户状态的数量。
表格内容超出当前宽度,可横向滚动查看更多列。

StateItem 数据类型包含以下属性:

属性类型描述
keyconst char*用户状态的键。如果指定的键已经存在,则该键的值会被新值覆盖;如果指定的键不存在,则 SDK 会新增该键/值对。
valueconst char*用户状态的值。
表格内容超出当前宽度,可横向滚动查看更多列。

基本用法

C++
// 方法调用
PresenceOptions options;
options.includeState = true;
options.includeUserId =true;
options.page = "yourBookMark";

uint64_t requestId;
rtmClient->getPresence()->whoNow("channelName", RTM_CHANNEL_TYPE_MESSAGE, options, requestId);

whereNow

接口描述

在数据统计、App 调试等场景中,你可能需要了解指定用户订阅或加入的所有频道。调用 whereNow 方法,你可以实时获取指定用户所在频道的列表。

接口方法

你可以通过以下方式调用 whereNow 方法:

C++
virtual void whereNow(const char* userId, uint64_t& requestId) = 0;
参数类型是否必填默认值描述
userIdconst char*必填-用户 ID。
requestIduint64_t&必填-(输出参数)请求标识符,后续用于识别和处理相应的请求。
表格内容超出当前宽度,可横向滚动查看更多列。

异步回调

调用该方法后,SDK 会触发 onWhereNowResult 回调并通过以下参数返回 API 调用结果:

参数类型描述
requestIdconst uint64_t请求标识符。
channelsconst ChannelInfo*频道信息。
countconst size_t频道数量。
errorCodeRTM_ERROR_CODE错误码,详见错误排查。
表格内容超出当前宽度,可横向滚动查看更多列。

ChannelInfo 数据类型包含以下属性:

属性类型描述
channelNameconst char*频道名称。
channelTypeRTM_CHANNEL_TYPE频道类型。详见 RTM_CHANNEL_TYPE。
表格内容超出当前宽度,可横向滚动查看更多列。

基本用法

C++
// 方法调用
uint64_t requestId;
rtmClient->getPresence()->whereNow("tony", requestId);

setState

接口描述

为满足不同业务场景对用户状态的设置需求,RTM 提供 setState 方法自定义临时用户状态。用户可以为自己添加分数、游戏状态、位置、心情、连麦状态等自定义状态。

设置成功后,只要用户保持订阅频道并一直在线,自定义状态就会在频道中持续存在。setState 方法设置的是临时用户状态,当用户离开频道或断开与 RTM 的连接时,状态会消失。如果需要在重新加入频道或者重新连接时恢复用户状态,你需要实时在本地缓存该数据。如果你希望永久保存用户状态数据,声网推荐改用 Storage 功能的 setUserMetadata 方法。

如果用户修改了临时用户状态,RTM 会实时触发 RTM_PRESENCE_EVENT_TYPE_REMOTE_STATE_CHANGED 类型的 onPresenceEvent 事件通知。你可以通过订阅频道并配置对应属性来接收该事件。

接口方法

你可以通过以下方式调用 setState 方法:

C++
virtual void setState(const char* channelName, RTM_CHANNEL_TYPE channelType, const StateItem* items, size_t count, uint64_t& requestId) = 0;
参数类型是否必填默认值描述
channelNameconst char*必填-频道名称
channelTypeRTM_CHANNEL_TYPE必填-频道类型。详见 RTM_CHANNEL_TYPE。
itemsconst StateItem*必填-用户状态。
countsize_t必填-用户状态的数量。
requestIduint64_t&必填-(输出参数)请求标识符,后续用于识别和处理相应的请求。
表格内容超出当前宽度,可横向滚动查看更多列。

StateItem 数据类型包含以下属性:

属性类型描述
keyconst char*用户状态的键。如果指定的键已经存在,则该键的值会被新值覆盖;如果指定的键不存在,则 SDK 会新增该键/值对。
valueconst char*用户状态的值。
表格内容超出当前宽度,可横向滚动查看更多列。

异步回调

调用该方法后,SDK 会触发 onPresenceSetStateResult 回调并通过以下参数返回 API 调用结果:

参数类型描述
requestIdconst uint64_t请求标识符。
errorCodeRTM_ERROR_CODE错误码,详见错误排查。
表格内容超出当前宽度,可横向滚动查看更多列。

基本用法

C++
// 方法调用
std::vector<StateItem> items;
StateItem item;
item.key = "mood";
item.value = "pumped";
items.push_back(item);

uint64_t requestId;
rtmClient->getPresence()->setState("channelName", RTM_CHANNEL_TYPE_MESSAGE, items.data(), items.size(), requestId);

getState

接口描述

如需获取指定频道中指定用户的临时用户状态,你可以调用 getState 方法。

接口方法

你可以通过以下方式调用 getState 方法:

C++
virtual void getState(const char* channelName, RTM_CHANNEL_TYPE channelType, const char* userId, uint64_t& requestId) = 0;
参数类型是否必填默认值描述
channelNameconst char*必填-频道名称。
channelTypeRTM_CHANNEL_TYPE必填-频道类型。详见 RTM_CHANNEL_TYPE。
userIdconst char*必填-用户 ID。
requestIduint64_t&必填-(输出参数)请求标识符,后续用于识别和处理相应的请求。
表格内容超出当前宽度,可横向滚动查看更多列。

异步回调

调用该方法后,SDK 会触发 onPresenceGetStateResult 回调并通过以下参数返回 API 调用结果:

参数类型描述
requestIdconst uint64_t请求标识符。
stateconst UserState&频道在线用户及其临时状态信息列表。
errorCodeRTM_ERROR_CODE错误码,详见错误排查。
表格内容超出当前宽度,可横向滚动查看更多列。

UserState 数据类型包含以下属性:

属性类型描述
userIdconst char*用户 ID。
statesconst StateItem*频道在线用户及其临时状态信息列表。
statesCountsize_t用户状态的数量。
表格内容超出当前宽度,可横向滚动查看更多列。

StateItem 数据类型包含以下属性:

属性类型描述
keyconst char*用户状态的键。如果指定的键已经存在,则该键的值会被新值覆盖;如果指定的键不存在,则 SDK 会新增该键/值对。
valueconst char*用户状态的值。
表格内容超出当前宽度,可横向滚动查看更多列。

基本用法

C++
// 方法调用
uint64_t requestId;
rtmClient->getPresence()->getState("channelName", RTM_CHANNEL_TYPE_MESSAGE, "tony", requestId);

removeState

接口描述

当不再需要某个临时用户状态时,你可以调用 removeState 方法删除自己的一个或多个临时状态。

成功删除用户状态后,订阅该频道且开启 Presence 事件监听的用户会收到 RTM_PRESENCE_EVENT_TYPE_REMOTE_STATE_CHANGED 类型的 onPresenceEvent 事件通知,详见事件监听。

接口方法

你可以通过以下方式调用 removeState 方法:

C++
virtual void removeState(const char* channelName, RTM_CHANNEL_TYPE channelType, const char** keys, size_t count, uint64_t& requestId) = 0;
参数类型是否必填默认值描述
channelNameconst char*必填-频道名称
channelTypeRTM_CHANNEL_TYPE必填-频道类型。详见 RTM_CHANNEL_TYPE。
keysconst char**必填-需要删除状态的 key 列表。如果不填写,则删除全部状态。
countsize_t必填-key 的数量。
requestIduint64_t&必填-(输出参数)请求标识符,后续用于识别和处理相应的请求。
表格内容超出当前宽度,可横向滚动查看更多列。

异步回调

调用该方法后,SDK 会触发 onPresenceRemoveStateResult 回调并通过以下参数返回 API 调用结果:

参数类型描述
requestIdconst uint64_t请求标识符。
errorCodeRTM_ERROR_CODE错误码,详见错误排查。
表格内容超出当前宽度,可横向滚动查看更多列。

基本用法

C++
// 方法调用
std::vector<const char*> keys;
keys.push_back("key0");
keys.push_back("key1");
keys.push_back("key2");

uint64_t requestId;
rtmClient->getPresence()->removeState("channelName", RTM_CHANNEL_TYPE_MESSAGE, keys.data(), keys.size(), requestId);