NIM SDK提供的消息历史接口更多...

#include <nim_cpp_msglog.h>

类
class	AllMessageTypeList

class	FullTextSearchOnlineAsyncParam

class	QueryMsgAsyncParam

class	QueryMsgByKeywordOnlineParam

class	QueryMsgByKeywordParam

class	QueryMsgByOptionsAsyncParam

class	QueryMsgOnlineAsyncParam

class	QueryThreadHistoryMsgAsyncParam

Public 类型
using	QueryMsgCallback = std::function< void(NIMResCode, const std::string &, nim::NIMSessionType, const QueryMsglogResult &)>
	查询消息历史回调模板

using	GetMessagesDynamicallyCallback = std::function< void(const GetMessagesResult &)>
	获取消息历史回调函数模板

using	QuerySingleMsgCallback = std::function< void(NIMResCode, const std::string &, const IMMessage &)>
	查询单条消息历史回调模板

using	ModifyMultipleMsglogCallback = std::function< void(NIMResCode, const std::string &, nim::NIMSessionType)>
	修改（多条）消息历史回调模板

using	BatchStatusReadCallback = ModifyMultipleMsglogCallback
	批量设置消息历史已读状态回调模板

using	BatchStatusDeleteCallback = ModifyMultipleMsglogCallback
	批量删除消息历史回调模板

using	DeleteBySessionTypeCallback = ModifyMultipleMsglogCallback
	批量删除消息历史回调模板

using	ModifySingleMsglogCallback = std::function< void(NIMResCode, const std::string &)>
	修改（单条）消息历史回调模板

using	SetStatusCallback = ModifySingleMsglogCallback
	修改消息历史状态回调模板

using	SetSubStatusCallback = ModifySingleMsglogCallback
	修改消息历史子状态回调模板

using	UpdateLocalExtCallback = ModifySingleMsglogCallback
	修改消息历史本地扩展字段内容回调模板

using	WriteMsglogCallback = ModifySingleMsglogCallback
	保存消息历史回调模板

using	DeleteCallback = ModifySingleMsglogCallback
	删除消息历史回调模板

using	DeleteMsglogSelfNotifyCallback = std::function< void(const DeleteMsglogSelfNotifyParam &)>
	单向删除消息记录通知回调

using	DBFunctionCallback = std::function< void(NIMResCode)>
	消息历史变更回调模板

using	DeleteMsglogSelfCallback = std::function< void(NIMResCode)>
	单向删除消息记录回调

using	DeleteAllCallback = DBFunctionCallback
	删除全部消息历史回调模板

using	DeleteMsgByTimeCallback = DBFunctionCallback
	根据时间段删除部分消息历史回调模板

using	ImportDbPrgCallback = std::function< void(int64_t, int64_t)>
	导入消息历史回调模板

using	MessageStatusChangedCallback = std::function< void(const MessageStatusChangedResult &)>
	发送消息已读回执通知回调模板

using	DeleteHistoryOnLineAsyncCallback = std::function< void(const NIMResCode, const std::string &)>
	删除与某账号(p2p)的所有云端历史记录与漫游消息的回调模板

using	DeleteHistoryOnLineAsyncExCallback = std::function< void(const NIMResCode, const std::string &, nim::NIMSessionType, uint64_t, const std::string &)>
	删除某一会话的云端的历史记录的回调模板

using	DeleteHistoryOnLineNotifyCallback = std::function< void(const std::list< NIMDeleteSessionHistoryMessagesNotifyInfo > &)>
	删除会话的云端的历史记录推送的回调模板

using	QueryMessageIsThreadRootAsyncCallback = std::function< void(const NIMResCode, const std::string &, bool, int)>
	查询消息是否是thread聊天的根消息回调模板

using	QueryMessageOnlineCallback = std::function< void(const NIMResCode, const std::string &, const IMMessage &)>
	查询某条消息的具体内容回调模板

using	QueryThreadHistoryMsgCallback = std::function< void(const NIMResCode, const IMMessage &, int, uint64_t, const std::list< IMMessage > &)>
	分页查询thread talk消息历史回调模板

using	FullTextSearchOnlineAsyncCallback = std::function< void(NIMResCode res_code, const QueryMsglogResult &message_list)>
	服务器全文检索回调模板

using	HistoryMessageFilter = std::function< bool(const IMMessage &)>
	云端历史消息过滤器

using	IsMessageIndexEstablishedCallback = std::function< void(bool is_built)>
	判断消息索引表是否已经构建完成

using	BuildMsglogIndexesProgress = std::function< void(uint32_t total, uint32_t built_count)>
	构建消息索引表进度回调

using	BuildMsglogIndexesComplete = std::function< void(NIMBuildingMsglogIndexesCompleteReason reason, const std::string &message)>
	构建消息索引表完成回调

静态 Public 成员函数
static void	UnregMsglogCb ()

static void	RegDeleteMsglogSelfNotify (const DeleteMsglogSelfNotifyCallback &cb)

static void	RegDeleteHistoryMessagesNotify (const DeleteHistoryOnLineNotifyCallback &cb)

static bool	QueryMsgByIDAysnc (const std::string &client_msg_id, const QuerySingleMsgCallback &cb, const std::string &json_extension="")

static bool	QueryMsgAsync (const std::string &account_id, nim::NIMSessionType to_type, int limit_count, int64_t anchor_msg_time, const QueryMsgCallback &cb, const std::string &json_extension="")

static void	GetMessagesDynamically (const std::string &session_id, nim::NIMSessionType to_type, uint64_t from_time, uint64_t to_time, uint32_t limit_count, const std::string &anchor_client_msg_id, uint64_t anchor_server_msg_id, NIMMsglogSearchDirection direction, const GetMessagesDynamicallyCallback &cb, const std::string &json_extension="")

static bool	QueryMsgOnlineAsync (const QueryMsgOnlineAsyncParam &param, const QueryMsgCallback &cb)

static bool	QueryMsgOnlineAsync (const std::string &id, nim::NIMSessionType to_type, int limit_count, int64_t from_time, int64_t end_time, int64_t end_msg_id, bool reverse, bool need_save_to_local, const QueryMsgCallback &cb, const std::string &json_extension="")

static void	QueryMessagesByKeywordAsync (const QueryMsgByKeywordParam &param, const QueryMsgCallback &cb)
	根据关键字在本地查询关联消息的内容，与其他关键字查询接口不同，本接口使用全文检索引擎进行查询如果您有历史数据，请先调用 IsMessageIndexEstablished 判断是否已经同步完成所有旧消息索引如果尚未同步完成，可使用 BuildMsglogIndexes 来构建历史消息索引，以提供全文检索接口快速查询内容

static void	IsMessageIndexEstablished (const IsMessageIndexEstablishedCallback &cb)
	判断消息索引是否已经建立完成，如果已经建立完成，则可以使用 QueryMessagesByKeywordAsync 接口通过关键字全文检索

