NIM PC Cross Platform 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
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
103 enum NIMSessionType to_type,
104 uint64_t from_time,
105 uint64_t to_time,
106 int limit_count,
107 const char* anchor_client_msg_id,
108 uint64_t anchor_server_msg_id,
109 NIMMsglogSearchDirection direction,
110 const char* json_extension,
112 const void* user_data);
113
143 enum NIMSessionType to_type,
144 int limit_count,
145 int64_t from_time,
146 int64_t end_time,
147 int64_t end_msg_id,
148 bool reverse,
149 bool need_save_to_local,
150 const char* json_extension,
152 const void* user_data);
153
169 NIMQueryMsgOnlineAsyncParam query_param,
171 const void* user_data);
172
182 const void* user_data);
183
189
199 const void* progress_user_data,
201 const void* user_data);
202
208
226 const char* keyword,
229 const void* user_data);
230
258 const char* id,
259 int limit_count,
260 int64_t from_time,
261 int64_t end_time,
262 const char* end_client_msg_id,
263 bool reverse,
264 const char* msg_types,
265 const char* json_extension,
267 const void* user_data);
268
301 const char* ids,
302 int limit_count,
303 int64_t from_time,
304 int64_t end_time,
305 const char* end_client_msg_id,
306 bool reverse,
307 enum NIMMessageType msg_type,
308 const char* search_content,
309 const char* json_extension,
311 const void* user_data);
312
322NIM_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);
323
355 uint64_t from_time,
356 uint64_t to_time,
357 uint32_t session_limit,
358 uint32_t msg_limit,
359 uint32_t search_rule,
360 const char* p2p_filter_list,
361 const char* team_filter_list,
362 const char* sender_filter_list,
363 const char* msg_type_filter_list,
364 const char* msg_sub_type_filter_list,
366 const void* user_data);
367
384 enum NIMSessionType to_type,
385 const char* json_extension,
387 const void* user_data);
388
405 enum NIMMsgLogStatus msglog_status,
406 const char* json_extension,
408 const void* user_data);
409
426 enum NIMMsgLogSubStatus msglog_sub_status,
427 const char* json_extension,
429 const void* user_data);
430
451 const char* json_msg,
452 bool need_update_session,
453 const char* json_extension,
455 const void* user_data);
456
473 enum NIMSessionType to_type,
474 const char* json_extension,
476 const void* user_data);
477
496 enum NIMSessionType to_type,
497 bool revert_by_query_online,
498 const char* json_extension,
500 const void* user_data);
501
520 enum NIMSessionType to_type,
521 const char* json_extension,
523 const void* user_data);
524
545 enum NIMSessionType to_type,
546 bool revert_by_query_online,
547 const char* json_extension,
549 const void* user_data);
550
568NIM_SDK_DLL_API void nim_msglog_delete_async(const char* account_id,
569 enum NIMSessionType to_type,
570 const char* msg_id,
571 const char* json_extension,
573 const void* user_data);
574
588 const char* json_extension,
590 const void* user_data);
591
610 bool revert_by_query_online,
611 const char* json_extension,
613 const void* user_data);
614
635 enum NIMSessionType to_type,
636 uint64_t timestamp1,
637 uint64_t timestamp2,
638 const char* json_extension,
640 const void* user_data);
641
664 enum NIMSessionType to_type,
665 bool revert_by_query_online,
666 uint64_t timestamp1,
667 uint64_t timestamp2,
668 const char* json_extension,
670 const void* user_data);
671
683 const char* json_extension,
685 const void* user_data);
686
706 const char* json_extension,
708 const void* res_user_data,
710 const void* prg_user_data);
711
728 const char* json_extension,
730 const void* user_data);
731
738NIM_SDK_DLL_API bool nim_msglog_query_be_readed(const char* json_msg, const char* json_extension);
739
746NIM_SDK_DLL_API bool nim_msglog_query_receipt_sent(const char* json_msg, const char* json_extension);
747
763 enum NIMSessionType to_type,
764 const char* json_extension,
766 const void* user_data);
767
776NIM_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);
777
794 const char* local_ext,
795 const char* json_extension,
797 const void* user_data);
798
808NIM_SDK_DLL_API void nim_msglog_read_all_async(const char* json_extension, nim_msglog_modify_res_cb_func cb, const void* user_data);
809
816
823
829
835
851 bool delete_roaming,
852 const char* json_extension,
854 const void* user_data);
855
873 enum NIMSessionType to_type,
874 bool notify_self,
875 const char* ext,
877 const void* user_data);
878
894 const char* ext,
895 const char* json_extension,
897 const void* user_data);
898
912 int param_count,
914 const void* user_data);
915
928 const void* user_data);
929
939
955 const void* user_data);
956
963NIM_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);
964
965#ifdef __cplusplus
966};
967#endif //__cplusplus
968#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_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:204
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:175
void(* nim_msglog_is_msglog_index_built_cb_func)(bool is_built, const void *user_data)
Definition: nim_msglog_def.h:253
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:136
void(* nim_msglog_delete_message_self_notify_cb_func)(const char *infos, const void *user_data)
Definition: nim_msglog_def.h:100
NIMMsgLogStatus
Definition: nim_msglog_def.h:341
void(* nim_msglog_delete_message_self_res_cb_func)(int res_code, const void *user_data)
Definition: nim_msglog_def.h:92
NIMMessageType
Definition: nim_msglog_def.h:299
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:219
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:463
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:113
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:163
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:255
void(* nim_msglog_modify_res_cb_func)(int res_code, const char *json_extension, const void *user_data)
Definition: nim_msglog_def.h:184
void(* nim_msglog_build_msglog_indexes_complete_cb_func)(NIMBuildingMsglogIndexesCompleteReason reason, const char *error_message, const void *user_data)
Definition: nim_msglog_def.h:257
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:241
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:639
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:194
NIMMsgLogQueryRange
Definition: nim_msglog_def.h:665
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:153
NIMSessionType
Definition: nim_session_def.h:16
单向删除某条消息参数
Definition: nim_msglog_def.h:830
导出消息记录到云端参数定义
Definition: nim_msglog_def.h:527
从云端导入消息记录参数定义
Definition: nim_msglog_def.h:572
云端查询某条消息参数一般用在thread聊天场景中
Definition: nim_msglog_def.h:848
根据关键字村云端查询消息记录的参数定义
Definition: nim_msglog_def.h:737
本地全文检索参数
Definition: nim_msglog_def.h:711
从云端导入消息记录参数定义
Definition: nim_msglog_def.h:685
云端查询thread聊天历史参数
Definition: nim_msglog_def.h:864