NIM PC Cross Platform SDK
nim_msglog.h
Go to the documentation of this file.
1
7#ifndef NIM_SDK_DLL_API_NIM_MSGLOG_H_
8#define NIM_SDK_DLL_API_NIM_MSGLOG_H_
9
10#include "nim_msglog_def.h"
11
12#ifdef __cplusplus
13extern "C" {
14#endif
22
30 const void* user_data);
31
45NIM_SDK_DLL_API void nim_msglog_query_msg_by_id_async(const char* client_msg_id,
46 const char* json_extension,
48 const void* user_data);
49
69NIM_SDK_DLL_API void nim_msglog_query_msg_async(const char* account_id,
70 enum NIMSessionType to_type,
71 int limit_count,
72 int64_t anchor_msg_time,
73 const char* json_extension,
75 const void* user_data);
76
105NIM_SDK_DLL_API void nim_msglog_query_msg_online_async(const char* id,
106 enum NIMSessionType to_type,
107 int limit_count,
108 int64_t from_time,
109 int64_t end_time,
110 int64_t end_msg_id,
111 bool reverse,
112 bool need_save_to_local,
113 const char* json_extension,
115 const void* user_data);
116
131NIM_SDK_DLL_API void nim_msglog_query_msg_online_async2(const char* id,
132 NIMQueryMsgOnlineAsyncParam query_param,
134 const void* user_data);
135
152NIM_SDK_DLL_API void nim_msglog_query_msg_by_keyword_online_async(const char* id,
153 const char* keyword,
156 const void* user_data);
157
185 const char* id,
186 int limit_count,
187 int64_t from_time,
188 int64_t end_time,
189 const char* end_client_msg_id,
190 bool reverse,
191 const char* msg_types,
192 const char* json_extension,
194 const void* user_data);
195
227NIM_SDK_DLL_API void nim_msglog_query_msg_by_options_async(enum NIMMsgLogQueryRange query_range,
228 const char* ids,
229 int limit_count,
230 int64_t from_time,
231 int64_t end_time,
232 const char* end_client_msg_id,
233 bool reverse,
234 enum NIMMessageType msg_type,
235 const char* search_content,
236 const char* json_extension,
238 const void* user_data);
239
249NIM_SDK_DLL_API void nim_msglog_query_msg_by_options_async_ex(const char* json_param, nim_msglog_query_cb_func cb, const void* user_data);
250
281NIM_SDK_DLL_API void nim_msglog_full_text_search_online_async(const char* keyword,
282 uint64_t from_time,
283 uint64_t to_time,
284 uint32_t session_limit,
285 uint32_t msg_limit,
286 uint32_t search_rule,
287 const char* p2p_filter_list,
288 const char* team_filter_list,
289 const char* sender_filter_list,
290 const char* msg_type_filter_list,
291 const char* msg_sub_type_filter_list,
293 const void* user_data);
294
310NIM_SDK_DLL_API void nim_msglog_batch_status_read_async(const char* account_id,
311 enum NIMSessionType to_type,
312 const char* json_extension,
314 const void* user_data);
315
331NIM_SDK_DLL_API void nim_msglog_set_status_async(const char* msg_id,
332 enum NIMMsgLogStatus msglog_status,
333 const char* json_extension,
335 const void* user_data);
336
352NIM_SDK_DLL_API void nim_msglog_set_sub_status_async(const char* msg_id,
353 enum NIMMsgLogSubStatus msglog_sub_status,
354 const char* json_extension,
356 const void* user_data);
357
377NIM_SDK_DLL_API void nim_msglog_insert_msglog_async(const char* talk_id,
378 const char* json_msg,
379 bool need_update_session,
380 const char* json_extension,
382 const void* user_data);
383
399NIM_SDK_DLL_API void nim_msglog_batch_status_delete_async(const char* account_id,
400 enum NIMSessionType to_type,
401 const char* json_extension,
403 const void* user_data);
404
422NIM_SDK_DLL_API void nim_msglog_batch_status_delete_async_ex(const char* account_id,
423 enum NIMSessionType to_type,
424 bool revert_by_query_online,
425 const char* json_extension,
427 const void* user_data);
428
446NIM_SDK_DLL_API void nim_msglog_delete_by_session_type_async(bool delete_sessions,
447 enum NIMSessionType to_type,
448 const char* json_extension,
450 const void* user_data);
451
471NIM_SDK_DLL_API void nim_msglog_delete_by_session_type_async_ex(bool delete_sessions,
472 enum NIMSessionType to_type,
473 bool revert_by_query_online,
474 const char* json_extension,
476 const void* user_data);
477
495NIM_SDK_DLL_API void nim_msglog_delete_async(const char* account_id,
496 enum NIMSessionType to_type,
497 const char* msg_id,
498 const char* json_extension,
500 const void* user_data);
501
514NIM_SDK_DLL_API void nim_msglog_delete_all_async(bool delete_sessions,
515 const char* json_extension,
517 const void* user_data);
518
536NIM_SDK_DLL_API void nim_msglog_delete_all_async_ex(bool delete_sessions,
537 bool revert_by_query_online,
538 const char* json_extension,
540 const void* user_data);
541
561NIM_SDK_DLL_API void nim_msglog_delete_by_time_async(const char* account_id,
562 enum NIMSessionType to_type,
563 uint64_t timestamp1,
564 uint64_t timestamp2,
565 const char* json_extension,
567 const void* user_data);
568
590NIM_SDK_DLL_API void nim_msglog_delete_by_time_async_ex(const char* account_id,
591 enum NIMSessionType to_type,
592 bool revert_by_query_online,
593 uint64_t timestamp1,
594 uint64_t timestamp2,
595 const char* json_extension,
597 const void* user_data);
598
609NIM_SDK_DLL_API void nim_msglog_export_db_async(const char* dst_path,
610 const char* json_extension,
612 const void* user_data);
613
632NIM_SDK_DLL_API void nim_msglog_import_db_async(const char* src_path,
633 const char* json_extension,
635 const void* res_user_data,
637 const void* prg_user_data);
638
654NIM_SDK_DLL_API void nim_msglog_send_receipt_async(const char* json_msg,
655 const char* json_extension,
657 const void* user_data);
658
665NIM_SDK_DLL_API bool nim_msglog_query_be_readed(const char* json_msg, const char* json_extension);
666
673NIM_SDK_DLL_API bool nim_msglog_query_receipt_sent(const char* json_msg, const char* json_extension);
674
683NIM_SDK_DLL_API void nim_msglog_reg_status_changed_cb(const char* json_extension, nim_msglog_status_changed_cb_func cb, const void* user_data);
684
700NIM_SDK_DLL_API void nim_msglog_update_localext_async(const char* msg_id,
701 const char* local_ext,
702 const char* json_extension,
704 const void* user_data);
705
715NIM_SDK_DLL_API void nim_msglog_read_all_async(const char* json_extension, nim_msglog_modify_res_cb_func cb, const void* user_data);
716
722NIM_SDK_DLL_API bool nim_export_backup_to_remote(const NIMLogsBackupExportInfo* export_info);
723
729NIM_SDK_DLL_API bool nim_import_backup_from_remote(const NIMLogsBackupImportInfo* import_info);
730
736
742
757NIM_SDK_DLL_API void nim_msglog_delete_history_online_async(const char* account_id,
758 bool delete_roaming,
759 const char* json_extension,
761 const void* user_data);
762
779NIM_SDK_DLL_API void nim_msglog_delete_history_online_async_ex(const char* account_id,
780 enum NIMSessionType to_type,
781 bool notify_self,
782 const char* ext,
784 const void* user_data);
785
800NIM_SDK_DLL_API void nim_msglog_delete_message_self_async(const char* json_msg,
801 const char* ext,
802 const char* json_extension,
804 const void* user_data);
805
819 int param_count,
821 const void* user_data);
822
833NIM_SDK_DLL_API void nim_msglog_query_message_is_thread_root_async(const char* msg_client_id,
835 const void* user_data);
836
845NIM_SDK_DLL_API void nim_msglog_query_message_online(const NIMQueryMsgAsyncParam& param, nim_msglog_query_single_cb_func cb, const void* user_data);
846
859NIM_SDK_DLL_API void nim_msglog_query_thread_history_msg(const char* json_msg,
862 const void* user_data);
863
864#ifdef __cplusplus
865};
866#endif //__cplusplus
867#endif // NIM_SDK_DLL_API_NIM_MSGLOG_H_
NIM_SDK_DLL_API void nim_msglog_delete_by_time_async_ex(const char *account_id, enum NIMSessionType to_type, bool revert_by_query_online, uint64_t timestamp1, uint64_t timestamp2, const char *json_extension, nim_msglog_modify_res_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_delete_by_session_type_async_ex(bool delete_sessions, enum NIMSessionType to_type, bool revert_by_query_online, const char *json_extension, nim_msglog_res_ex_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_update_localext_async(const char *msg_id, const char *local_ext, const char *json_extension, nim_msglog_res_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_set_status_async(const char *msg_id, enum NIMMsgLogStatus msglog_status, const char *json_extension, nim_msglog_res_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_delete_by_session_type_async(bool delete_sessions, enum NIMSessionType to_type, const char *json_extension, nim_msglog_res_ex_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_batch_status_delete_async(const char *account_id, enum NIMSessionType to_type, const char *json_extension, nim_msglog_res_ex_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_reg_status_changed_cb(const char *json_extension, nim_msglog_status_changed_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_query_msg_by_options_async_ex(const char *json_param, nim_msglog_query_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_delete_history_online_async(const char *account_id, bool delete_roaming, const char *json_extension, nim_msglog_delete_history_online_res_cb_func cb, const void *user_data)
NIM_SDK_DLL_API bool nim_msglog_query_be_readed(const char *json_msg, const char *json_extension)
NIM_SDK_DLL_API void nim_msglog_delete_by_time_async(const char *account_id, enum NIMSessionType to_type, uint64_t timestamp1, uint64_t timestamp2, const char *json_extension, nim_msglog_modify_res_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_read_all_async(const char *json_extension, nim_msglog_modify_res_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_delete_async(const char *account_id, enum NIMSessionType to_type, const char *msg_id, const char *json_extension, nim_msglog_res_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_batch_status_read_async(const char *account_id, enum NIMSessionType to_type, const char *json_extension, nim_msglog_res_ex_cb_func cb, const void *user_data)
NIM_SDK_DLL_API bool nim_export_backup_to_remote(const NIMLogsBackupExportInfo *export_info)
NIM_SDK_DLL_API void nim_msglog_query_message_online(const NIMQueryMsgAsyncParam &param, nim_msglog_query_single_cb_func cb, const void *user_data)
NIM_SDK_DLL_API bool nim_msglog_query_receipt_sent(const char *json_msg, const char *json_extension)
NIM_SDK_DLL_API void nim_msglog_send_receipt_async(const char *json_msg, const char *json_extension, nim_msglog_status_changed_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_cancel_export_backup_to_remote()
NIM_SDK_DLL_API void nim_msglog_query_msg_async(const char *account_id, enum NIMSessionType to_type, int limit_count, int64_t anchor_msg_time, const char *json_extension, nim_msglog_query_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_full_text_search_online_async(const char *keyword, uint64_t from_time, uint64_t to_time, uint32_t session_limit, uint32_t msg_limit, uint32_t search_rule, const char *p2p_filter_list, const char *team_filter_list, const char *sender_filter_list, const char *msg_type_filter_list, const char *msg_sub_type_filter_list, nim_msglog_full_text_search_online_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_set_sub_status_async(const char *msg_id, enum NIMMsgLogSubStatus msglog_sub_status, const char *json_extension, nim_msglog_res_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_insert_msglog_async(const char *talk_id, const char *json_msg, bool need_update_session, const char *json_extension, nim_msglog_res_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_query_thread_history_msg(const char *json_msg, const NIMQueryThreadHistoryMsgAsyncParam &param, const nim_msglog_query_thread_history_msg_cb_func &cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_delete_all_async(bool delete_sessions, const char *json_extension, nim_msglog_modify_res_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_delete_history_online_async_ex(const char *account_id, enum NIMSessionType to_type, bool notify_self, const char *ext, nim_msglog_delete_history_online_res_cb_func_ex cb, const void *user_data)
NIM_SDK_DLL_API void nim_cancel_import_backup_from_remote()
NIM_SDK_DLL_API void nim_msglog_register_delete_history_messages_callback(const nim_msglog_delete_history_online_notify_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_export_db_async(const char *dst_path, const char *json_extension, nim_msglog_modify_res_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_query_msg_online_async(const char *id, enum 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 char *json_extension, nim_msglog_query_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_register_delete_msgs_self_callback(const nim_msglog_delete_message_self_notify_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_import_db_async(const char *src_path, const char *json_extension, nim_msglog_modify_res_cb_func res_cb, const void *res_user_data, nim_msglog_import_prg_cb_func prg_cb, const void *prg_user_data)
NIM_SDK_DLL_API void nim_msglog_delete_message_self_async(const char *json_msg, const char *ext, const char *json_extension, nim_msglog_delete_message_self_res_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_batch_status_delete_async_ex(const char *account_id, enum NIMSessionType to_type, bool revert_by_query_online, const char *json_extension, nim_msglog_res_ex_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_delete_all_async_ex(bool delete_sessions, bool revert_by_query_online, const char *json_extension, nim_msglog_modify_res_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_query_message_is_thread_root_async(const char *msg_client_id, nim_msglog_query_message_is_thread_root_async_cb_func cb, const void *user_data)
NIM_SDK_DLL_API bool nim_import_backup_from_remote(const NIMLogsBackupImportInfo *import_info)
NIM_SDK_DLL_API void nim_msglog_delete_messages_self_async(NIMDeleteMessagesSelfParam *param, int param_count, nim_msglog_delete_message_self_res_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_query_msg_by_keyword_online_async(const char *id, const char *keyword, NIMQueryMsgByKeywordOnlineAsyncParam query_param, nim_msglog_query_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_query_msg_by_options_async(enum NIMMsgLogQueryRange query_range, const char *ids, int limit_count, int64_t from_time, int64_t end_time, const char *end_client_msg_id, bool reverse, enum NIMMessageType msg_type, const char *search_content, const char *json_extension, nim_msglog_query_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_query_the_message_of_the_specified_type_async(enum NIMSessionType to_type, const char *id, int limit_count, int64_t from_time, int64_t end_time, const char *end_client_msg_id, bool reverse, const char *msg_types, const char *json_extension, nim_msglog_query_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_query_msg_by_id_async(const char *client_msg_id, const char *json_extension, nim_msglog_query_single_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_query_msg_online_async2(const char *id, NIMQueryMsgOnlineAsyncParam query_param, nim_msglog_query_cb_func cb, const void *user_data)
消息历史 接口相关的常量函数等定义头文件
void(* nim_msglog_status_changed_cb_func)(int res_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_msglog_def.h:188
void(* nim_msglog_res_ex_cb_func)(int res_code, const char *uid, enum NIMSessionType type, const char *json_extension, const void *user_data)
Definition: nim_msglog_def.h:159
void(* nim_msglog_query_cb_func)(int res_code, const char *id, enum NIMSessionType type, const char *result, const char *json_extension, const void *user_data)
Definition: nim_msglog_def.h:120
void(* nim_msglog_delete_message_self_notify_cb_func)(const char *infos, const void *user_data)
Definition: nim_msglog_def.h:84
NIMMsgLogStatus
Definition: nim_msglog_def.h:312
void(* nim_msglog_delete_message_self_res_cb_func)(int res_code, const void *user_data)
Definition: nim_msglog_def.h:76
NIMMessageType
Definition: nim_msglog_def.h:269
void(* nim_msglog_query_message_is_thread_root_async_cb_func)(int res_code, const char *client_id, bool is_root, int reply_count, const void *user_data)
Definition: nim_msglog_def.h:203
void(* nim_msglog_delete_history_online_res_cb_func_ex)(int res_code, const char *accid, enum NIMSessionType type, uint64_t time, const char *ext, const void *user_data)
Definition: nim_msglog_def.h:51
NIMMsgLogSubStatus
Definition: nim_msglog_def.h:434
void(* nim_msglog_query_single_cb_func)(int res_code, const char *msg_id, const char *result, const char *json_extension, const void *user_data)
Definition: nim_msglog_def.h:97
void(* nim_msglog_res_cb_func)(int res_code, const char *msg_id, const char *json_extension, const void *user_data)
Definition: nim_msglog_def.h:147
void(* nim_msglog_modify_res_cb_func)(int res_code, const char *json_extension, const void *user_data)
Definition: nim_msglog_def.h:168
void(* nim_msglog_query_thread_history_msg_cb_func)(int res_code, const char *root_msg, int total, uint64_t timestamp, const char *msgs, const void *user_data)
Definition: nim_msglog_def.h:225
void(* nim_msglog_delete_history_online_notify_cb_func)(NIMDeleteSessionHistoryMessagesNotifyInfo *info_list_head_node, int node_count, const void *user_data)
Definition: nim_msglog_def.h:66
void(* nim_msglog_import_prg_cb_func)(int64_t imported_count, int64_t total_count, const char *json_extension, const void *user_data)
Definition: nim_msglog_def.h:178
NIMMsgLogQueryRange
Definition: nim_msglog_def.h:618
void(* nim_msglog_delete_history_online_res_cb_func)(int res_code, const char *accid, const void *user_data)
Definition: nim_msglog_def.h:35
void(* nim_msglog_full_text_search_online_cb_func)(int res_code, uint32_t count, const char *result, const char *json_extension, const void *user_data)
Definition: nim_msglog_def.h:137
NIMSessionType
Definition: nim_session_def.h:16
单向删除某条消息参数
Definition: nim_msglog_def.h:757
导出消息记录到云端参数定义
Definition: nim_msglog_def.h:498
从云端导入消息记录参数定义
Definition: nim_msglog_def.h:543
云端查询某条消息参数一般用在thread聊天场景中
Definition: nim_msglog_def.h:775
根据关键字村云端查询消息记录的参数定义
Definition: nim_msglog_def.h:664
从云端导入消息记录参数定义
Definition: nim_msglog_def.h:638
云端查询thread聊天历史参数
Definition: nim_msglog_def.h:791