static void	BuildMsglogIndexes (uint32_t page_size, const BuildMsglogIndexesProgress &progress, const BuildMsglogIndexesComplete &completion)
	对旧的历史消息构建消息索引表

static void	CancelMsglogIndexesBuilding ()
	取消构建消息索引表

static bool	QueryMsgByKeywordOnlineAsync (const MsgLog::QueryMsgByKeywordOnlineParam &param, const QueryMsgCallback &cb)

static bool	QueryMsgOfSpecifiedTypeInASessionAsync (nim::NIMSessionType to_type, const std::string &id, int limit_count, int64_t from_time, int64_t end_time, const std::string &end_client_msg_id, bool reverse, std::list< NIMMessageType > msg_type, const QueryMsgCallback &cb, const std::string &json_extension="")

static bool	QueryMsgByOptionsAsync (NIMMsgLogQueryRange query_range, const std::list< std::string > &ids, int limit_count, int64_t from_time, int64_t end_time, const std::string &end_client_msg_id, bool reverse, NIMMessageType msg_type, const std::string &search_content, const QueryMsgCallback &cb, const std::string &json_extension="")

static bool	QueryMsgByOptionsAsyncEx (const QueryMsgByOptionsAsyncParam &param, const QueryMsgCallback &cb)

static bool	BatchStatusReadAsync (const std::string &account_id, nim::NIMSessionType to_type, const BatchStatusReadCallback &cb, const std::string &json_extension="")

static bool	BatchStatusDeleteAsync (const std::string &account_id, nim::NIMSessionType to_type, const BatchStatusDeleteCallback &cb, const std::string &json_extension="")

static bool	BatchStatusDeleteAsyncEx (const std::string &account_id, nim::NIMSessionType to_type, bool revert_by_query_online, const BatchStatusDeleteCallback &cb, const std::string &json_extension="")

static bool	SetStatusAsync (const std::string &msg_id, nim::NIMMsgLogStatus msglog_status, const SetStatusCallback &cb, const std::string &json_extension="")

static bool	SetSubStatusAsync (const std::string &msg_id, nim::NIMMsgLogSubStatus msglog_sub_status, const SetSubStatusCallback &cb, const std::string &json_extension="")

static bool	WriteMsglogToLocalAsync (const std::string &talk_id, const IMMessage &msg, bool need_update_session, const WriteMsglogCallback &cb, const std::string &json_extension="")

static bool	WriteMsglogToLocalAsyncEx (const std::string &talk_id, const IMMessage &msg, bool need_update_session, bool compose_last_msg, const std::list< NIMMessageType > &exclude_msg_type, const WriteMsglogCallback &cb)
	static bool WriteMsglogToLocalAsyncEx(const std::string& talk_id, const IMMessage& msg, bool need_update_session, bool compose_last_msg, const std::list<NIMMessageType>& exclude_msg_type, const WriteMsglogCallback& cb) 只往本地消息历史数据库里写入一条消息（如果已存在这条消息，则更新。通常是APP的本地自定义消息，并不会发给服务器）

static bool	DeleteBySessionTypeAsync (bool delete_sessions, NIMSessionType to_type, const DeleteBySessionTypeCallback &cb, const std::string &json_extension="")

static bool	DeleteBySessionTypeAsyncEx (bool delete_sessions, NIMSessionType to_type, bool revert_by_query_online, const DeleteBySessionTypeCallback &cb, const std::string &json_extension="")

static bool	DeleteAsync (const std::string &session_id, NIMSessionType to_type, const std::string &msg_id, const DeleteCallback &cb, const std::string &json_extension="")

static bool	DeleteAllAsync (bool delete_sessions, const DeleteAllCallback &cb, const std::string &json_extension="")

static bool	DeleteAllAsyncEx (bool delete_sessions, bool revert_by_query_online, const DeleteAllCallback &cb, const std::string &json_extension="")

static bool	DeleteMsgByTimeAsync (const std::string &session_id, NIMSessionType to_type, uint64_t timestamp1, uint64_t timestamp2, const DeleteMsgByTimeCallback &cb, const std::string &json_extension="")

static bool	DeleteMsgByTimeAsyncEx (const std::string &session_id, NIMSessionType to_type, bool revert_by_query_online, uint64_t timestamp1, uint64_t timestamp2, const DeleteMsgByTimeCallback &cb, const std::string &json_extension="")

static bool	ExportDbAsync (const std::string &dst_path, const DBFunctionCallback &cb, const std::string &json_extension="")

static bool	ImportDbAsync (const std::string &src_path, const DBFunctionCallback &cb, const ImportDbPrgCallback &prg_cb, const std::string &json_extension="")

static void	SendReceiptAsync (const std::string &json_msg, const MessageStatusChangedCallback &cb)

static void	SendReceiptAsync (const IMMessage &msg, const MessageStatusChangedCallback &cb)

static bool	QuerySentMessageBeReaded (const IMMessage &msg)

static bool	QueryReceivedMsgReceiptSent (const IMMessage &msg)

static void	RegMessageStatusChangedCb (const MessageStatusChangedCallback &cb, const std::string &json_extension="")

static void	RegHistoryMessageFilterCb (const HistoryMessageFilter &filter)

static bool	UpdateLocalExtAsync (const std::string &msg_id, const std::string &local_ext, const UpdateLocalExtCallback &cb, const std::string &json_extension="")

static void	UnregMsgologCb ()

static bool	ReadAllAsync (const DBFunctionCallback &cb, const std::string &json_extension="")

static bool	ExportBackupToRemote (const LogsBackupExportInfo &export_info)

static bool	ImportBackupFromRemote (const LogsBackupImportInfo &import_info)

static void	CancelImportBackupFromRemote ()

static void	CancelExportBackupToRemote ()

static void	DeleteHistoryOnlineAsync (const std::string &accid, bool delete_roaming, const std::string &json_extension, const DeleteHistoryOnLineAsyncCallback &cb)

static void	DeleteHistoryOnlineAsync (const std::string &accid, nim::NIMSessionType to_type, bool notify_self, const std::string &ext, const DeleteHistoryOnLineAsyncExCallback &cb)

static void	DeleteMessageSelfAsync (const IMMessage &msg, const std::string ext, const DeleteMsglogSelfCallback &cb)

static void	DeleteMessageSelfAsync (const std::list< std::tuple< IMMessage, std::string > > &msgs, const DeleteMsglogSelfCallback &cb)

static void	QueryMessageIsThreadRoot (const std::string msg_client_id, const QueryMessageIsThreadRootAsyncCallback &cb)

static void	QueryMessageOnline (const QueryMsgAsyncParam &param, const QueryMessageOnlineCallback &cb)

static void	QueryThreadHistoryMsg (const IMMessage &msg, const QueryThreadHistoryMsgAsyncParam &param, const QueryThreadHistoryMsgCallback &cb)

static void	QueryLocalThreadHistoryMsg (const IMMessage &msg, const QueryMsgCallback &cb)
	查询本地 thread talk 消息历史

