NIM SDK API  9.0.0
Public Types | Static Public Member Functions | List of all members
nim::SubscribeEvent Class Reference

NIM 订阅事件相关接口 More...

#include <nim_cpp_subscribe_event.h>

Public Types

typedef std::function< void(NIMResCode res_code, const nim::EventData &event_data)> PushEventCallback
 
typedef std::function< void(NIMResCode res_code, const std::list< nim::EventData > &event_list)> BatchPushEventCallback
 
typedef std::function< void(NIMResCode res_code, int event_type, const nim::EventData &event_data)> PublishEventCallback
 
typedef std::function< void(NIMResCode res_code, int event_type, const std::list< std::string > &faild_list)> SubscribeEventCallback
 
typedef std::function< void(NIMResCode res_code, int event_type, const std::list< std::string > &faild_list)> UnSubscribeEventCallback
 
typedef std::function< void(NIMResCode res_code, int event_type)> BatchUnSubscribeEventCallback
 
typedef std::function< void(NIMResCode res_code, int event_type, const std::list< nim::EventSubscribeData > &subscribe_list)> QuerySubscribeEventCallback
 
typedef std::function< void(NIMResCode res_code, int event_type, const std::list< nim::EventSubscribeData > &subscribe_list)> BatchQuerySubscribeEventCallback
 

Static Public Member Functions

static void RegPushEventCb (const PushEventCallback &cb, const std::string &json_extension="")
 
static void RegBatchPushEventCb (const BatchPushEventCallback &cb, const std::string &json_extension="")
 
static bool Publish (const EventData &event_data, const PublishEventCallback &cb, const std::string &json_extension="")
 
static bool Subscribe (int event_type, int64_t ttl, NIMEventSubscribeSyncEventType sync_type, const std::list< std::string > &accid_list, const SubscribeEventCallback &cb, const std::string &json_extension="")
 
static bool UnSubscribe (int event_type, const std::list< std::string > &accid_list, const UnSubscribeEventCallback &cb, const std::string &json_extension="")
 
static bool BatchUnSubscribe (int event_type, const BatchUnSubscribeEventCallback &cb, const std::string &json_extension="")
 
static bool QuerySubscribe (int event_type, const std::list< std::string > &accid_list, const QuerySubscribeEventCallback &cb, const std::string &json_extension="")
 

Detailed Description

NIM 订阅事件相关接口

Member Typedef Documentation

◆ BatchPushEventCallback

typedef std::function<void(NIMResCode res_code, const std::list<nim::EventData>& event_list)> nim::SubscribeEvent::BatchPushEventCallback

批量接收订阅事件回调模板

◆ BatchQuerySubscribeEventCallback

typedef std::function<void(NIMResCode res_code, int event_type, const std::list<nim::EventSubscribeData>& subscribe_list)> nim::SubscribeEvent::BatchQuerySubscribeEventCallback

查询指定事件的全部订阅关系回调模板

◆ BatchUnSubscribeEventCallback

typedef std::function<void(NIMResCode res_code, int event_type)> nim::SubscribeEvent::BatchUnSubscribeEventCallback

取消指定事件的全部订阅关系回调模板

◆ PublishEventCallback

typedef std::function<void(NIMResCode res_code, int event_type, const nim::EventData& event_data)> nim::SubscribeEvent::PublishEventCallback

发布事件回调模板

◆ PushEventCallback

typedef std::function<void(NIMResCode res_code, const nim::EventData& event_data)> nim::SubscribeEvent::PushEventCallback

接收订阅事件回调模板

◆ QuerySubscribeEventCallback

typedef std::function<void(NIMResCode res_code, int event_type, const std::list<nim::EventSubscribeData>& subscribe_list)> nim::SubscribeEvent::QuerySubscribeEventCallback

按帐号查询指定事件的订阅关系回调模板

◆ SubscribeEventCallback

typedef std::function<void(NIMResCode res_code, int event_type, const std::list<std::string>& faild_list)> nim::SubscribeEvent::SubscribeEventCallback

