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

Public Types

typedef std::function< void(nim::NIMResCode, const SessionOnLineServiceHelper::SessionInfo &)> QuerySessionInfoCallback
 
typedef std::function< void(const SessionOnLineServiceHelper::QuerySessionListResult &)> QuerySessionListCallabck
 
typedef std::function< void(nim::NIMResCode)> UpdateSessionInfoCallback
 
typedef std::function< void(nim::NIMResCode)> DeleteSessionInfoCallback
 
typedef std::function< void(const SessionOnLineServiceHelper::SessionInfo &)> SessionChangedCallback
 

Static Public Member Functions

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 ()
 

Member Typedef Documentation

◆ DeleteSessionInfoCallback

删除会话回调模板

◆ QuerySessionInfoCallback

查询会话回调模板

◆ QuerySessionListCallabck

查询会话列表回调模板

◆ SessionChangedCallback

会话变更回调模板

◆ UpdateSessionInfoCallback

更新会话回调模板

Member Function Documentation

◆ DeleteSession()

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

会话服务 删除会话

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

◆ QuerySession()

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

会话服务 查询会话

Parameters
[in]to_type会话类型
[in]session_id会话ID
[in]cb结果回调 可查看QuerySessionInfoCallback定义
Returns
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

会话服务 查询会话列表

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

◆ RegSessionChanged()

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

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

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

◆ UnregSessionOnLineServiceCb()

void nim::SessionOnLineService::UnregSessionOnLineServiceCb ( )
static

反注册 SessionOnLineService 所有回调

Returns
void 无返回值

◆ UpdateSession()

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

会话服务 更新会话

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

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