static void	FullTextSearchOnlineAsync (const FullTextSearchOnlineAsyncParam &param, const FullTextSearchOnlineAsyncCallback &cb)

static void	QueryUnreadMessages (const std::string &session_id, NIMSessionType to_type, const QueryMsgCallback &cb, const std::string &json_extension="")
	查询某会话下所有未读消息

详细描述

NIM SDK提供的消息历史接口

成员类型定义说明

◆ BatchStatusDeleteCallback

using nim::MsgLog::BatchStatusDeleteCallback = ModifyMultipleMsglogCallback

批量删除消息历史回调模板

◆ BatchStatusReadCallback

using nim::MsgLog::BatchStatusReadCallback = ModifyMultipleMsglogCallback

批量设置消息历史已读状态回调模板

◆ BuildMsglogIndexesComplete

using nim::MsgLog::BuildMsglogIndexesComplete = std::function<void(NIMBuildingMsglogIndexesCompleteReason reason, const std::string& message)>

构建消息索引表完成回调

参数

[in] reason 完成原因

参见: NIMBuildingMsglogIndexesCompleteReason

参数

[in] message 附加信息

◆ BuildMsglogIndexesProgress

using nim::MsgLog::BuildMsglogIndexesProgress = std::function<void(uint32_t total, uint32_t built_count)>

构建消息索引表进度回调

参数

[in]	total	总消息数
[in]	built_count	已构建消息数

◆ DBFunctionCallback

using nim::MsgLog::DBFunctionCallback = std::function<void(NIMResCode)>

消息历史变更回调模板

◆ DeleteAllCallback

using nim::MsgLog::DeleteAllCallback = DBFunctionCallback

删除全部消息历史回调模板

◆ DeleteBySessionTypeCallback

using nim::MsgLog::DeleteBySessionTypeCallback = ModifyMultipleMsglogCallback

批量删除消息历史回调模板

◆ DeleteCallback

using nim::MsgLog::DeleteCallback = ModifySingleMsglogCallback

删除消息历史回调模板

◆ DeleteHistoryOnLineAsyncCallback

using nim::MsgLog::DeleteHistoryOnLineAsyncCallback = std::function<void(const NIMResCode, const std::string&)>

删除与某账号(p2p)的所有云端历史记录与漫游消息的回调模板

◆ DeleteHistoryOnLineAsyncExCallback

using nim::MsgLog::DeleteHistoryOnLineAsyncExCallback = std::function<void(const NIMResCode, const std::string&, nim::NIMSessionType, uint64_t, const std::string&)>

删除某一会话的云端的历史记录的回调模板

◆ DeleteHistoryOnLineNotifyCallback

using nim::MsgLog::DeleteHistoryOnLineNotifyCallback = std::function<void(const std::list<NIMDeleteSessionHistoryMessagesNotifyInfo>&)>

删除会话的云端的历史记录推送的回调模板

◆ DeleteMsgByTimeCallback

using nim::MsgLog::DeleteMsgByTimeCallback = DBFunctionCallback

根据时间段删除部分消息历史回调模板

◆ DeleteMsglogSelfCallback

using nim::MsgLog::DeleteMsglogSelfCallback = std::function<void(NIMResCode)>

单向删除消息记录回调

◆ DeleteMsglogSelfNotifyCallback

using nim::MsgLog::DeleteMsglogSelfNotifyCallback = std::function<void(const DeleteMsglogSelfNotifyParam&)>

单向删除消息记录通知回调

◆ FullTextSearchOnlineAsyncCallback

using nim::MsgLog::FullTextSearchOnlineAsyncCallback = std::function<void(NIMResCode res_code, const QueryMsglogResult& message_list)>

服务器全文检索回调模板

◆ GetMessagesDynamicallyCallback

using nim::MsgLog::GetMessagesDynamicallyCallback = std::function<void(const GetMessagesResult&)>

获取消息历史回调函数模板

◆ HistoryMessageFilter

using nim::MsgLog::HistoryMessageFilter = std::function<bool(const IMMessage&)>

云端历史消息过滤器

◆ ImportDbPrgCallback

using nim::MsgLog::ImportDbPrgCallback = std::function<void(int64_t, int64_t)>

导入消息历史回调模板

◆ IsMessageIndexEstablishedCallback

using nim::MsgLog::IsMessageIndexEstablishedCallback = std::function<void(bool is_built)>

判断消息索引表是否已经构建完成

参数

[in] is_built 是否已构建完成，返回 true 时表示已经构建完成可以通过全文检索 API 进行检索，为 false 时表示还未构建完成，建议使用历史搜索 API

◆ MessageStatusChangedCallback

using nim::MsgLog::MessageStatusChangedCallback = std::function<void(const MessageStatusChangedResult&)>

发送消息已读回执通知回调模板

◆ ModifyMultipleMsglogCallback

using nim::MsgLog::ModifyMultipleMsglogCallback = std::function<void(NIMResCode, const std::string&, nim::NIMSessionType)>

修改（多条）消息历史回调模板

◆ ModifySingleMsglogCallback

using nim::MsgLog::ModifySingleMsglogCallback = std::function<void(NIMResCode, const std::string&)>

修改（单条）消息历史回调模板

◆ QueryMessageIsThreadRootAsyncCallback

using nim::MsgLog::QueryMessageIsThreadRootAsyncCallback = std::function<void(const NIMResCode, const std::string&, bool, int)>

查询消息是否是thread聊天的根消息回调模板

◆ QueryMessageOnlineCallback

using nim::MsgLog::QueryMessageOnlineCallback = std::function<void(const NIMResCode, const std::string&, const IMMessage&)>

查询某条消息的具体内容回调模板

◆ QueryMsgCallback

using nim::MsgLog::QueryMsgCallback = std::function<void(NIMResCode, const std::string&, nim::NIMSessionType, const QueryMsglogResult&)>

查询消息历史回调模板

◆ QuerySingleMsgCallback

using nim::MsgLog::QuerySingleMsgCallback = std::function<void(NIMResCode, const std::string&, const IMMessage&)>

查询单条消息历史回调模板

◆ QueryThreadHistoryMsgCallback

using nim::MsgLog::QueryThreadHistoryMsgCallback = std::function<void(const NIMResCode, const IMMessage&, int, uint64_t, const std::list<IMMessage>&)>

分页查询thread talk消息历史回调模板

◆ SetStatusCallback

using nim::MsgLog::SetStatusCallback = ModifySingleMsglogCallback

修改消息历史状态回调模板

◆ SetSubStatusCallback

using nim::MsgLog::SetSubStatusCallback = ModifySingleMsglogCallback

修改消息历史子状态回调模板

◆ UpdateLocalExtCallback

using nim::MsgLog::UpdateLocalExtCallback = ModifySingleMsglogCallback

修改消息历史本地扩展字段内容回调模板

◆ WriteMsglogCallback

using nim::MsgLog::WriteMsglogCallback = ModifySingleMsglogCallback

保存消息历史回调模板

成员函数说明

◆ BatchStatusDeleteAsync()

