NIM CPP SDK  7.8.1
Public Types | Static Public Member Functions | List of all members
nim::TalkEx::PinMsg Class Reference

Public Types

using PinMessageCallback = std::function< void(int code, const std::string &session, int to_type, const PinMessageInfo &)>
 
using UnPinMessageCallback = std::function< void(int code, const std::string &session, int to_type, const std::string &)>
 
using UpdatePinMessageCallback = std::function< void(int code, const std::string &session, int to_type, const PinMessageInfo &)>
 
using QueryPinMessageCallback = std::function< void(int code, const std::string &session, int to_type, const QueryAllPinMessageResponse &)>
 
using AddPinMessageNotifyCallback = std::function< void(const std::string &session, int to_type, const PinMessageInfo &)>
 
using UnPinMessageNotifyCallback = std::function< void(const std::string &session, int to_type, const std::string &id)>
 
using UpdatePinMessageNotifyCallback = std::function< void(const std::string &session, int to_type, const PinMessageInfo &)>
 

Static Public Member Functions

static void AddPinMessage (const IMMessage &msg, const PinMessageInfo &pin_info, const PinMessageCallback &cb)
 
static void UnPinMessage (const ModifyPinMessageParam &modify_param, const UnPinMessageCallback &cb)
 
static void UpdatePinMessage (const ModifyPinMessageParam &modify_param, const UpdatePinMessageCallback &cb)
 
static void QueryAllPinMessage (const std::string &session, int to_type, const QueryPinMessageCallback &cb)
 
static void UnregAllCb ()
 
static void RegAddPinMessage (const AddPinMessageNotifyCallback &cb)
 
static void RegUnPinMessage (const UnPinMessageNotifyCallback &cb)
 
static void RegUpdatePinMessage (const UpdatePinMessageNotifyCallback &cb)
 

Member Function Documentation

◆ AddPinMessage()

void nim::TalkEx::PinMsg::AddPinMessage ( const IMMessage msg,
const PinMessageInfo pin_info,
const PinMessageCallback &  cb 
)
static

Pin某条消息

Parameters
[in]msg要Pin的消息
[in]pin_infoPin的内容 只需赋值 ext参数,其它参数SDK来补充
[in]cb执行结果回调函数
Returns
void 无返回值

◆ QueryAllPinMessage()

void nim::TalkEx::PinMsg::QueryAllPinMessage ( const std::string &  session,
int  to_type,
const QueryPinMessageCallback &  cb 
)
static

查询会话的所有 Pin Message

Parameters
[in]session会话ID
[in]to_type会话类型
[in]cb执行结果回调函数
Returns
void 无返回值

◆ RegAddPinMessage()

void nim::TalkEx::PinMsg::RegAddPinMessage ( const AddPinMessageNotifyCallback &  cb)
static

注册添加 Pin Message 通知回调

Parameters
[in]cb收到通知时的回调函数
Returns
void 无返回值

◆ RegUnPinMessage()

void nim::TalkEx::PinMsg::RegUnPinMessage ( const UnPinMessageNotifyCallback &  cb)
static

注册 UnPin Message 通知回调

Parameters
[in]cb收到通知时的回调函数
Returns
void 无返回值

◆ RegUpdatePinMessage()

void nim::TalkEx::PinMsg::RegUpdatePinMessage ( const UpdatePinMessageNotifyCallback &  cb)
static

注册 更新Pin Message 通知回调

Parameters
[in]cb收到通知时的回调函数
Returns
void 无返回值

◆ UnPinMessage()

void nim::TalkEx::PinMsg::UnPinMessage ( const ModifyPinMessageParam modify_param,
const UnPinMessageCallback &  cb 
)
static

Pin某条消息

Parameters
[in]modify_paramUnPin Message 参数
[in]cb执行结果回调函数
Returns
void 无返回值

◆ UnregAllCb()

void nim::TalkEx::PinMsg::UnregAllCb ( )
static

反注册提供的所有回调

Returns
void 无返回值

◆ UpdatePinMessage()

void nim::TalkEx::PinMsg::UpdatePinMessage ( const ModifyPinMessageParam modify_param,
const UpdatePinMessageCallback &  cb 
)
static

更新 Pin Message ext字段

Parameters
[in]modify_param更新 Pin Message 参数
[in]cb执行结果回调函数
Returns
void 无返回值

The documentation for this class was generated from the following file: