v2::V2NIMSubscriptionService类 参考

#include <v2_nim_subscription_service.hpp>

Public 成员函数
virtual void	subscribeUserStatus (const V2NIMSubscribeUserStatusOption &option, const V2NIMSuccessCallback< const nstd::vector< nstd::string > & > &success, const V2NIMFailureCallback &failure)=0
virtual void	unsubscribeUserStatus (const V2NIMUnsubscribeUserStatusOption &option, const V2NIMSuccessCallback< nstd::vector< nstd::string > > &success, const V2NIMFailureCallback &failure)=0
	取消用户状态订阅请求
virtual void	publishCustomUserStatus (const V2NIMCustomUserStatusParams &params, const V2NIMSuccessCallback< const V2NIMCustomUserStatusPublishResult & > &success, const V2NIMFailureCallback &failure)=0
	发布用户自定义状态，如果默认在线状态不满足业务需求，可以发布自定义用户状态
virtual void	queryUserStatusSubscriptions (const nstd::vector< nstd::string > &accountIds, const V2NIMSuccessCallback< const nstd::vector< V2NIMUserStatusSubscribeResult > & > &success, const V2NIMFailureCallback &failure)=0
	查询用户状态订阅关系，输入账号列表查询自己订阅了哪些账号列表。返回订阅账号列表
virtual void	addSubscribeListener (const V2NIMSubscribeListener &listener)=0
	添加用户状态订阅的监听器
virtual void	removeSubscribeListener (const V2NIMSubscribeListener &listener)=0
	移除用户状态订阅的监听器

成员函数说明

addSubscribeListener()

virtual void v2::V2NIMSubscriptionService::addSubscribeListener ( const V2NIMSubscribeListener &  listener )

pure virtual

添加用户状态订阅的监听器

参数

listener

用户状态订阅监听器 V2NIMSubscribeListener

返回

void

示例代码

V2NIMSubscribeListener listener;
listener.onUserStatusChanged = [](nstd::vector<V2NIMUserStatusEvent> events) {
    // handle user status changed event
};
subscriptionService.addSubscribeListener(listener);

publishCustomUserStatus()

virtual void v2::V2NIMSubscriptionService::publishCustomUserStatus ( const V2NIMCustomUserStatusParams &  params, const V2NIMSuccessCallback< const V2NIMCustomUserStatusPublishResult & > &  success, const V2NIMFailureCallback &  failure  )

pure virtual

发布用户自定义状态，如果默认在线状态不满足业务需求，可以发布自定义用户状态

参数

params	发布自定义用户状态参数 V2NIMCustomUserStatusParams
success	成功回调
failure	失败回调

返回

void

示例代码

V2NIMCustomUserStatusParams params;
params.statusType = 100001;
subscriptionService.publishCustomUserStatus(
    params,
    []() {
        // publish custom user status succeeded
    },
    [](V2NIMError error) {
        // publish custom user status failed, handle error
    });

queryUserStatusSubscriptions()

virtual void v2::V2NIMSubscriptionService::queryUserStatusSubscriptions ( const nstd::vector< nstd::string > &  accountIds, const V2NIMSuccessCallback< const nstd::vector< V2NIMUserStatusSubscribeResult > & > &  success, const V2NIMFailureCallback &  failure  )

pure virtual

查询用户状态订阅关系，输入账号列表查询自己订阅了哪些账号列表。返回订阅账号列表

参数

accountIds	账号列表
success	成功回调，返回订阅账号列表
failure	失败回调

返回

void

示例代码

nstd::vector<nstd::string> accountIds;
accountIds.push_back("account1");
subscriptionService.queryUserStatusSubscriptions(
    accountIds,
    [](nstd::vector<nstd::string> subscribedAccounts) {
        // query user status subscribe succeeded
    },
    [](V2NIMError error) {
        // query user status subscribe failed, handle error
    });

removeSubscribeListener()

virtual void v2::V2NIMSubscriptionService::removeSubscribeListener ( const V2NIMSubscribeListener &  listener )

pure virtual

移除用户状态订阅的监听器

参数

listener

用户状态订阅监听器 V2NIMSubscribeListener

返回

void

示例代码

subscriptionService.removeSubscribeListener(listener);

subscribeUserStatus()

virtual void v2::V2NIMSubscriptionService::subscribeUserStatus ( const V2NIMSubscribeUserStatusOption &  option, const V2NIMSuccessCallback< const nstd::vector< nstd::string > & > &  success, const V2NIMFailureCallback &  failure  )

pure virtual

订阅用户状态，包括在线状态，或自定义状态。单次订阅人数最多 100，如果有较多人数需要调用需多次调用该接口 如果同一账号多端重复订阅，订阅有效期会默认后一次覆盖前一次时长。 总订阅人数最多 3000，当被订阅人数为 3000 时，为了性能考虑，在线状态事件订阅是单向的，双方需要各自订阅。 如果接口整体失败，则返回调用错误码 如果部分账号失败，则返回失败账号列表 订阅接口后，有成员在线状态变更会触发回调：onUserStatusChanged

参数

option	订阅用户状态选项 V2NIMSubscribeUserStatusOption
success	成功回调，包含部分订阅失败的账号列表
failure	失败回调

返回

void

示例代码

V2NIMSubscribeUserStatusOption option;
option.accountIds.push_back("account1");
subscriptionService.subscribeUserStatus(
    option,
    [](nstd::vector<nstd::string> failedAccounts) {
        // subscribe user status succeeded
    },
    [](V2NIMError error) {
        // subscribe user status failed, handle error
    });

unsubscribeUserStatus()

virtual void v2::V2NIMSubscriptionService::unsubscribeUserStatus ( const V2NIMUnsubscribeUserStatusOption &  option, const V2NIMSuccessCallback< nstd::vector< nstd::string > > &  success, const V2NIMFailureCallback &  failure  )

pure virtual

取消用户状态订阅请求

参数

option	取消订阅用户状态选项 V2NIMSubscribeUserStatusOption
success	成功回调，包含部分取消订阅失败的账号列表
failure	失败回调

返回

void

示例代码

V2NIMUnsubscribeUserStatusOption option;
option.accountIds.push_back("account1");
subscriptionService.unsubscribeUserStatus(
    option,
    [](nstd::vector<nstd::string> failedAccounts) {
        // unsubscribe user status succeeded
    },
    [](V2NIMError error) {
        // unsubscribe user status failed, handle error
    });

---

该类的文档由以下文件生成:

• D:/GitLab/builds/7_aFT3sv/0/nim-pc/california/nim-cross-platform-sdk/exports/include/v2_nim_subscription_service.hpp