static bool nim::MsgLog::BatchStatusDeleteAsync	(	const std::string &	account_id,
		nim::NIMSessionType	to_type,
		const BatchStatusDeleteCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

删除某个会话的全部聊天记录

参数

[in]	account_id	要删除会话的id，account_id/uid或者tid
[in]	to_type	会话类型，双人0，群组1 (见nim_msglog_def.h)
[in]	cb	操作结果的回调函数
[in]	json_extension	json扩展参数（备用，目前不需要）

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

注解: 错误码 200:成功 0:失败

◆ BatchStatusDeleteAsyncEx()

static bool nim::MsgLog::BatchStatusDeleteAsyncEx	(	const std::string &	account_id,
		nim::NIMSessionType	to_type,
		bool	revert_by_query_online,
		const BatchStatusDeleteCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

删除某个会话的全部聊天记录

参数

[in]	account_id	要删除会话的id，account_id/uid或者tid
[in]	to_type	会话类型，双人0，群组1 (见nim_msglog_def.h)
[in]	revert_by_online_query	是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
[in]	cb	操作结果的回调函数
[in]	json_extension	json扩展参数（备用，目前不需要）

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

注解: 错误码 200:成功 0:失败

◆ BatchStatusReadAsync()

static bool nim::MsgLog::BatchStatusReadAsync	(	const std::string &	account_id,
		nim::NIMSessionType	to_type,
		const BatchStatusReadCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

批量设置已读状态

参数

[in]	account_id	查询id，account_id/uid或者tid
[in]	to_type	会话类型，双人0，群组1 (见nim_msglog_def.h)
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果的回调函数

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

注解: 错误码 200:成功 0:失败

◆ BuildMsglogIndexes()

void nim::MsgLog::BuildMsglogIndexes	(	uint32_t	page_size,
		const BuildMsglogIndexesProgress &	progress,
		const BuildMsglogIndexesComplete &	completion
	)

static

对旧的历史消息构建消息索引表

参数

page_size	每页同步多少条消息，建议最小不低于 1000，最大不超过 5000
progress	构建消息索引表进度回调

参见: BuildMsglogIndexesProgress

参数

completion 构建消息索引表完成回调

参见: BuildMsglogIndexesComplete

返回: void

◆ CancelExportBackupToRemote()

static void nim::MsgLog::CancelExportBackupToRemote ( )

static

取消导出本地消息记录到云端

返回: void

◆ CancelImportBackupFromRemote()

static void nim::MsgLog::CancelImportBackupFromRemote ( )

static

取消导入已备份在云端的消息记录

返回: void

◆ CancelMsglogIndexesBuilding()

void nim::MsgLog::CancelMsglogIndexesBuilding ( )

static

取消构建消息索引表

返回: void

◆ DeleteAllAsync()

static bool nim::MsgLog::DeleteAllAsync	(	bool	delete_sessions,
		const DeleteAllCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

删除全部消息历史

参数

[in]	delete_sessions	是否删除所有会话列表项（即全部最近联系人）。 ture则删除，并通过nim_session_reg_change_cb注册的回调通知上层kNIMSessionCommandRemoveAll事件（不会触发每个会话项的kNIMSessionCommandRemove事件）； false则不删除，并将所有会话项的最后一条消息的状态kNIMSessionMsgStatus设置为已删除状态，并通过nim_session_reg_change_cb注册的回调通知上层kNIMSessionCommandAllMsgDeleted事件（不会触发每个会话项的kNIMSessionCommandUpdate事件，避免频繁通知上层）。
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果的回调函数

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

注解: 错误码 200:成功 0:失败

◆ DeleteAllAsyncEx()

static bool nim::MsgLog::DeleteAllAsyncEx	(	bool	delete_sessions,
		bool	revert_by_query_online,
		const DeleteAllCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

删除全部消息历史

参数

[in]	delete_sessions	是否删除所有会话列表项（即全部最近联系人）。 ture则删除，并通过nim_session_reg_change_cb注册的回调通知上层kNIMSessionCommandRemoveAll事件（不会触发每个会话项的kNIMSessionCommandRemove事件）； false则不删除，并将所有会话项的最后一条消息的状态kNIMSessionMsgStatus设置为已删除状态，并通过nim_session_reg_change_cb注册的回调通知上层kNIMSessionCommandAllMsgDeleted事件（不会触发每个会话项的kNIMSessionCommandUpdate事件，避免频繁通知上层）。
[in]	revert_by_online_query	是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果的回调函数

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

注解: 错误码 200:成功 0:失败

◆ DeleteAsync()

static bool nim::MsgLog::DeleteAsync	(	const std::string &	session_id,
		NIMSessionType	to_type,
		const std::string &	msg_id,
		const DeleteCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

删除指定一条消息

参数

[in]	session_id	会话id，对方的account id或者群组tid
[in]	to_type	会话类型
[in]	msg_id	消息id
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果的回调函数

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

注解: 错误码 200:成功 0:失败

◆ DeleteBySessionTypeAsync()

static bool nim::MsgLog::DeleteBySessionTypeAsync	(	bool	delete_sessions,
		NIMSessionType	to_type,
		const DeleteBySessionTypeCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

删除指定会话类型的所有消息

参数

[in]	delete_sessions	是否删除会话
[in]	to_type	会话类型
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果的回调函数
[in]	json_extension	json扩展参数（备用，目前不需要）

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

注解: 错误码 200:成功 0:失败

◆ DeleteBySessionTypeAsyncEx()

static bool nim::MsgLog::DeleteBySessionTypeAsyncEx	(	bool	delete_sessions,
		NIMSessionType	to_type,
		bool	revert_by_query_online,
		const DeleteBySessionTypeCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

删除指定会话类型的所有消息

参数

[in]	delete_sessions	是否删除会话
[in]	to_type	会话类型
[in]	revert_by_online_query	是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果的回调函数
[in]	json_extension	json扩展参数（备用，目前不需要）

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

注解: 错误码 200:成功 0:失败

◆ DeleteHistoryOnlineAsync() [1/2]

void nim::MsgLog::DeleteHistoryOnlineAsync	(	const std::string &	accid,
		bool	delete_roaming,
		const std::string &	json_extension,
		const DeleteHistoryOnLineAsyncCallback &	cb
	)

static

删除与某账号的所有云端历史记录与漫游消息(p2p), 不删除本地消息

参数

[in]	accid	对方的accid
[in]	delete_roaming	是否同时删除所有的漫游消息 true : 是 false : 否
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果的回调函数

返回: void

注解: 错误码 200:成功

◆ DeleteHistoryOnlineAsync() [2/2]

void nim::MsgLog::DeleteHistoryOnlineAsync	(	const std::string &	accid,
		nim::NIMSessionType	to_type,
		bool	notify_self,
		const std::string &	ext,
		const DeleteHistoryOnLineAsyncExCallback &	cb
	)

static

删除某一会话的云端的历史记录[v8.0.0], 删除本地消息

参数

[in]	accid	对方的accid(p2p:accid team:tid)
[in]	to_type	会话类型，双人0，群组1 (见nim_msglog_def.h)
[in]	notify_self	是否通知其它终端
[in]	ext	扩展字段
[in]	cb	操作结果的回调函数

返回: void

注解: 错误码 200:成功

◆ DeleteMessageSelfAsync() [1/2]

void nim::MsgLog::DeleteMessageSelfAsync	(	const IMMessage &	msg,
		const std::string	ext,
		const DeleteMsglogSelfCallback &	cb
	)

static

单向删除某条消息记录(同时删除本地与云端)

参数

[in]	msg	要删除的消息
[in]	ext	用户自定义扩展字段
[in]	cb	操作结果的回调函数

返回: void 无返回值

注解: 错误码 200:成功

◆ DeleteMessageSelfAsync() [2/2]

void nim::MsgLog::DeleteMessageSelfAsync	(	const std::list< std::tuple< IMMessage, std::string > > &	msgs,
		const DeleteMsglogSelfCallback &	cb
	)

static

单向删除多条消息记录(同时删除本地与云端)

参数

[in]	msg	要删除的消息及自定义扩展字段
[in]	cb	操作结果的回调函数

返回: void 无返回值

注解: 错误码 200:成功

◆ DeleteMsgByTimeAsync()

static bool nim::MsgLog::DeleteMsgByTimeAsync	(	const std::string &	session_id,
		NIMSessionType	to_type,
		uint64_t	from_time,
		uint64_t	to_time,
		const DeleteMsgByTimeCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

根据时间段删除部分会话的历史消息

参数

[in]	session_id	要删除消息的会话ID
[in]	to_type	要删除消息的会话类型
[in]	单位ms	timestamp1 与 timestamp2 组成一个时间段，SDK 内部会判断大小调整入参顺序
[in]	单位ms	timestamp2 与 timestamp1 组成一个时间段，SDK 内部会判断大小调整入参顺序
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果的回调函数

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

注解: 错误码 200:成功 0:失败

◆ DeleteMsgByTimeAsyncEx()

static bool nim::MsgLog::DeleteMsgByTimeAsyncEx	(	const std::string &	session_id,
		NIMSessionType	to_type,
		bool	revert_by_query_online,
		uint64_t	from_time,
		uint64_t	to_time,
		const DeleteMsgByTimeCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

根据时间段删除部分会话的历史消息

参数

[in]	session_id	要删除消息的会话ID
[in]	to_type	要删除消息的会话类型
[in]	revert_by_online_query	是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
[in]	单位ms	timestamp1 与 timestamp2 组成一个时间段，SDK 内部会判断大小调整入参顺序
[in]	单位ms	timestamp2 与 timestamp1 组成一个时间段，SDK 内部会判断大小调整入参顺序
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果的回调函数

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

注解: 错误码 200:成功 0:失败

◆ ExportBackupToRemote()

static bool nim::MsgLog::ExportBackupToRemote ( const LogsBackupExportInfo & export_info )

static

导出本地消息记录到云端

参数

[in] export_info 导出需要的参数参考LogsBackupExportInfo定义

返回: bool false : 当前有导入/导出操作正在进行中

◆ ExportDbAsync()

static bool nim::MsgLog::ExportDbAsync	(	const std::string &	dst_path,
		const DBFunctionCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

导出整个消息历史DB文件（不包括系统消息历史）

参数

[in]	dst_path	导出时保存的目标全路径（UTF-8编码）。
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果的回调函数

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

注解: 错误码 200:成功 0:失败

◆ FullTextSearchOnlineAsync()

void nim::MsgLog::FullTextSearchOnlineAsync	(	const FullTextSearchOnlineAsyncParam &	param,
		const FullTextSearchOnlineAsyncCallback &	cb
	)

static

在线全文检索

参数

[in]	param	全文检索参数
[in]	cb	全文检索结果回调函数

返回: void 无返回值

注解: 错误码 200:成功

◆ GetMessagesDynamically()

static void nim::MsgLog::GetMessagesDynamically	(	const std::string &	session_id,
		nim::NIMSessionType	to_type,
		uint64_t	from_time,
		uint64_t	to_time,
		uint32_t	limit_count,
		const std::string &	anchor_client_msg_id,
		uint64_t	anchor_server_msg_id,
		NIMMsglogSearchDirection	direction,
		const GetMessagesDynamicallyCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

查询历史消息，基于本地可信时间段信息来动态判断获取消息的途径

参数

[in]	session_id	会话id
[in]	to_type	会话类型, 双人0，群组1, 超大群5 (见nim_msglog_def.h)
[in]	from_time	开始时间, 包含
[in]	to_time	结束时间, 大于from_time, 0表示当前时间; 只有在direction为kForward且anchor_client_msg_id不为空时才包含
[in]	limit_count	查询数量
[in]	anchor_client_msg_id	查询起始的客户端消息id, 查询结果不包括这条消息
[in]	anchor_server_msg_id	查询起始的服务器消息id, 查询结果不包括这条消息
[in]	direction	查询方向
[in]	cb	查询消息的回调函数
[in]	json_extension	json扩展参数（备用，目前不需要）

返回: void

注解: 错误码 200:成功

◆ ImportBackupFromRemote()

static bool nim::MsgLog::ImportBackupFromRemote ( const LogsBackupImportInfo & import_info )

static

导入已备份在云端的消息记录

参数

[in] import_info 导入需要的参数参考LogsBackupImportInfo定义

返回: bool false : 当前有导入/导出操作正在进行中

◆ ImportDbAsync()

static bool nim::MsgLog::ImportDbAsync	(	const std::string &	src_path,
		const DBFunctionCallback &	cb,
		const ImportDbPrgCallback &	prg_cb,
		const std::string &	json_extension = `""`
	)

static

导入消息历史DB文件（不包括系统消息历史）。先验证是否自己的消息历史文件和DB加密密钥(见nim_client_def.h里的kNIMDataBaseEncryptKey），如果验证不通过，则不导入。

参数

[in]	src_path	导入源文件的全路径（UTF-8编码）。
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果的回调函数
[in]	prg_cb	导入进度的回调函数

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

注解: 错误码 200:成功 10600:导入消息历史时验证身份和加密密钥不通过 10601:导入消息历史时写记录失败

◆ IsMessageIndexEstablished()

void nim::MsgLog::IsMessageIndexEstablished ( const IsMessageIndexEstablishedCallback & cb )

static

判断消息索引是否已经建立完成，如果已经建立完成，则可以使用 QueryMessagesByKeywordAsync 接口通过关键字全文检索

参数

cb	是否已经建立完成的回调函数

返回: void

◆ QueryLocalThreadHistoryMsg()

void nim::MsgLog::QueryLocalThreadHistoryMsg	(	const IMMessage &	msg,
		const QueryMsgCallback &	cb
	)

static

查询本地 thread talk 消息历史

参数

msg	要查询的 thread 根消息
cb	查询结果的回调函数

返回: void 无返回值

注解: 错误码 200: 成功，414: 参数错误

自从: v9.15.0

◆ QueryMessageIsThreadRoot()

void nim::MsgLog::QueryMessageIsThreadRoot	(	const std::string	msg_client_id,
		const QueryMessageIsThreadRootAsyncCallback &	cb
	)

static

查询某条消息是否为thread聊天的根消息

参数

[in]	msg_client_id	要查询的消息的客户端ID
[in]	cb	操作结果的回调函数

返回: void 无返回值

注解: 错误码 200:成功

◆ QueryMessageOnline()

void nim::MsgLog::QueryMessageOnline	(	const QueryMsgAsyncParam &	param,
		const QueryMessageOnlineCallback &	cb
	)

static

查询某条消息的具体内容一般用在thread talk 场景中

参数

[in]	param	要查询的消息的相关参数，可以在msglog.threadinfo中得到
[in]	cb	查询结果的回调函数

返回: void 无返回值

注解: 错误码 200:成功

◆ QueryMessagesByKeywordAsync()

void nim::MsgLog::QueryMessagesByKeywordAsync	(	const QueryMsgByKeywordParam &	param,
		const QueryMsgCallback &	cb
	)

static

根据关键字在本地查询关联消息的内容，与其他关键字查询接口不同，本接口使用全文检索引擎进行查询如果您有历史数据，请先调用 IsMessageIndexEstablished 判断是否已经同步完成所有旧消息索引如果尚未同步完成，可使用 BuildMsglogIndexes 来构建历史消息索引，以提供全文检索接口快速查询内容

参数

param 查询参数

参见: QueryMsgByKeywordParam

参数

cb 查询消息的回调函数

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

注解: 错误码 200:成功 414:参数错误

◆ QueryMsgAsync()

static bool nim::MsgLog::QueryMsgAsync	(	const std::string &	account_id,
		nim::NIMSessionType	to_type,
		int	limit_count,
		int64_t	anchor_msg_time,
		const QueryMsgCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

查询本地消息

参数

[in]	account_id	查询id，account_id/uid或者tid
[in]	to_type	会话类型，双人0，群组1 (见nim_msglog_def.h)
[in]	limit_count	一次查询数量，建议20
[in]	anchor_msg_time	作为此次查询的定位点的消息历史的消息时间戳（上次查询最后一条消息的时间戳，按指定的时间的顺序起查，默认为逆序，2.4.0之前命名为last_name）
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	查询本地消息的回调函数

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

注解: 错误码 200:成功

◆ QueryMsgByIDAysnc()

static bool nim::MsgLog::QueryMsgByIDAysnc	(	const std::string &	client_msg_id,
		const QuerySingleMsgCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

根据消息ID查询本地（单条）消息

参数

[in]	client_msg_id	客户端消息ID
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	查询本地消息的回调函数

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

注解: 错误码 200:成功 0:失败

◆ QueryMsgByKeywordOnlineAsync()

static bool nim::MsgLog::QueryMsgByKeywordOnlineAsync	(	const MsgLog::QueryMsgByKeywordOnlineParam &	param,
		const QueryMsgCallback &	cb
	)

static

在线查询消息（不包括系统消息）

参数

[in]	param	查询参数
[in]	cb	在线查询消息的回调函数

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

注解: 错误码 200:成功 403:禁止访问(不在该群,只针对群组会话) 414:参数错误

◆ QueryMsgByOptionsAsync()

static bool nim::MsgLog::QueryMsgByOptionsAsync	(	NIMMsgLogQueryRange	query_range,
		const std::list< std::string > &	ids,
		int	limit_count,
		int64_t	from_time,
		int64_t	end_time,
		const std::string &	end_client_msg_id,
		bool	reverse,
		NIMMessageType	msg_type,
		const std::string &	search_content,
		const QueryMsgCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

根据指定条件查询本地消息,使用此接口可以完成全局搜索等功能,具体请参阅开发手册 http://dev.netease.im/docs/product/IM%E5%8D%B3%E6%97%B6%E9%80%9A%E8%AE%AF/SDK%E5%BC%80%E5%8F%91%E9%9B%86%E6%88%90/Windows%E5%BC%80%E5%8F%91%E9%9B%86%E6%88%90/%E5%8E%86%E5%8F%B2%E8%AE%B0%E5%BD%95

参数

[in]	query_range	消息历史的检索范围（目前暂不支持某些范围的组合检索，详见NIMMsgLogQueryRange说明）
[in]	ids	会话id（对方的account id或者群组tid）的集合，目前暂不支持多个的组合检索，详见NIMMsgLogQueryRange说明
[in]	limit_count	本次查询的消息条数上限(最多100条)
[in]	from_time	起始时间点，单位：毫秒
[in]	end_time	结束时间点，单位：毫秒
[in]	end_client_msg_id	结束查询的最后一条消息的end_client_msg_id(不包含在查询结果中)
[in]	reverse	true：反向查询(按时间正序起查，正序排列)，false：按时间逆序起查，逆序排列（建议默认为false）
[in]	msg_type	检索的消息类型（目前只支持kNIMMessageTypeText、kNIMMessageTypeImage和kNIMMessageTypeFile这三种类型消息）
[in]	search_content	检索文本（目前只支持kNIMMessageTypeText和kNIMMessageTypeFile这两种类型消息的文本关键字检索，即支持文字消息和文件名的检索。如果合并检索，需使用未知类型消息kNIMMessageTypeUnknown）
[in]	cb	在线查询消息的回调函数
[in]	json_extension	json扩展参数（备用，目前不需要）

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

注解: 错误码 200:成功

◆ QueryMsgByOptionsAsyncEx()

static bool nim::MsgLog::QueryMsgByOptionsAsyncEx	(	const QueryMsgByOptionsAsyncParam &	param,
		const QueryMsgCallback &	cb
	)

static

根据指定条件查询本地消息,使用此接口可以完成全局搜索等功能,具体请参阅开发手册 http://dev.netease.im/docs/product/IM%E5%8D%B3%E6%97%B6%E9%80%9A%E8%AE%AF/SDK%E5%BC%80%E5%8F%91%E9%9B%86%E6%88%90/Windows%E5%BC%80%E5%8F%91%E9%9B%86%E6%88%90/%E5%8E%86%E5%8F%B2%E8%AE%B0%E5%BD%95

参数

[in]	param	查询参数
[in]	cb	在线查询消息的回调函数

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

注解: 错误码 200:成功

◆ QueryMsgOfSpecifiedTypeInASessionAsync()

static bool nim::MsgLog::QueryMsgOfSpecifiedTypeInASessionAsync	(	nim::NIMSessionType	to_type,
		const std::string &	id,
		int	limit_count,
		int64_t	from_time,
		int64_t	end_time,
		const std::string &	end_client_msg_id,
		bool	reverse,
		std::list< NIMMessageType >	msg_type,
		const QueryMsgCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

根据指定条件在一个会话中查询指定单个或多个类型的本地消息

参数

[in]	to_type	会话类型，双人0，群组1 (nim_msglog_def.h)
[in]	id	查询id，对方的account id或者群组tid。
[in]	limit_count	本次查询的消息条数上限(最多100条)
[in]	from_time	起始时间点，单位：毫秒，当为 0 时将不作为过滤条件
[in]	end_time	结束时间点，单位：毫秒，当为 0 时将不作为过滤条件
[in]	end_client_msg_id	作为查询结果的过滤条件，无论正向、反向查询，当遇到此消息 ID 时均跳过后续的消息，且不将该 ID 对应的消息包含在查询结果中
[in]	reverse	查询方向，为 true 时对时间段内的消息从新到旧查询，查询结果按消息时间降序排列，为 false 时对时间段内的消息从旧到新查询，查询结果按消息时间升序排列
[in]	msg_type	检索的消息类型
[in]	json_extension	json 扩展参数（备用，目前不需要）
[in]	cb	在线查询消息的回调函数

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

注解: 错误码 200:成功

◆ QueryMsgOnlineAsync() [1/2]

static bool nim::MsgLog::QueryMsgOnlineAsync	(	const QueryMsgOnlineAsyncParam &	param,
		const QueryMsgCallback &	cb
	)

static

在线查询消息（不包括系统消息）

参数

[in]	param	查询参数
[in]	cb	在线查询消息的回调函数

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

注解: 错误码 200:成功 403:禁止访问(不在该群,只针对群组会话) 414:参数错误

◆ QueryMsgOnlineAsync() [2/2]

static bool nim::MsgLog::QueryMsgOnlineAsync	(	const std::string &	id,
		nim::NIMSessionType	to_type,
		int	limit_count,
		int64_t	from_time,
		int64_t	end_time,
		int64_t	end_msg_id,
		bool	reverse,
		bool	need_save_to_local,
		const QueryMsgCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

在线查询消息（不包括系统消息）

参数

[in]	id	查询id，对方的account id或者群组tid。
[in]	to_type	会话类型，双人0，群组1 (nim_msglog_def.h)
[in]	limit_count	本次查询的消息条数上限(最多100条)
[in]	from_time	起始时间点，单位：毫秒
[in]	end_time	结束时间点，单位：毫秒
[in]	end_msg_id	结束查询的最后一条消息的server_msg_id(不包含在查询结果中)
[in]	reverse	true：反向查询(按时间正序起查，正序排列)，false：按时间逆序起查，逆序排列（建议默认为false）
[in]	need_save_to_local	true: 将在线查询结果保存到本地，false: 不保存
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	在线查询消息的回调函数

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

注解: 错误码 200:成功 403:禁止访问(不在该群,只针对群组会话) 414:参数错误

◆ QueryReceivedMsgReceiptSent()

bool nim::MsgLog::QueryReceivedMsgReceiptSent ( const IMMessage & msg )

static

查询收到的消息是否已经发送过已读回执

参数

[in] msg 消息。

返回: bool 是否已发送过

◆ QuerySentMessageBeReaded()

bool nim::MsgLog::QuerySentMessageBeReaded ( const IMMessage & msg )

static

查询自己发送的消息是否被对方已读

参数

[in] msg 消息。

返回: bool 是否被已读

◆ QueryThreadHistoryMsg()

void nim::MsgLog::QueryThreadHistoryMsg	(	const IMMessage &	msg,
		const QueryThreadHistoryMsgAsyncParam &	param,
		const QueryThreadHistoryMsgCallback &	cb
	)

static

分页查询thread talk消息历史

参数

[in]	param	要查询的消息的相关参数，可以在msglog.threadinfo中得到
[in]	cb	查询结果的回调函数

返回: void 无返回值

注解: 错误码 200:成功

◆ QueryUnreadMessages()

void nim::MsgLog::QueryUnreadMessages	(	const std::string &	session_id,
		NIMSessionType	to_type,
		const QueryMsgCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

查询某会话下所有未读消息

参数

session_id	会话 ID
to_type	会话类型
cb	查询结果回调函数
json_extension	json 扩展参数（备用，目前不需要）

注解: 错误码 200:成功 414:参数错误

◆ ReadAllAsync()

static bool nim::MsgLog::ReadAllAsync	(	const DBFunctionCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

全部未读消息历史标记为已读

参数

[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果的回调函数

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

注解: 错误码 200:成功 0:失败

◆ RegDeleteHistoryMessagesNotify()

void nim::MsgLog::RegDeleteHistoryMessagesNotify ( const DeleteHistoryOnLineNotifyCallback & cb )

static

注册删除某一会话的云端的历史记录通知回调[v8.0.0]

参数

[in] cb 删除某一会话的云端的历史记录通知回调

返回: void 无返回值

◆ RegDeleteMsglogSelfNotify()

void nim::MsgLog::RegDeleteMsglogSelfNotify ( const DeleteMsglogSelfNotifyCallback & cb )

static

注册单向删除消息记录通知回调

参数

[in] cb 单向删除消息记录通知回调

返回: void 无返回值

◆ RegHistoryMessageFilterCb()

void nim::MsgLog::RegHistoryMessageFilterCb ( const HistoryMessageFilter & filter )

static

(全局回调)注册全局的云端消息历史过滤回调

参数

filter 消息历史过滤器 HistoryMessageFilter

返回: void 无返回值

◆ RegMessageStatusChangedCb()

void nim::MsgLog::RegMessageStatusChangedCb	(	const MessageStatusChangedCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

(全局回调)注册全局的消息状态变更通知（目前只支持已读状态的通知）

参数

[in]	cb	回调函数
[in]	json_extension	json扩展参数（备用，目前不需要）

返回: void 无返回值

注解: 错误码 200:成功

◆ SendReceiptAsync() [1/2]

void nim::MsgLog::SendReceiptAsync	(	const IMMessage &	msg,
		const MessageStatusChangedCallback &	cb
	)

static

发送消息已读回执

参数

[in]	msg	已读消息
[in]	cb	操作结果的回调函数

返回: void 无返回值

注解: 错误码 200:成功 403:服务器关闭此功能，或者应用没权限 404:请求的目标（用户或对象）不存在 10414:本地错误码，参数错误

◆ SendReceiptAsync() [2/2]

void nim::MsgLog::SendReceiptAsync	(	const std::string &	json_msg,
		const MessageStatusChangedCallback &	cb
	)

static

发送消息已读回执

参数

[in]	json_msg	已读消息json string。
[in]	cb	操作结果的回调函数

返回: void 无返回值

注解: 错误码 200:成功 403:服务器关闭此功能，或者应用没权限 404:请求的目标（用户或对象）不存在 10414:本地错误码，参数错误

◆ SetStatusAsync()

static bool nim::MsgLog::SetStatusAsync	(	const std::string &	msg_id,
		nim::NIMMsgLogStatus	msglog_status,
		const SetStatusCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

设置消息状态

参数

[in]	msg_id	消息id
[in]	msglog_status	消息状态枚举值
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果的回调函数

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

注解: 错误码 200:成功 0:失败

◆ SetSubStatusAsync()

static bool nim::MsgLog::SetSubStatusAsync	(	const std::string &	msg_id,
		nim::NIMMsgLogSubStatus	msglog_sub_status,
		const SetSubStatusCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

设置消息子状态

参数

[in]	msg_id	消息id
[in]	msglog_sub_status	消息子状态枚举值
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果的回调函数

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

注解: 错误码 200:成功 0:失败

◆ UnregMsglogCb()

void nim::MsgLog::UnregMsglogCb ( )

static

反注册Msglog提供的所有回调

返回: void 无返回值

◆ UnregMsgologCb()

void nim::MsgLog::UnregMsgologCb ( )

static

反注册Msglog提供的所有回调

返回: void 无返回值

◆ UpdateLocalExtAsync()

static bool nim::MsgLog::UpdateLocalExtAsync	(	const std::string &	msg_id,
		const std::string &	local_ext,
		const UpdateLocalExtCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

更新本地消息扩展字段内容

参数

[in]	msg_id	消息id
[in]	local_ext	本地扩展字段内容
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果的回调函数

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

注解: 错误码 200:成功 0:失败

◆ WriteMsglogToLocalAsync()

static bool nim::MsgLog::WriteMsglogToLocalAsync	(	const std::string &	talk_id,
		const IMMessage &	msg,
		bool	need_update_session,
		const WriteMsglogCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

只往本地消息历史数据库里写入一条消息（如果已存在这条消息，则更新。通常是APP的本地自定义消息，并不会发给服务器）

参数

[in]	account_id	会话id，对方的account id或者群组tid
[in]	msg	消息内容
[in]	need_update_session	是否更新会话列表（一般最新一条消息有这个需求）
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果的回调函数

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

注解: 错误码 200:成功 0:失败

◆ WriteMsglogToLocalAsyncEx()

bool nim::MsgLog::WriteMsglogToLocalAsyncEx	(	const std::string &	talk_id,
		const IMMessage &	msg,
		bool	need_update_session,
		bool	compose_last_msg,
		const std::list< NIMMessageType > &	exclude_msg_type,
		const WriteMsglogCallback &	cb
	)

static

static bool WriteMsglogToLocalAsyncEx(const std::string& talk_id, const IMMessage& msg, bool need_update_session, bool compose_last_msg, const std::list<NIMMessageType>& exclude_msg_type, const WriteMsglogCallback& cb) 只往本地消息历史数据库里写入一条消息（如果已存在这条消息，则更新。通常是APP的本地自定义消息，并不会发给服务器）

参数

talk_id	会话id，对方的account id或者群组tid
msg	消息内容
need_update_session	是否更新会话列表（一般最新一条消息有这个需求）
compose_last_msg	如果消息历史中有该会话的消息，是否将该会话最后一条消息随会话变更上报，true 为携带，否则不携带
exclude_msg_type	如果 compose_last_msg = true，则可根据需要排除指定最后一条消息的类型
cb	操作结果的回调函数

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

注解: 错误码 200:成功 0:失败

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

D:/GitLab/builds/5sbaxrcd/0/nim-pc/california/nim-cross-platform-sdk/exports/wrapper/nim_cpp_wrapper/api/nim_cpp_msglog.h
D:/GitLab/builds/5sbaxrcd/0/nim-pc/california/nim-cross-platform-sdk/exports/wrapper/nim_cpp_wrapper/api/nim_cpp_msglog.cpp

类

Public 类型

静态 Public 成员函数

详细描述

成员类型定义说明

◆ BatchStatusDeleteCallback

◆ BatchStatusReadCallback

◆ BuildMsglogIndexesComplete

◆ BuildMsglogIndexesProgress

◆ DBFunctionCallback

◆ DeleteAllCallback

◆ DeleteBySessionTypeCallback

◆ DeleteCallback

◆ DeleteHistoryOnLineAsyncCallback

◆ DeleteHistoryOnLineAsyncExCallback

◆ DeleteHistoryOnLineNotifyCallback

◆ DeleteMsgByTimeCallback

◆ DeleteMsglogSelfCallback

◆ DeleteMsglogSelfNotifyCallback

◆ FullTextSearchOnlineAsyncCallback

◆ GetMessagesDynamicallyCallback

◆ HistoryMessageFilter

◆ ImportDbPrgCallback

◆ IsMessageIndexEstablishedCallback

◆ MessageStatusChangedCallback

◆ ModifyMultipleMsglogCallback

◆ ModifySingleMsglogCallback

◆ QueryMessageIsThreadRootAsyncCallback

◆ QueryMessageOnlineCallback

◆ QueryMsgCallback

◆ QuerySingleMsgCallback

◆ QueryThreadHistoryMsgCallback

◆ SetStatusCallback

◆ SetSubStatusCallback

◆ UpdateLocalExtCallback

◆ WriteMsglogCallback

成员函数说明

◆ BatchStatusDeleteAsync()

◆ BatchStatusDeleteAsyncEx()

◆ BatchStatusReadAsync()

◆ BuildMsglogIndexes()

◆ CancelExportBackupToRemote()

◆ CancelImportBackupFromRemote()

◆ CancelMsglogIndexesBuilding()

◆ DeleteAllAsync()

◆ DeleteAllAsyncEx()

◆ DeleteAsync()

◆ DeleteBySessionTypeAsync()

◆ DeleteBySessionTypeAsyncEx()

◆ DeleteHistoryOnlineAsync() [1/2]

◆ DeleteHistoryOnlineAsync() [2/2]

◆ DeleteMessageSelfAsync() [1/2]

◆ DeleteMessageSelfAsync() [2/2]

◆ DeleteMsgByTimeAsync()

◆ DeleteMsgByTimeAsyncEx()

◆ ExportBackupToRemote()

◆ ExportDbAsync()

◆ FullTextSearchOnlineAsync()

◆ GetMessagesDynamically()

◆ ImportBackupFromRemote()

◆ ImportDbAsync()

◆ IsMessageIndexEstablished()

◆ QueryLocalThreadHistoryMsg()

◆ QueryMessageIsThreadRoot()

◆ QueryMessageOnline()

◆ QueryMessagesByKeywordAsync()

◆ QueryMsgAsync()

◆ QueryMsgByIDAysnc()

◆ QueryMsgByKeywordOnlineAsync()

◆ QueryMsgByOptionsAsync()

◆ QueryMsgByOptionsAsyncEx()

◆ QueryMsgOfSpecifiedTypeInASessionAsync()

◆ QueryMsgOnlineAsync() [1/2]

◆ QueryMsgOnlineAsync() [2/2]

◆ QueryReceivedMsgReceiptSent()

◆ QuerySentMessageBeReaded()

◆ QueryThreadHistoryMsg()

◆ QueryUnreadMessages()

◆ ReadAllAsync()

◆ RegDeleteHistoryMessagesNotify()