nim::TalkEx::PinMsg类 参考

#include <nim_cpp_talkex.h>

Public 类型
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 &)>

静态 Public 成员函数
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)

成员类型定义说明

AddPinMessageNotifyCallback

using nim::TalkEx::PinMsg::AddPinMessageNotifyCallback = std::function<void(const std::string& session, int to_type, const PinMessageInfo&)>

PinMessageCallback

using nim::TalkEx::PinMsg::PinMessageCallback = std::function<void(int code, const std::string& session, int to_type, const PinMessageInfo&)>

QueryPinMessageCallback

using nim::TalkEx::PinMsg::QueryPinMessageCallback = std::function<void(int code, const std::string& session, int to_type, const QueryAllPinMessageResponse&)>

UnPinMessageCallback

using nim::TalkEx::PinMsg::UnPinMessageCallback = std::function<void(int code, const std::string& session, int to_type, const std::string&)>

UnPinMessageNotifyCallback

using nim::TalkEx::PinMsg::UnPinMessageNotifyCallback = std::function<void(const std::string& session, int to_type, const std::string& id)>

UpdatePinMessageCallback

using nim::TalkEx::PinMsg::UpdatePinMessageCallback = std::function<void(int code, const std::string& session, int to_type, const PinMessageInfo&)>

UpdatePinMessageNotifyCallback

using nim::TalkEx::PinMsg::UpdatePinMessageNotifyCallback = std::function<void(const std::string& session, int to_type, const PinMessageInfo&)>

成员函数说明

AddPinMessage()

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

static

Pin某条消息

参数

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

返回

void 无返回值

QueryAllPinMessage()

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

static

查询会话的所有 Pin Message

参数

[in]	session	会话ID
[in]	to_type	会话类型
[in]	cb	执行结果回调函数

返回

void 无返回值

RegAddPinMessage()

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

static

注册添加 Pin Message 通知回调

参数

[in]

cb

收到通知时的回调函数

返回

void 无返回值

RegUnPinMessage()

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

static

注册 UnPin Message 通知回调

参数

[in]

cb

收到通知时的回调函数

返回

void 无返回值

RegUpdatePinMessage()

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

static

注册 更新Pin Message 通知回调

参数

[in]

cb

收到通知时的回调函数

返回

void 无返回值

UnPinMessage()

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

static

Pin某条消息

参数

[in]	modify_param	UnPin Message 参数
[in]	cb	执行结果回调函数

返回

void 无返回值

UnregAllCb()

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

static

反注册提供的所有回调

返回

void 无返回值

UpdatePinMessage()

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

static

更新 Pin Message ext字段

参数

[in]	modify_param	更新 Pin Message 参数
[in]	cb	执行结果回调函数

返回

void 无返回值

---

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

• D:/GitLab/builds/7_aFT3sv/0/nim-pc/california/nim-cross-platform-sdk/exports/wrapper/nim_cpp_wrapper/api/nim_cpp_talkex.h
• D:/GitLab/builds/7_aFT3sv/0/nim-pc/california/nim-cross-platform-sdk/exports/wrapper/nim_cpp_wrapper/api/nim_cpp_talkex_pin_message.cpp