NIM 跨平台 C++ SDK
载入中...
搜索中...
未找到
nim::SessionOnLineService类 参考

#include <nim_cpp_session_online_service.h>

Public 类型

typedef std::function< void(NIMResCode, const SessionOnLineServiceHelper::SessionInfo &) QuerySessionInfoCallback)
 查询会话回调模板
 
typedef std::function< void(const SessionOnLineServiceHelper::QuerySessionListResult &) QuerySessionListCallabck)
 查询会话列表回调模板
 
typedef std::function< void(NIMResCode)> UpdateSessionInfoCallback
 更新会话回调模板
 
typedef std::function< void(NIMResCode)> DeleteSessionInfoCallback
 删除会话回调模板
 
typedef std::function< void(const SessionOnLineServiceHelper::SessionInfo &) SessionChangedCallback)
 会话变更回调模板
 

静态 Public 成员函数

static void QuerySessionList (uint64_t min_time, uint64_t max_time, bool need_last_msg, int limit, const QuerySessionListCallabck &cb)
 
static void QuerySession (nim::NIMSessionType to_type, const std::string &session_id, const QuerySessionInfoCallback &cb)
 
static void UpdateSession (nim::NIMSessionType to_type, const std::string &session_id, const std::string &ext, const UpdateSessionInfoCallback &cb)
 
static void DeleteSession (const SessionOnLineServiceHelper::DeleteSessionParam &param, const DeleteSessionInfoCallback &cb)
 
static void RegSessionChanged (const SessionChangedCallback &cb)
 
static void UnregSessionOnLineServiceCb ()
 

成员类型定义说明

◆ DeleteSessionInfoCallback

删除会话回调模板

◆ QuerySessionInfoCallback

typedef std::function<void(NIMResCode, const SessionOnLineServiceHelper::SessionInfo&) nim::SessionOnLineService::QuerySessionInfoCallback)

查询会话回调模板

◆ QuerySessionListCallabck

typedef std::function<void(const SessionOnLineServiceHelper::QuerySessionListResult&) nim::SessionOnLineService::QuerySessionListCallabck)

查询会话列表回调模板

◆ SessionChangedCallback

typedef std::function<void(const SessionOnLineServiceHelper::SessionInfo&) nim::SessionOnLineService::SessionChangedCallback)

会话变更回调模板

◆ UpdateSessionInfoCallback

更新会话回调模板

成员函数说明

◆ DeleteSession()

static void nim::SessionOnLineService::DeleteSession ( const SessionOnLineServiceHelper::DeleteSessionParam & param,
const DeleteSessionInfoCallback & cb )
static

会话服务 删除会话

参数
[in]param要删除的会话列
[in]cb结果回调 可查看DeleteSessionInfoCallback定义
[in]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理!
返回
void 无返回值

◆ QuerySession()

static void nim::SessionOnLineService::QuerySession ( nim::NIMSessionType to_type,
const std::string & session_id,
const QuerySessionInfoCallback & cb )
static

会话服务 查询会话

参数
[in]to_type会话类型
[in]session_id会话ID
[in]cb结果回调 可查看QuerySessionInfoCallback定义
返回
void 无返回值

◆ QuerySessionList()

static void nim::SessionOnLineService::QuerySessionList ( uint64_t min_time,
uint64_t max_time,
bool need_last_msg,
int limit,
const QuerySessionListCallabck & cb )
static

会话服务 查询会话列表

参数
[in]min_time最小时间戳,未知可以填0,表示到最早时间
[in]max_time最大时间戳,未知可以填0,表示从当前时间
[in]need_last_msg是否需要返回lastMsg,默认true
[in]limit结果集limit,最大100,缺省值100
[in]cb结果回调 可查看QuerySessionListCallabck定义
返回
void 无返回值

◆ RegSessionChanged()

static void nim::SessionOnLineService::RegSessionChanged ( const SessionChangedCallback & cb)
static

会话服务 注册会话变更回调

参数
[in]cb结果回调 可查看SessionChangedCallback定义
返回
void 无返回值

◆ UnregSessionOnLineServiceCb()

void nim::SessionOnLineService::UnregSessionOnLineServiceCb ( )
static

反注册 SessionOnLineService 所有回调

返回
void 无返回值

◆ UpdateSession()

static void nim::SessionOnLineService::UpdateSession ( nim::NIMSessionType to_type,
const std::string & session_id,
const std::string & ext,
const UpdateSessionInfoCallback & cb )
static

会话服务 更新会话

参数
[in]to_type会话类型
[in]session_id会话ID
[in]ext会话的扩展字段
[in]cb结果回调 可查看UpdateSessionInfoCallback定义
返回
void 无返回值

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