订阅事件回调模板

◆ UnSubscribeEventCallback

typedef std::function<void(NIMResCode res_code, int event_type, const std::list<std::string>& faild_list)> nim::SubscribeEvent::UnSubscribeEventCallback

按账号取消指定事件的订阅关系回调模板

Member Function Documentation

◆ BatchUnSubscribe()

static bool nim::SubscribeEvent::BatchUnSubscribe ( int  event_type,
const BatchUnSubscribeEventCallback &  cb,
const std::string &  json_extension = "" 
)
static

取消指定事件的全部订阅关系

Parameters
[in]event_type事件类型
[in]cb取消订阅事件回调函数
[in]json_extensionjson扩展参数（备用，目前不需要）
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功 414:参数错误 500:未知错误

◆ Publish()

static bool nim::SubscribeEvent::Publish ( const EventData &  event_data,
const PublishEventCallback &  cb,
const std::string &  json_extension = "" 
)
static

发布事件

Parameters
[in]event_data事件
[in]cb发布事件回调函数
[in]json_extensionjson扩展参数（备用，目前不需要）
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功 403:应用没开通事件服务 404:禁用了特定事件 414:参数错误 500:未知错误

◆ QuerySubscribe()

static bool nim::SubscribeEvent::QuerySubscribe ( int  event_type,
const std::list< std::string > &  accid_list,
const QuerySubscribeEventCallback &  cb,
const std::string &  json_extension = "" 
)
static

按账号查询指定事件订阅关系

Parameters
[in]event_type事件类型
[in]accid_list要查询订阅关系的用户列表
[in]cb查询订阅关系回调函数
[in]json_extensionjson扩展参数（备用，目前不需要）
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功 414:参数错误 500:未知错误

◆ RegBatchPushEventCb()

static void nim::SubscribeEvent::RegBatchPushEventCb ( const BatchPushEventCallback &  cb,
const std::string &  json_extension = "" 
)
static

(全局回调)统一注册批量接收订阅的事件的回调函数

Parameters
[in]cb批量接收订阅事件回调函数
[in]json_extensionjson扩展参数（备用，目前不需要）
Returns
void 无返回值
Note
错误码 200:成功

◆ RegPushEventCb()

static void nim::SubscribeEvent::RegPushEventCb ( const PushEventCallback &  cb,
const std::string &  json_extension = "" 
)
static

(全局回调)统一注册接收订阅的事件的回调函数

Parameters
[in]cb接收订阅事件回调函数
[in]json_extensionjson扩展参数（备用，目前不需要）
Returns
void 无返回值
Note
错误码 200:成功

◆ Subscribe()

static bool nim::SubscribeEvent::Subscribe ( int  event_type,
int64_t  ttl,
NIMEventSubscribeSyncEventType  sync_type,
const std::list< std::string > &  accid_list,
const SubscribeEventCallback &  cb,
const std::string &  json_extension = "" 
)
static

订阅事件

Parameters
[in]event_type事件类型
[in]ttl订阅有效期，单位：秒，范围：60s到30天
[in]sync_type订阅后是否立即同步最新事件
[in]accid_list要订阅的用户列表
[in]cb订阅事件回调函数
[in]json_extensionjson扩展参数（备用，目前不需要）
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功 414:参数错误 500:未知错误

◆ UnSubscribe()

static bool nim::SubscribeEvent::UnSubscribe ( int  event_type,
const std::list< std::string > &  accid_list,
const UnSubscribeEventCallback &  cb,
const std::string &  json_extension = "" 
)
static

按账号取消指定事件的订阅关系

Parameters
[in]event_type事件类型
[in]accid_list要取消订阅的用户列表
[in]cb取消订阅事件回调函数
[in]json_extensionjson扩展参数（备用，目前不需要）
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功 414:参数错误 500:未知错误
The documentation for this class was generated from the following file:
Generated on Mon Mar 14 2022 17:10:05 for NIM SDK API by   doxygen 1.8.17