nim::Session Class Reference

会话列表管理功能；主要包括查询会话列表、删除会话列表等功能 More...

#include <nim_cpp_session.h>

Public Types
typedef std::function< void(nim::NIMResCode, const SessionData &, int)>	ChangeCallback
typedef std::function< void(int, const SessionDataList &)>	QuerySessionListCallabck
typedef ChangeCallback	DeleteRecentSessionCallabck
typedef ChangeCallback	DeleteAllRecentSessionCallabck
typedef ChangeCallback	SetUnreadCountZeroCallback

Static Public Member Functions
static void	RegChangeCb (const ChangeCallback &cb, const std::string &json_extension="")
static void	QueryAllRecentSessionAsync (const QuerySessionListCallabck &cb, const std::string &json_extension="")
static bool	DeleteRecentSession (nim::NIMSessionType to_type, const std::string &id, const DeleteRecentSessionCallabck &cb, const std::string &json_extension="")
static void	DeleteAllRecentSession (const DeleteAllRecentSessionCallabck &cb, const std::string &json_extension="")
static bool	SetUnreadCountZeroAsync (nim::NIMSessionType to_type, const std::string &id, const SetUnreadCountZeroCallback &cb, const std::string &json_extension="")
static void	UnregSessionCb ()

Detailed Description

会话列表管理功能；主要包括查询会话列表、删除会话列表等功能

Member Typedef Documentation

ChangeCallback

typedef std::function<void(nim::NIMResCode, const SessionData&, int)> nim::Session::ChangeCallback

会话变更通知回调模板

DeleteAllRecentSessionCallabck

typedef ChangeCallback nim::Session::DeleteAllRecentSessionCallabck

删除全部会话回调模板

DeleteRecentSessionCallabck

typedef ChangeCallback nim::Session::DeleteRecentSessionCallabck

删除会话回调模板

QuerySessionListCallabck

typedef std::function<void(int, const SessionDataList&)> nim::Session::QuerySessionListCallabck

查询会话列表回调模板

SetUnreadCountZeroCallback

typedef ChangeCallback nim::Session::SetUnreadCountZeroCallback

会话未读消息数清零回调模板

Member Function Documentation

DeleteAllRecentSession()

static void nim::Session::DeleteAllRecentSession ( const DeleteAllRecentSessionCallabck &  cb, const std::string &  json_extension = ""  )

static

删除全部最近联系人

Parameters

[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	最近会话列表项变更的回调函数

Returns

void 无返回值

Note

错误码 200:成功 0:失败

DeleteRecentSession()

static bool nim::Session::DeleteRecentSession ( nim::NIMSessionType  to_type, const std::string &  id, const DeleteRecentSessionCallabck &  cb, const std::string &  json_extension = ""  )

static

删除最近联系人

Parameters

[in]	to_type	会话类型，双人0，群组1 (nim_msglog_def.h)
[in]	id	对方的account id或者群组tid。
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	最近会话列表项变更的回调函数

Returns

bool 检查参数如果不符合要求则返回失败

Note

错误码 200:成功 0:失败

QueryAllRecentSessionAsync()

static void nim::Session::QueryAllRecentSessionAsync ( const QuerySessionListCallabck &  cb, const std::string &  json_extension = ""  )

static

查询会话列表

Parameters

[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	查询会话列表的回调函数

Returns

void 无返回值

RegChangeCb()

static void nim::Session::RegChangeCb ( const ChangeCallback &  cb, const std::string &  json_extension = ""  )

static

(全局回调)注册最近会话列表项变更通知

Parameters

[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	最近会话列表项变更的回调函数

Returns

void 无返回值

Note

错误码 200:成功

SetUnreadCountZeroAsync()

static bool nim::Session::SetUnreadCountZeroAsync ( nim::NIMSessionType  to_type, const std::string &  id, const SetUnreadCountZeroCallback &  cb, const std::string &  json_extension = ""  )

static

最近联系人项未读数清零

Parameters

[in]	to_type	会话类型，双人0，群组1 (nim_msglog_def.h)
[in]	id	对方的account id或者群组tid。
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	最近会话列表项变更的回调函数

Returns

bool 检查参数如果不符合要求则返回失败

Note

错误码 200:成功 0:失败

UnregSessionCb()

void nim::Session::UnregSessionCb ( )

static

反注册Session提供的所有回调

Returns

void 无返回值

---

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

• nim_cpp_session.h