7#ifndef _NIM_SDK_CPP_MSGLOG_H_
8#define _NIM_SDK_CPP_MSGLOG_H_
25 typedef std::function<void(
NIMResCode res_code,
const std::string&
id, nim::NIMSessionType to_type,
const QueryMsglogResult& result)>
29 typedef std::function<void(
NIMResCode res_code,
const std::string& msg_id,
const IMMessage& msg)>
32 typedef std::function<void(
NIMResCode res_code,
const std::string& uid, nim::NIMSessionType to_type)>
73 typedef std::function<void(
const NIMResCode,
const std::string&)>
76 typedef std::function<void(
const NIMResCode,
const std::string&, nim::NIMSessionType, uint64_t,
const std::string&)>
79 typedef std::function<void(
const std::list<NIMDeleteSessionHistoryMessagesNotifyInfo>& info_list)>
82 typedef std::function<void(
const NIMResCode res_code,
const std::string& client_id,
bool is_root,
int reply_count)>
85 typedef std::function<void(
const NIMResCode res_code,
const std::string& client_id,
const IMMessage& msg)>
88 typedef std::function<
89 void(
const NIMResCode res_code,
const IMMessage& root_msg,
int total, uint64_t last_msg_time,
const std::list<IMMessage>& msg_list)>
100 std::vector<nim::NIMMessageType> ExclusionType(
const std::vector<nim::NIMMessageType>& exclusion_type_list)
const;
103 std::vector<nim::NIMMessageType>
list_;
190 std::vector<nim::NIMMessageType>
type_;
192 uint32_t limit_count_{100};
194 time_t from_time_{0};
202 bool enable_pinyin_{
true};
272 std::string ToJsonString()
const;
280 uint64_t from_time_{0};
282 uint64_t to_time_{0};
284 uint32_t session_limit_{0};
286 uint32_t msglog_limit_{0};
288 uint32_t search_rule_{0};
333 static void UnregMsglogCb();
339 static void RegDeleteMsglogSelfNotify(
const DeleteMsglogSelfNotifyCallback& cb);
346 static void RegDeleteHistoryMessagesNotify(
const DeleteHistoryOnLineNotifyCallback& cb);
357 static bool QueryMsgByIDAysnc(
const std::string& client_msg_id,
const QuerySingleMsgCallback& cb,
const std::string& json_extension =
"");
376 static bool QueryMsgAsync(
const std::string& account_id,
377 nim::NIMSessionType to_type,
379 int64_t anchor_msg_time,
380 const QueryMsgCallback& cb,
381 const std::string& json_extension =
"");
407 static void GetMessagesDynamically(
const std::string& session_id,
408 nim::NIMSessionType to_type,
411 uint32_t limit_count,
412 const std::string& anchor_client_msg_id,
413 uint64_t anchor_server_msg_id,
415 const GetMessagesDynamicallyCallback& cb,
416 const std::string& json_extension =
"");
446 static bool QueryMsgOnlineAsync(
const std::string&
id,
447 nim::NIMSessionType to_type,
453 bool need_save_to_local,
454 const QueryMsgCallback& cb,
455 const std::string& json_extension =
"");
489 static void CancelMsglogIndexesBuilding();
528 static bool QueryMsgOfSpecifiedTypeInASessionAsync(nim::NIMSessionType to_type,
529 const std::string&
id,
533 const std::string& end_client_msg_id,
535 std::list<NIMMessageType> msg_type,
536 const QueryMsgCallback& cb,
537 const std::string& json_extension =
"");
568 const std::list<std::string>& ids,
572 const std::string& end_client_msg_id,
575 const std::string& search_content,
576 const QueryMsgCallback& cb,
577 const std::string& json_extension =
"");
602 static bool BatchStatusReadAsync(
const std::string& account_id,
603 nim::NIMSessionType to_type,
605 const std::string& json_extension =
"");
618 static bool BatchStatusDeleteAsync(
const std::string& account_id,
619 nim::NIMSessionType to_type,
621 const std::string& json_extension =
"");
635 static bool BatchStatusDeleteAsyncEx(
const std::string& account_id,
636 nim::NIMSessionType to_type,
637 bool revert_by_query_online,
639 const std::string& json_extension =
"");
652 static bool SetStatusAsync(
const std::string& msg_id,
653 nim::NIMMsgLogStatus msglog_status,
655 const std::string& json_extension =
"");
668 static bool SetSubStatusAsync(
const std::string& msg_id,
669 nim::NIMMsgLogSubStatus msglog_sub_status,
671 const std::string& json_extension =
"");
685 static bool WriteMsglogToLocalAsync(
const std::string& talk_id,
687 bool need_update_session,
689 const std::string& json_extension =
"");
709 static bool WriteMsglogToLocalAsyncEx(
const std::string& talk_id,
711 bool need_update_session,
712 bool compose_last_msg,
713 const std::list<NIMMessageType>& exclude_msg_type,
728 static bool DeleteBySessionTypeAsync(
bool delete_sessions,
731 const std::string& json_extension =
"");
746 static bool DeleteBySessionTypeAsyncEx(
bool delete_sessions,
748 bool revert_by_query_online,
750 const std::string& json_extension =
"");
764 static bool DeleteAsync(
const std::string& session_id,
766 const std::string& msg_id,
768 const std::string& json_extension =
"");
781 static bool DeleteAllAsync(
bool delete_sessions,
const DeleteAllCallback& cb,
const std::string& json_extension =
"");
796 static bool DeleteAllAsyncEx(
bool delete_sessions,
797 bool revert_by_query_online,
799 const std::string& json_extension =
"");
814 static bool DeleteMsgByTimeAsync(
const std::string& session_id,
819 const std::string& json_extension =
"");
835 static bool DeleteMsgByTimeAsyncEx(
const std::string& session_id,
837 bool revert_by_query_online,
841 const std::string& json_extension =
"");
852 static bool ExportDbAsync(
const std::string& dst_path,
const DBFunctionCallback& cb,
const std::string& json_extension =
"");
866 static bool ImportDbAsync(
const std::string& src_path,
869 const std::string& json_extension =
"");
881 static void SendReceiptAsync(
const std::string& json_msg,
const MessageStatusChangedCallback& cb);
893 static void SendReceiptAsync(
const IMMessage& msg,
const MessageStatusChangedCallback& cb);
900 static bool QuerySentMessageBeReaded(
const IMMessage& msg);
907 static bool QueryReceivedMsgReceiptSent(
const IMMessage& msg);
916 static void RegMessageStatusChangedCb(
const MessageStatusChangedCallback& cb,
const std::string& json_extension =
"");
929 static bool UpdateLocalExtAsync(
const std::string& msg_id,
930 const std::string& local_ext,
932 const std::string& json_extension =
"");
937 static void UnregMsgologCb();
947 static bool ReadAllAsync(
const DBFunctionCallback& cb,
const std::string& json_extension =
"");
967 static void CancelImportBackupFromRemote();
973 static void CancelExportBackupToRemote();
985 static void DeleteHistoryOnlineAsync(
const std::string& accid,
987 const std::string& json_extension,
988 const DeleteHistoryOnLineAsyncCallback& cb);
1004 static void DeleteHistoryOnlineAsync(
const std::string& accid,
1005 nim::NIMSessionType to_type,
1007 const std::string& ext,
1008 const DeleteHistoryOnLineAsyncExCallback& cb);
1027 static void DeleteMessageSelfAsync(
const std::list<std::tuple<IMMessage, std::string>>& msgs,
const DeleteMsglogSelfCallback& cb);
1036 static void QueryMessageIsThreadRoot(
const std::string msg_client_id,
const QueryMessageIsThreadRootAsyncCallback& cb);
1045 static void QueryMessageOnline(
const QueryMsgAsyncParam& param,
const QueryMessageOnlineCallback& cb);
1064 static void QueryLocalThreadHistoryMsg(
const IMMessage& msg,
const QueryMsgCallback& cb);
1084 static void QueryUnreadMessages(
const std::string& session_id,
1086 const QueryMsgCallback& cb,
1087 const std::string& json_extension =
"");
导出消息记录到云端参数定义
Definition nim_msglog_helper.h:106
从云端导入消息记录参数定义
Definition nim_msglog_helper.h:185
Definition nim_cpp_msglog.h:97
std::vector< nim::NIMMessageType > list_
Definition nim_cpp_msglog.h:103
Definition nim_cpp_msglog.h:275
std::list< std::string > sender_filter_list_
发送者过滤列表
Definition nim_cpp_msglog.h:294
std::list< std::string > team_filter_list_
Team 群租会话过滤列表
Definition nim_cpp_msglog.h:292
std::string keyword_
要搜索的关键字
Definition nim_cpp_msglog.h:278
std::list< std::string > p2p_filter_list_
P2P 会话过滤列表
Definition nim_cpp_msglog.h:290
std::list< uint32_t > msg_sub_type_filter_list_
消息子类型过滤
Definition nim_cpp_msglog.h:298
FullTextSearchOnlineAsyncParam()
Definition nim_cpp_msglog.h:300
std::list< nim::NIMMessageType > msg_type_filter_list_
消息类型过滤
Definition nim_cpp_msglog.h:296
Definition nim_cpp_msglog.h:208
NIMSessionType to_type_
enum 会话类型,双人0,群组1,超大群5 (nim_msglog_def.h)
Definition nim_cpp_msglog.h:211
std::string client_id
string 消息的客户端id
Definition nim_cpp_msglog.h:219
int64_t server_id
int64_t 消息的服务端id
Definition nim_cpp_msglog.h:217
int64_t time
int64_t 消息时间戳
Definition nim_cpp_msglog.h:221
std::string to_account
string 消息的接收方
Definition nim_cpp_msglog.h:215
std::string from_account
string 消息的发送方
Definition nim_cpp_msglog.h:213
Definition nim_cpp_msglog.h:150
int64_t end_time_
int64_t 结束时间点,单位:毫秒
Definition nim_cpp_msglog.h:166
nim::NIMSessionType to_type_
enum 会话类型,双人0,群组1 (nim_msglog_def.h)
Definition nim_cpp_msglog.h:160
std::string id_
查询id,对方的account id或者群组tid
Definition nim_cpp_msglog.h:156
bool reverse_
bool true:反向查询(按时间正序起查,正序排列),false:按时间逆序起查,逆序排列(建议默认为false)
Definition nim_cpp_msglog.h:168
int limit_count_
int 本次查询的消息条数上限(最多100条)
Definition nim_cpp_msglog.h:162
int64_t from_time_
int64_t 起始时间点,单位:毫秒
Definition nim_cpp_msglog.h:164
bool FormatParam()
Definition nim_cpp_msglog.h:171
std::string json_extension_
Definition nim_cpp_msglog.h:174
std::string keyword_
要查询的关键字
Definition nim_cpp_msglog.h:158
Definition nim_cpp_msglog.h:180
std::string keyword_
要查询的关键字
Definition nim_cpp_msglog.h:184
QueryMsgByKeywordParam()=default
std::vector< nim::NIMMessageType > type_
std::list 要获取的消息类型,默认只有文本类消息,可自行扩充其他类型消息,除通知类消息不受支持外,其他类型消息(包括自定义消息)均可检索
Definition nim_cpp_msglog.h:190
std::string account_id_
查询 ID,对方的 account ID 或者群组 team ID,可留空将不作为查询条件
Definition nim_cpp_msglog.h:186
Definition nim_cpp_msglog.h:244
std::string search_content_
检索文本(目前只支持kNIMMessageTypeText和kNIMMessageTypeFile这两种类型消息的文本关键字检索,即支持文字消息和文件名的检索
Definition nim_cpp_msglog.h:269
std::string end_client_msg_id_
结束查询的最后一条消息的end_client_msg_id(不包含在查询结果中)
Definition nim_cpp_msglog.h:261
std::list< std::string > ids_
会话id(对方的account id或者群组tid)的集合,目前暂不支持多个的组合检索,详见NIMMsgLogQueryRange说明
Definition nim_cpp_msglog.h:253
NIMMessageType msg_type_
检索的消息类型(目前只支持kNIMMessageTypeText、kNIMMessageTypeImage和kNIMMessageTypeFile这三种类型消息)
Definition nim_cpp_msglog.h:265
int32_t msg_sub_type_
消息的子类型
Definition nim_cpp_msglog.h:267
bool reverse_
true:反向查询(按时间正序起查,正序排列),false:按时间逆序起查,逆序排列(建议默认为false)
Definition nim_cpp_msglog.h:263
int limit_count_
本次查询的消息条数上限(最多100条)
Definition nim_cpp_msglog.h:255
NIMMsgLogQueryRange query_range_
消息历史的检索范围(目前暂不支持某些范围的组合检索,详见NIMMsgLogQueryRange说明)
Definition nim_cpp_msglog.h:251
QueryMsgByOptionsAsyncParam()
Definition nim_cpp_msglog.h:246
int64_t end_time_
结束时间点,单位:毫秒
Definition nim_cpp_msglog.h:259
int64_t from_time_
起始时间点,单位:毫秒
Definition nim_cpp_msglog.h:257
Definition nim_cpp_msglog.h:109
bool need_save_to_local_
bool 将在线查询结果保存到本地,false: 不保存
Definition nim_cpp_msglog.h:129
int64_t end_time_
int64_t 结束时间点,单位:毫秒
Definition nim_cpp_msglog.h:123
bool reverse_
bool true:反向查询(按时间正序起查,正序排列),false:按时间逆序起查,逆序排列(建议默认为false)
Definition nim_cpp_msglog.h:127
int limit_count_
int 本次查询的消息条数上限(最多100条)
Definition nim_cpp_msglog.h:119
std::vector< nim::NIMMessageType > msg_type_list_
vector 要获取或排除掉的消息类型 由 is_exclusion_type_ 参数决定
Definition nim_cpp_msglog.h:135
bool replace_local_message_
bool 查询结果回来后,如果 need_save_to_local_ 为 true 是否要替换本地已经存在的消息
Definition nim_cpp_msglog.h:131
std::string id_
查询id,对方的account id或者群组tid
Definition nim_cpp_msglog.h:115
int64_t end_msg_id_
int64_t 结束查询的最后一条消息的server_msg_id(不包含在查询结果中)
Definition nim_cpp_msglog.h:125
int64_t from_time_
int64_t 起始时间点,单位:毫秒
Definition nim_cpp_msglog.h:121
static const AllMessageTypeList AllMsgTypeList
Definition nim_cpp_msglog.h:143
std::string json_extension_
Definition nim_cpp_msglog.h:144
nim::NIMSessionType to_type_
enum 会话类型,双人0,群组1 (nim_msglog_def.h)
Definition nim_cpp_msglog.h:117
bool is_exclusion_type_
bool true : 获取除msg_type_list_中指定的所有类型消息 ,false :只获取 msg_type_list_ 中指定的类型的消息
Definition nim_cpp_msglog.h:137
bool auto_download_attachment_
bool 查询结果回来后,是否需要sdk自动下载消息附件。true:需要,false:不需要
Definition nim_cpp_msglog.h:133
Definition nim_cpp_msglog.h:227
int64_t exclude_msg_id
int64_t 截至消息的服务端id,不包含在查询结果中 缺省0
Definition nim_cpp_msglog.h:234
int64_t from_time
int64_t 起始时间 缺省0
Definition nim_cpp_msglog.h:230
int32_t limit
int32_t 查询条数限制 缺省100
Definition nim_cpp_msglog.h:236
int32_t reverse
int64_t 排序 缺省0 false
Definition nim_cpp_msglog.h:238
int64_t to_time
int64_t 结束时间 缺省0
Definition nim_cpp_msglog.h:232
NIM SDK提供的消息历史接口
Definition nim_cpp_msglog.h:23
std::function< void(NIMResCode res_code, const std::string &msg_id, const IMMessage &msg) QuerySingleMsgCallback)
查询单条消息历史回调模板
Definition nim_cpp_msglog.h:31
DBFunctionCallback DeleteAllCallback
删除全部消息历史回调模板
Definition nim_cpp_msglog.h:62
std::function< void(NIMResCode res_code, const std::string &msg_id) ModifySingleMsglogCallback)
修改(单条)消息历史回调模板
Definition nim_cpp_msglog.h:42
ModifyMultipleMsglogCallback BatchStatusDeleteCallback
批量删除消息历史回调模板
Definition nim_cpp_msglog.h:38
std::function< void(const NIMResCode res_code, const std::string &client_id, const IMMessage &msg) QueryMessageOnlineCallback)
查询某条消息的具体内容回调模板
Definition nim_cpp_msglog.h:87
std::function< void(const NIMResCode res_code, const IMMessage &root_msg, int total, uint64_t last_msg_time, const std::list< IMMessage > &msg_list) QueryThreadHistoryMsgCallback)
分页查询thread talk消息历史回调模板
Definition nim_cpp_msglog.h:91
std::function< void(NIMResCode res_code, const std::string &uid, nim::NIMSessionType to_type) ModifyMultipleMsglogCallback)
修改(多条)消息历史回调模板
Definition nim_cpp_msglog.h:34
std::function< void(const GetMessagesResult &result) GetMessagesDynamicallyCallback)
Definition nim_cpp_msglog.h:28
std::function< void(const std::list< NIMDeleteSessionHistoryMessagesNotifyInfo > &info_list) DeleteHistoryOnLineNotifyCallback)
删除会话的云端的历史记录推送的回调模板
Definition nim_cpp_msglog.h:81
std::function< void(bool is_built)> IsMessageIndexEstablishedCallback
判断消息索引表是否已经构建完成
Definition nim_cpp_msglog.h:313
std::function< void(const NIMResCode, const std::string &, nim::NIMSessionType, uint64_t, const std::string &) DeleteHistoryOnLineAsyncExCallback)
删除某一会话的云端的历史记录的回调模板
Definition nim_cpp_msglog.h:78
std::function< void(const NIMResCode res_code, const std::string &client_id, bool is_root, int reply_count) QueryMessageIsThreadRootAsyncCallback)
查询消息是否是thread聊天的根消息回调模板
Definition nim_cpp_msglog.h:84
std::function< void(NIMResCode res_code)> DBFunctionCallback
消息历史变更回调模板
Definition nim_cpp_msglog.h:57
ModifyMultipleMsglogCallback DeleteBySessionTypeCallback
批量删除消息历史回调模板
Definition nim_cpp_msglog.h:40
ModifyMultipleMsglogCallback BatchStatusReadCallback
批量设置消息历史已读状态回调模板
Definition nim_cpp_msglog.h:36
std::function< void(NIMBuildingMsglogIndexesCompleteReason reason, const std::string &message)> BuildMsglogIndexesComplete
构建消息索引表完成回调
Definition nim_cpp_msglog.h:327
std::function< void(NIMResCode res_code, const std::string &id, nim::NIMSessionType to_type, const QueryMsglogResult &result) QueryMsgCallback)
查询消息历史回调模板
Definition nim_cpp_msglog.h:27
std::function< void(const NIMResCode, const std::string &) DeleteHistoryOnLineAsyncCallback)
删除与某账号(p2p)的所有云端历史记录与漫游消息的回调模板
Definition nim_cpp_msglog.h:75
ModifySingleMsglogCallback SetStatusCallback
修改消息历史状态回调模板
Definition nim_cpp_msglog.h:44
ModifySingleMsglogCallback SetSubStatusCallback
修改消息历史子状态回调模板
Definition nim_cpp_msglog.h:46
ModifySingleMsglogCallback WriteMsglogCallback
保存消息历史回调模板
Definition nim_cpp_msglog.h:50
DBFunctionCallback DeleteMsgByTimeCallback
根据时间段删除部分消息历史回调模板
Definition nim_cpp_msglog.h:65
std::function< void(uint32_t total, uint32_t built_count)> BuildMsglogIndexesProgress
构建消息索引表进度回调
Definition nim_cpp_msglog.h:320
std::function< void(NIMResCode res_code)> DeleteMsglogSelfCallback
单向删除消息记录回调
Definition nim_cpp_msglog.h:59
std::function< void(NIMResCode res_code, const QueryMsglogResult &message_list)> FullTextSearchOnlineAsyncCallback
Definition nim_cpp_msglog.h:93
std::function< void(const MessageStatusChangedResult &) MessageStatusChangedCallback)
发送消息已读回执通知回调模板
Definition nim_cpp_msglog.h:71
ModifySingleMsglogCallback DeleteCallback
删除消息历史回调模板
Definition nim_cpp_msglog.h:52
std::function< void(const DeleteMsglogSelfNotifyParam &) DeleteMsglogSelfNotifyCallback)
单向删除消息记录通知回调
Definition nim_cpp_msglog.h:54
std::function< void(int64_t imported_count, int64_t total_count)> ImportDbPrgCallback
导入消息历史回调模板
Definition nim_cpp_msglog.h:68
ModifySingleMsglogCallback UpdateLocalExtCallback
修改消息历史本地扩展字段内容回调模板
Definition nim_cpp_msglog.h:48
NIMMessageType
Definition nim_msglog_def.h:301
NIMBuildingMsglogIndexesCompleteReason
构建消息索引表完成原因
Definition nim_msglog_def.h:31
NIMMsglogSearchDirection
Definition nim_msglog_def.h:651
@ kForward
以结束时间点为准向前搜索
Definition nim_msglog_def.h:653
NIMMsgLogQueryRange
Definition nim_msglog_def.h:677
NIMMsglogSearchSegmentEngine
Definition nim_msglog_def.h:659
@ kSegmentEngineSimple
单字分词逻辑,默认
Definition nim_msglog_def.h:663
#define NIM_SDK_CPPWRAPPER_DLL_API
Definition nim_sdk_cpp_wrapper.h:38
NIMSessionType
Definition nim_session_def.h:16
@ kNIMSessionTypeP2P
个人,即点对点
Definition nim_session_def.h:18
NIMResCode
Definition public_defines.h:21
#define false
Definition stdbool.h:33
单向删除消息记录回调参数
Definition nim_msglog_helper.h:65
Definition nim_msglog_helper.h:44
Definition nim_talk_helper.h:339
发送消息已读回执
Definition nim_msglog_helper.h:84
查询到消息历史结果
Definition nim_msglog_helper.h:22