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_;
242 std::string ToJsonString()
const;
250 uint64_t from_time_{0};
252 uint64_t to_time_{0};
254 uint32_t session_limit_{0};
256 uint32_t msglog_limit_{0};
258 uint32_t search_rule_{0};
282 static void UnregMsglogCb();
288 static void RegDeleteMsglogSelfNotify(
const DeleteMsglogSelfNotifyCallback& cb);
295 static void RegDeleteHistoryMessagesNotify(
const DeleteHistoryOnLineNotifyCallback& cb);
306 static bool QueryMsgByIDAysnc(
const std::string& client_msg_id,
const QuerySingleMsgCallback& cb,
const std::string& json_extension =
"");
325 static bool QueryMsgAsync(
const std::string& account_id,
326 nim::NIMSessionType to_type,
328 int64_t anchor_msg_time,
329 const QueryMsgCallback& cb,
330 const std::string& json_extension =
"");
356 static void GetMessagesDynamically(
const std::string& session_id,
357 nim::NIMSessionType to_type,
360 uint32_t limit_count,
361 const std::string& anchor_client_msg_id,
362 uint64_t anchor_server_msg_id,
364 const GetMessagesDynamicallyCallback& cb,
365 const std::string& json_extension =
"");
376 static bool QueryMsgOnlineAsync(
const QueryMsgOnlineAsyncParam& param,
const QueryMsgCallback& cb);
395 static bool QueryMsgOnlineAsync(
const std::string&
id,
396 nim::NIMSessionType to_type,
402 bool need_save_to_local,
403 const QueryMsgCallback& cb,
404 const std::string& json_extension =
"");
443 static bool QueryMsgOfSpecifiedTypeInASessionAsync(nim::NIMSessionType to_type,
444 const std::string&
id,
448 const std::string& end_client_msg_id,
450 std::list<NIMMessageType> msg_type,
451 const QueryMsgCallback& cb,
452 const std::string& json_extension =
"");
483 const std::list<std::string>& ids,
487 const std::string& end_client_msg_id,
490 const std::string& search_content,
491 const QueryMsgCallback& cb,
492 const std::string& json_extension =
"");
502 static bool QueryMsgByOptionsAsyncEx(
const QueryMsgByOptionsAsyncParam& param,
const QueryMsgCallback& cb);
517 static bool BatchStatusReadAsync(
const std::string& account_id,
518 nim::NIMSessionType to_type,
519 const BatchStatusReadCallback& cb,
520 const std::string& json_extension =
"");
533 static bool BatchStatusDeleteAsync(
const std::string& account_id,
534 nim::NIMSessionType to_type,
535 const BatchStatusDeleteCallback& cb,
536 const std::string& json_extension =
"");
550 static bool BatchStatusDeleteAsyncEx(
const std::string& account_id,
551 nim::NIMSessionType to_type,
552 bool revert_by_query_online,
553 const BatchStatusDeleteCallback& cb,
554 const std::string& json_extension =
"");
567 static bool SetStatusAsync(
const std::string& msg_id,
568 nim::NIMMsgLogStatus msglog_status,
569 const SetStatusCallback& cb,
570 const std::string& json_extension =
"");
583 static bool SetSubStatusAsync(
const std::string& msg_id,
584 nim::NIMMsgLogSubStatus msglog_sub_status,
585 const SetSubStatusCallback& cb,
586 const std::string& json_extension =
"");
600 static bool WriteMsglogToLocalAsync(
const std::string& talk_id,
602 bool need_update_session,
603 const WriteMsglogCallback& cb,
604 const std::string& json_extension =
"");
624 static bool WriteMsglogToLocalAsyncEx(
const std::string& talk_id,
626 bool need_update_session,
627 bool compose_last_msg,
628 const std::list<NIMMessageType>& exclude_msg_type,
629 const WriteMsglogCallback& cb);
643 static bool DeleteBySessionTypeAsync(
bool delete_sessions,
645 const DeleteBySessionTypeCallback& cb,
646 const std::string& json_extension =
"");
661 static bool DeleteBySessionTypeAsyncEx(
bool delete_sessions,
663 bool revert_by_query_online,
664 const DeleteBySessionTypeCallback& cb,
665 const std::string& json_extension =
"");
679 static bool DeleteAsync(
const std::string& session_id,
681 const std::string& msg_id,
682 const DeleteCallback& cb,
683 const std::string& json_extension =
"");
696 static bool DeleteAllAsync(
bool delete_sessions,
const DeleteAllCallback& cb,
const std::string& json_extension =
"");
711 static bool DeleteAllAsyncEx(
bool delete_sessions,
712 bool revert_by_query_online,
713 const DeleteAllCallback& cb,
714 const std::string& json_extension =
"");
729 static bool DeleteMsgByTimeAsync(
const std::string& session_id,
733 const DeleteMsgByTimeCallback& cb,
734 const std::string& json_extension =
"");
750 static bool DeleteMsgByTimeAsyncEx(
const std::string& session_id,
752 bool revert_by_query_online,
755 const DeleteMsgByTimeCallback& cb,
756 const std::string& json_extension =
"");
767 static bool ExportDbAsync(
const std::string& dst_path,
const DBFunctionCallback& cb,
const std::string& json_extension =
"");
781 static bool ImportDbAsync(
const std::string& src_path,
782 const DBFunctionCallback& cb,
783 const ImportDbPrgCallback& prg_cb,
784 const std::string& json_extension =
"");
796 static void SendReceiptAsync(
const std::string& json_msg,
const MessageStatusChangedCallback& cb);
808 static void SendReceiptAsync(
const IMMessage& msg,
const MessageStatusChangedCallback& cb);
815 static bool QuerySentMessageBeReaded(
const IMMessage& msg);
822 static bool QueryReceivedMsgReceiptSent(
const IMMessage& msg);
831 static void RegMessageStatusChangedCb(
const MessageStatusChangedCallback& cb,
const std::string& json_extension =
"");
844 static bool UpdateLocalExtAsync(
const std::string& msg_id,
845 const std::string& local_ext,
846 const UpdateLocalExtCallback& cb,
847 const std::string& json_extension =
"");
852 static void UnregMsgologCb();
862 static bool ReadAllAsync(
const DBFunctionCallback& cb,
const std::string& json_extension =
"");
882 static void CancelImportBackupFromRemote();
888 static void CancelExportBackupToRemote();
900 static void DeleteHistoryOnlineAsync(
const std::string& accid,
902 const std::string& json_extension,
903 const DeleteHistoryOnLineAsyncCallback& cb);
919 static void DeleteHistoryOnlineAsync(
const std::string& accid,
920 nim::NIMSessionType to_type,
922 const std::string& ext,
923 const DeleteHistoryOnLineAsyncExCallback& cb);
933 static void DeleteMessageSelfAsync(
const IMMessage& msg,
const std::string ext,
const DeleteMsglogSelfCallback& cb);
942 static void DeleteMessageSelfAsync(
const std::list<std::tuple<IMMessage, std::string>>& msgs,
const DeleteMsglogSelfCallback& cb);
951 static void QueryMessageIsThreadRoot(
const std::string msg_client_id,
const QueryMessageIsThreadRootAsyncCallback& cb);
960 static void QueryMessageOnline(
const QueryMsgAsyncParam& param,
const QueryMessageOnlineCallback& cb);
969 static void QueryThreadHistoryMsg(
const IMMessage& msg,
const QueryThreadHistoryMsgAsyncParam& param,
const QueryThreadHistoryMsgCallback& cb);
979 static void QueryLocalThreadHistoryMsg(
const IMMessage& msg,
const QueryMsgCallback& cb);
988 static void FullTextSearchOnlineAsync(
const FullTextSearchOnlineAsyncParam& param,
const FullTextSearchOnlineAsyncCallback& cb);
999 static void QueryUnreadMessages(
const std::string& session_id,
1001 const QueryMsgCallback& cb,
1002 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:245
std::list< std::string > sender_filter_list_
发送者过滤列表
Definition: nim_cpp_msglog.h:264
std::list< std::string > team_filter_list_
Team 群租会话过滤列表
Definition: nim_cpp_msglog.h:262
std::string keyword_
要搜索的关键字
Definition: nim_cpp_msglog.h:248
std::list< std::string > p2p_filter_list_
P2P 会话过滤列表
Definition: nim_cpp_msglog.h:260
std::list< uint32_t > msg_sub_type_filter_list_
消息子类型过滤
Definition: nim_cpp_msglog.h:268
FullTextSearchOnlineAsyncParam()
Definition: nim_cpp_msglog.h:270
std::list< nim::NIMMessageType > msg_type_filter_list_
消息类型过滤
Definition: nim_cpp_msglog.h:266
Definition: nim_cpp_msglog.h:178
NIMSessionType to_type_
enum 会话类型,双人0,群组1,超大群5 (nim_msglog_def.h)
Definition: nim_cpp_msglog.h:181
std::string client_id
string 消息的客户端id
Definition: nim_cpp_msglog.h:189
int64_t server_id
int64_t 消息的服务端id
Definition: nim_cpp_msglog.h:187
int64_t time
int64_t 消息时间戳
Definition: nim_cpp_msglog.h:191
std::string to_account
string 消息的接收方
Definition: nim_cpp_msglog.h:185
std::string from_account
string 消息的发送方
Definition: nim_cpp_msglog.h:183
Definition: nim_cpp_msglog.h:148
int64_t end_time_
int64_t 结束时间点,单位:毫秒
Definition: nim_cpp_msglog.h:164
nim::NIMSessionType to_type_
enum 会话类型,双人0,群组1 (nim_msglog_def.h)
Definition: nim_cpp_msglog.h:158
std::string id_
查询id,对方的account id或者群组tid
Definition: nim_cpp_msglog.h:154
bool reverse_
bool true:反向查询(按时间正序起查,正序排列),false:按时间逆序起查,逆序排列(建议默认为false)
Definition: nim_cpp_msglog.h:166
int limit_count_
int 本次查询的消息条数上限(最多100条)
Definition: nim_cpp_msglog.h:160
int64_t from_time_
int64_t 起始时间点,单位:毫秒
Definition: nim_cpp_msglog.h:162
bool FormatParam()
Definition: nim_cpp_msglog.h:169
std::string json_extension_
Definition: nim_cpp_msglog.h:172
std::string keyword_
要查询的关键字
Definition: nim_cpp_msglog.h:156
Definition: nim_cpp_msglog.h:214
std::string search_content_
检索文本(目前只支持kNIMMessageTypeText和kNIMMessageTypeFile这两种类型消息的文本关键字检索,即支持文字消息和文件名的检索
Definition: nim_cpp_msglog.h:239
std::string end_client_msg_id_
结束查询的最后一条消息的end_client_msg_id(不包含在查询结果中)
Definition: nim_cpp_msglog.h:231
std::list< std::string > ids_
会话id(对方的account id或者群组tid)的集合,目前暂不支持多个的组合检索,详见NIMMsgLogQueryRange说明
Definition: nim_cpp_msglog.h:223
NIMMessageType msg_type_
检索的消息类型(目前只支持kNIMMessageTypeText、kNIMMessageTypeImage和kNIMMessageTypeFile这三种类型消息)
Definition: nim_cpp_msglog.h:235
int32_t msg_sub_type_
消息的子类型
Definition: nim_cpp_msglog.h:237
bool reverse_
true:反向查询(按时间正序起查,正序排列),false:按时间逆序起查,逆序排列(建议默认为false)
Definition: nim_cpp_msglog.h:233
int limit_count_
本次查询的消息条数上限(最多100条)
Definition: nim_cpp_msglog.h:225
NIMMsgLogQueryRange query_range_
消息历史的检索范围(目前暂不支持某些范围的组合检索,详见NIMMsgLogQueryRange说明)
Definition: nim_cpp_msglog.h:221
QueryMsgByOptionsAsyncParam()
Definition: nim_cpp_msglog.h:216
int64_t end_time_
结束时间点,单位:毫秒
Definition: nim_cpp_msglog.h:229
int64_t from_time_
起始时间点,单位:毫秒
Definition: nim_cpp_msglog.h:227
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:133
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:141
std::string json_extension_
Definition: nim_cpp_msglog.h:142
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:135
bool auto_download_attachment_
bool 查询结果回来后,是否需要sdk自动下载消息附件。true:需要,false:不需要
Definition: nim_cpp_msglog.h:131
Definition: nim_cpp_msglog.h:197
int64_t exclude_msg_id
int64_t 截至消息的服务端id,不包含在查询结果中 缺省0
Definition: nim_cpp_msglog.h:204
int64_t from_time
int64_t 起始时间 缺省0
Definition: nim_cpp_msglog.h:200
int32_t limit
int32_t 查询条数限制 缺省100
Definition: nim_cpp_msglog.h:206
int32_t reverse
int64_t 排序 缺省0 false
Definition: nim_cpp_msglog.h:208
int64_t to_time
int64_t 结束时间 缺省0
Definition: nim_cpp_msglog.h:202
NIM SDK提供的消息历史接口
Definition: nim_cpp_msglog.h:23
DBFunctionCallback DeleteAllCallback
删除全部消息历史回调模板
Definition: nim_cpp_msglog.h:62
std::function< void(const NIMResCode, const std::string &)> DeleteHistoryOnLineAsyncCallback
删除与某账号(p2p)的所有云端历史记录与漫游消息的回调模板
Definition: nim_cpp_msglog.h:75
ModifyMultipleMsglogCallback BatchStatusDeleteCallback
批量删除消息历史回调模板
Definition: nim_cpp_msglog.h:38
std::function< void(NIMResCode res_code, const std::string &msg_id, const IMMessage &msg)> QuerySingleMsgCallback
查询单条消息历史回调模板
Definition: nim_cpp_msglog.h:31
std::function< void(const std::list< NIMDeleteSessionHistoryMessagesNotifyInfo > &info_list)> DeleteHistoryOnLineNotifyCallback
删除会话的云端的历史记录推送的回调模板
Definition: nim_cpp_msglog.h:81
std::function< void(NIMResCode res_code, const QueryMsglogResult &message_list)> FullTextSearchOnlineAsyncCallback
Definition: nim_cpp_msglog.h:95
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, const IMMessage &msg)> QueryMessageOnlineCallback
查询某条消息的具体内容回调模板
Definition: nim_cpp_msglog.h:87
std::function< void(const DeleteMsglogSelfNotifyParam &)> DeleteMsglogSelfNotifyCallback
单向删除消息记录通知回调
Definition: nim_cpp_msglog.h:54
std::function< void(NIMResCode res_code)> DBFunctionCallback
消息历史变更回调模板
Definition: nim_cpp_msglog.h:57
std::function< void(const GetMessagesResult &result)> GetMessagesDynamicallyCallback
Definition: nim_cpp_msglog.h:28
ModifyMultipleMsglogCallback DeleteBySessionTypeCallback
批量删除消息历史回调模板
Definition: nim_cpp_msglog.h:40
ModifyMultipleMsglogCallback BatchStatusReadCallback
批量设置消息历史已读状态回调模板
Definition: nim_cpp_msglog.h:36
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
ModifySingleMsglogCallback SetStatusCallback
修改消息历史状态回调模板
Definition: nim_cpp_msglog.h:44
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
ModifySingleMsglogCallback SetSubStatusCallback
修改消息历史子状态回调模板
Definition: nim_cpp_msglog.h:46
std::function< void(NIMResCode res_code, const std::string &msg_id)> ModifySingleMsglogCallback
修改(单条)消息历史回调模板
Definition: nim_cpp_msglog.h:42
ModifySingleMsglogCallback WriteMsglogCallback
保存消息历史回调模板
Definition: nim_cpp_msglog.h:50
DBFunctionCallback DeleteMsgByTimeCallback
根据时间段删除部分消息历史回调模板
Definition: nim_cpp_msglog.h:65
std::function< void(NIMResCode res_code)> DeleteMsglogSelfCallback
单向删除消息记录回调
Definition: nim_cpp_msglog.h:59
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(NIMResCode res_code, const std::string &uid, nim::NIMSessionType to_type)> ModifyMultipleMsglogCallback
修改(多条)消息历史回调模板
Definition: nim_cpp_msglog.h:34
ModifySingleMsglogCallback DeleteCallback
删除消息历史回调模板
Definition: nim_cpp_msglog.h:52
std::function< void(const MessageStatusChangedResult &)> MessageStatusChangedCallback
发送消息已读回执通知回调模板
Definition: nim_cpp_msglog.h:71
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:270
NIMMsglogSearchDirection
Definition: nim_msglog_def.h:610
NIMMsgLogQueryRange
Definition: nim_msglog_def.h:618
#define NIM_SDK_CPPWRAPPER_DLL_API
Definition: nim_sdk_cpp_wrapper.h:38
NIMSessionType
Definition: nim_session_def.h:16
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:305
发送消息已读回执
Definition: nim_msglog_helper.h:84
查询到消息历史结果
Definition: nim_msglog_helper.h:22