NIM 跨平台 C++ SDK
载入中...
搜索中...
未找到
nim_msglog.h
浏览该文件的文档.
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
39
54 const char* json_extension,
56 const void* user_data);
57
77NIM_SDK_DLL_API void nim_msglog_query_msg_async(const char* account_id,
78 enum NIMSessionType to_type,
79 int limit_count,
80 int64_t anchor_msg_time,
81 const char* json_extension,
83 const void* user_data);
84
111 enum NIMSessionType to_type,
112 uint64_t from_time,
113 uint64_t to_time,
114 int limit_count,
115 const char* anchor_client_msg_id,
116 uint64_t anchor_server_msg_id,
117 NIMMsglogSearchDirection direction,
118 const char* json_extension,
120 const void* user_data);
121
151 enum NIMSessionType to_type,
152 int limit_count,
153 int64_t from_time,
154 int64_t end_time,
155 int64_t end_msg_id,
156 bool reverse,
157 bool need_save_to_local,
158 const char* json_extension,
160 const void* user_data);
161
177 NIMQueryMsgOnlineAsyncParam query_param,
179 const void* user_data);
180
190 const void* user_data);
191
197
207 const void* progress_user_data,
209 const void* user_data);
210
216
234 const char* keyword,
237 const void* user_data);
238
266 const char* id,
267 int limit_count,
268 int64_t from_time,
269 int64_t end_time,
270 const char* end_client_msg_id,
271 bool reverse,
272 const char* msg_types,
273 const char* json_extension,
275 const void* user_data);
276
309 const char* ids,
310 int limit_count,
311 int64_t from_time,
312 int64_t end_time,
313 const char* end_client_msg_id,
314 bool reverse,
315 enum NIMMessageType msg_type,
316 const char* search_content,
317 const char* json_extension,
319 const void* user_data);
320
330NIM_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);
331
363 uint64_t from_time,
364 uint64_t to_time,
365 uint32_t session_limit,
366 uint32_t msg_limit,
367 uint32_t search_rule,
368 const char* p2p_filter_list,
369 const char* team_filter_list,
370 const char* sender_filter_list,
371 const char* msg_type_filter_list,
372 const char* msg_sub_type_filter_list,
374 const void* user_data);
375
392 enum NIMSessionType to_type,
393 const char* json_extension,
395 const void* user_data);
396
413 enum NIMMsgLogStatus msglog_status,
414 const char* json_extension,
416 const void* user_data);
417
434 enum NIMMsgLogSubStatus msglog_sub_status,
435 const char* json_extension,
437 const void* user_data);
438
459 const char* json_msg,
460 bool need_update_session,
461 const char* json_extension,
463 const void* user_data);
464
481 enum NIMSessionType to_type,
482 const char* json_extension,
484 const void* user_data);
485
504 enum NIMSessionType to_type,
505 bool revert_by_query_online,
506 const char* json_extension,
508 const void* user_data);
509
528 enum NIMSessionType to_type,
529 const char* json_extension,
531 const void* user_data);
532
553 enum NIMSessionType to_type,
554 bool revert_by_query_online,
555 const char* json_extension,
557 const void* user_data);
558
576NIM_SDK_DLL_API void nim_msglog_delete_async(const char* account_id,
577 enum NIMSessionType to_type,
578 const char* msg_id,
579 const char* json_extension,
581 const void* user_data);
582
596 const char* json_extension,
598 const void* user_data);
599
618 bool revert_by_query_online,
619 const char* json_extension,
621 const void* user_data);
622
643 enum NIMSessionType to_type,
644 uint64_t timestamp1,
645 uint64_t timestamp2,
646 const char* json_extension,
648 const void* user_data);
649
672 enum NIMSessionType to_type,
673 bool revert_by_query_online,
674 uint64_t timestamp1,
675 uint64_t timestamp2,
676 const char* json_extension,
678 const void* user_data);
679
691 const char* json_extension,
693 const void* user_data);
694
714 const char* json_extension,
716 const void* res_user_data,
718 const void* prg_user_data);
719
736 const char* json_extension,
738 const void* user_data);
739
746NIM_SDK_DLL_API bool nim_msglog_query_be_readed(const char* json_msg, const char* json_extension);
747
754NIM_SDK_DLL_API bool nim_msglog_query_receipt_sent(const char* json_msg, const char* json_extension);
755
771 enum NIMSessionType to_type,
772 const char* json_extension,
774 const void* user_data);
775
784NIM_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);
785
802 const char* local_ext,
803 const char* json_extension,
805 const void* user_data);
806
816NIM_SDK_DLL_API void nim_msglog_read_all_async(const char* json_extension, nim_msglog_modify_res_cb_func cb, const void* user_data);
817
824
831
837
843
859 bool delete_roaming,
860 const char* json_extension,
862 const void* user_data);
863
881 enum NIMSessionType to_type,
882 bool notify_self,
883 const char* ext,
885 const void* user_data);
886
902 const char* ext,
903 const char* json_extension,
905 const void* user_data);
906
920 int param_count,
922 const void* user_data);
923
936 const void* user_data);
937
947
963 const void* user_data);
964
971NIM_SDK_DLL_API void nim_msglog_query_local_thread_history_msg(const char* json_msg, const nim_msglog_query_cb_func& cb, const void* user_data);
972
973#ifdef __cplusplus
974};
975#endif //__cplusplus
976#endif // NIM_SDK_DLL_API_NIM_MSGLOG_H_
#define NIM_SDK_DLL_API
Definition: nim_build_config.h:14
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_cancel_msglog_indexes_building()
取消消息索引的构建
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_query_msg_local_async(const NIMQueryMsgLocalAsyncParam *query_param, nim_msglog_query_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_is_msglog_indexes_established(nim_msglog_is_msglog_index_built_cb_func cb, const void *user_data)
判断消息索引是否已经建立完成,如果已经建立完成,则可以使用 nim_msglog_query_msg_local_async 接口通过关键字全文检索
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_get_messages_dynamically(const char *session_id, enum NIMSessionType to_type, uint64_t from_time, uint64_t to_time, int limit_count, const char *anchor_client_msg_id, uint64_t anchor_server_msg_id, NIMMsglogSearchDirection direction, const char *json_extension, nim_msglog_query_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_query_unread_messages(const char *account_id, enum NIMSessionType to_type, const char *json_extension, nim_msglog_query_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_local_thread_history_msg(const char *json_msg, const nim_msglog_query_cb_func &cb, const void *user_data)
NIM_SDK_DLL_API void nim_msglog_build_msglog_indexes(uint32_t page_size, nim_msglog_build_msglog_indexes_progress_cb_func progress, const void *progress_user_data, nim_msglog_build_msglog_indexes_complete_cb_func completion, 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_register_history_message_filter_callback(nim_msglog_history_message_filter_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:212
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:183
void(* nim_msglog_is_msglog_index_built_cb_func)(bool is_built, const void *user_data)
Definition: nim_msglog_def.h:261
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:144
void(* nim_msglog_delete_message_self_notify_cb_func)(const char *infos, const void *user_data)
Definition: nim_msglog_def.h:108
NIMMsgLogStatus
Definition: nim_msglog_def.h:351
void(* nim_msglog_delete_message_self_res_cb_func)(int res_code, const void *user_data)
Definition: nim_msglog_def.h:100
NIMMessageType
Definition: nim_msglog_def.h:309
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:227
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:67
NIMMsgLogSubStatus
Definition: nim_msglog_def.h:473
bool(* nim_msglog_history_message_filter_func)(const char *content, const void *user_data)
Definition: nim_msglog_def.h:92
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:121
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:171
void(* nim_msglog_build_msglog_indexes_progress_cb_func)(uint32_t total, uint32_t built_count, const void *user_data)
Definition: nim_msglog_def.h:263
void(* nim_msglog_modify_res_cb_func)(int res_code, const char *json_extension, const void *user_data)
Definition: nim_msglog_def.h:192
void(* nim_msglog_build_msglog_indexes_complete_cb_func)(NIMBuildingMsglogIndexesCompleteReason reason, const char *error_message, const void *user_data)
Definition: nim_msglog_def.h:265
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:249
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:82
NIMMsglogSearchDirection
Definition: nim_msglog_def.h:659
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:202
NIMMsgLogQueryRange
Definition: nim_msglog_def.h:685
void(* nim_msglog_delete_history_online_res_cb_func)(int res_code, const char *accid, const void *user_data)
Definition: nim_msglog_def.h:51
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:161
NIMSessionType
Definition: nim_session_def.h:16
单向删除某条消息参数
Definition: nim_msglog_def.h:852
导出消息记录到云端参数定义
Definition: nim_msglog_def.h:547
从云端导入消息记录参数定义
Definition: nim_msglog_def.h:592
云端查询某条消息参数一般用在thread聊天场景中
Definition: nim_msglog_def.h:870
根据关键字村云端查询消息记录的参数定义
Definition: nim_msglog_def.h:759
本地全文检索参数
Definition: nim_msglog_def.h:733
从云端导入消息记录参数定义
Definition: nim_msglog_def.h:705
云端查询thread聊天历史参数
Definition: nim_msglog_def.h:886