nim_msglog_def.h

Go to the documentation of this file.

 
#ifndef NIM_SDK_DLL_EXPORT_HEADERS_MSGLOG_DEF_H_
#define NIM_SDK_DLL_EXPORT_HEADERS_MSGLOG_DEF_H_
 
#include "nim_session_def.h"
#include "public_defines.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct {
    enum NIMSessionType to_type; 
    char id[128];                
    int64_t time;                
    char ext[1024];              
} NIMDeleteSessionHistoryMessagesNotifyInfo;
 
typedef void (*nim_msglog_delete_history_online_res_cb_func)(int res_code, const char* accid, const void* user_data);
 
typedef 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);
 
typedef void (*nim_msglog_delete_history_online_notify_cb_func)(NIMDeleteSessionHistoryMessagesNotifyInfo* info_list_head_node,
                                                                int node_count,
                                                                const void* user_data);
 
typedef void (*nim_msglog_delete_message_self_res_cb_func)(int res_code, const void* user_data);
 
typedef void (*nim_msglog_delete_message_self_notify_cb_func)(const char* infos, const void* user_data);
 
typedef 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);
 
typedef 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);
 
typedef 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);
 
typedef void (*nim_msglog_res_cb_func)(int res_code, const char* msg_id, const char* json_extension, const void* user_data);
 
typedef void (*nim_msglog_res_ex_cb_func)(int res_code, const char* uid, enum NIMSessionType type, const char* json_extension, const void* user_data);
 
typedef void (*nim_msglog_modify_res_cb_func)(int res_code, const char* json_extension, const void* user_data);
 
typedef void (*nim_msglog_import_prg_cb_func)(int64_t imported_count, int64_t total_count, const char* json_extension, const void* user_data);
 
typedef void (*nim_msglog_status_changed_cb_func)(int res_code, const char* result, const char* json_extension, const void* user_data);
 
typedef 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);
 
typedef 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);
 
static const char* kNIMMsglogStatusChangedKeyTalkID = "talk_id";         
static const char* kNIMMsglogStatusChangedKeyMsgTimetag = "msg_timetag"; 
static const char* kNIMMsglogStatusChangedKeyStatus = "status";                                                                           // 消息状态变更通知结果 Json Keys
 
static const char* kNIMMsglogQueryKeyCount = "count";   
static const char* kNIMMsglogQueryKeySource = "source"; 
static const char* kNIMMsglogQueryKeyContent =
    "content";        // 查询消息历史结果Json Keys
 
enum NIMMsglogQuerySource {
    kNIMMsglogQuerySourceLocal = 0,  
    kNIMMsglogQuerySourceServer = 1, 
};
 
enum NIMMessageType {
    kNIMMessageTypeText = 0,         
    kNIMMessageTypeImage = 1,        
    kNIMMessageTypeAudio = 2,        
    kNIMMessageTypeVideo = 3,        
    kNIMMessageTypeLocation = 4,     
    kNIMMessageTypeNotification = 5, 
    kNIMMessageTypeFile = 6,         
    kNIMMessageTypeTips = 10,        
    kNIMMessageTypeRobot = 11,       
    kNIMMessageTypeG2NetCall = 12,   
    kNIMMessageTypeCustom = 100,     
    kNIMMessageTypeUnknown = 1000, 
};
 
enum NIMMessageFeature {
    kNIMMessageFeatureDefault = 0,       
    kNIMMessageFeatureLeaveMsg = 1,      
    kNIMMessageFeatureRoamMsg = 2,       
    kNIMMessageFeatureSyncMsg = 3,       
    kNIMMessageFeatureCustomizedMsg = 4, 
};
 
enum NIMMsgLogStatus {
    kNIMMsgLogStatusNone = 0,       
    kNIMMsgLogStatusUnread = 1,     
    kNIMMsgLogStatusRead = 2,       
    kNIMMsgLogStatusDeleted = 3,    
    kNIMMsgLogStatusSending = 4,    
    kNIMMsgLogStatusSendFailed = 5, 
    kNIMMsgLogStatusSent = 6,       
    kNIMMsgLogStatusReceipt = 7,    
    kNIMMsgLogStatusDraft = 8,      
    kNIMMsgLogStatusSendCancel = 9, 
    kNIMMsgLogStatusRefused = 10,   
};
 
enum NIMNotificationId {
    kNIMNotificationIdTeamInvite = 0, 
    kNIMNotificationIdTeamKick = 1,   
    kNIMNotificationIdTeamLeave = 2,  
    kNIMNotificationIdTeamUpdate = 3, 
    kNIMNotificationIdTeamDismiss = 4,       
    kNIMNotificationIdTeamApplyPass = 5,     
    kNIMNotificationIdTeamOwnerTransfer = 6, 
    kNIMNotificationIdTeamAddManager = 7,    
    kNIMNotificationIdTeamRemoveManager = 8, 
    kNIMNotificationIdTeamInviteAccept = 9,  
    kNIMNotificationIdTeamMuteMember =
        10, 
    kNIMNotificationIdNetcallMiss =
        101, 
    kNIMNotificationIdNetcallBill =
        102, 
    kNIMNotificationIdNetcallReject =
        103, 
    // 服务器在线同步协议返回的结果
    kNIMNotificationIdTeamSyncCreate =
        1000, 
    kNIMNotificationIdTeamMemberChanged = 1001, 
    kNIMNotificationIdTeamSyncUpdateMemberProperty =
        1002, 
    // 本地发起的操作通知APP上层
    kNIMNotificationIdLocalCreateTeam = 2000,           
    kNIMNotificationIdLocalApplyTeam = 2001,            
    kNIMNotificationIdLocalRejectApply = 2002,          
    kNIMNotificationIdLocalRejectInvite = 2003,         
    kNIMNotificationIdLocalUpdateMemberProperty = 2004, 
    kNIMNotificationIdLocalUpdateOtherNick = 2005,      
    kNIMNotificationIdLocalGetTeamInfo =
        2006, 
    kNIMNotificationIdLocalGetTeamList = 2007, 
    kNIMNotificationIdLocalMuteMember = 2008,  
    kNIMNotificationIdLocalMute = 2009,        
    kNIMNotificationIdLocalGetTeamMsgUnreadCount =
        2010, 
    kNIMNotificationIdLocalGetTeamMsgUnreadList = 2011, 
    // Netcall本地操作通知
    kNIMNotificationIdLocalNetcallReject =
        3103, 
    kNIMNotificationIdLocalNetcallNoResponse =
        3104, 
    kNIMNotificationIdLocalNetcallCanceled =
        3105, 
    kNIMNotificationIdSuperTeamInvite = 401,  
    kNIMNotificationIdSuperTeamKick = 402,    
    kNIMNotificationIdSuperTeamLeave = 403,   
    kNIMNotificationIdSuperTeamUpdate = 404,  
    kNIMNotificationIdSuperTeamDismiss = 405, 
    kNIMNotificationIdSuperTeamOwnerTransfer = 406, 
    kNIMNotificationIdSuperTeamAddManager = 407,    
    kNIMNotificationIdSuperTeamRemoveManager = 408, 
    kNIMNotificationIdSuperTeamMuteMember =
        409, 
    kNIMNotificationIdSuperTeamApplyPass = 410,   
    kNIMNotificationIdSuperTeamInviteAccept = 411 
};
 
enum NIMMsgLogSubStatus {
    kNIMMsgLogSubStatusNone = 0, 
    // 这二个标志适用于所有
    kNIMMsgLogSubStatusNotPlaying = 20, 
    kNIMMsgLogSubStatusPlayed = 21,     
};
 
enum LogsBackupRemoteOperate {
    LogsBackupRemoteOperate_Export = 0, 
    LogsBackupRemoteOperate_Import = 1  
};
enum LogsBackupRemoteState {
    LogsBackupRemoteState_Begin = -2,       
    LogsBackupRemoteState_UnDef,            
    LogsBackupRemoteState_UserCanceled = 5, 
    LogsBackupRemoteState_SDKError,         
    // 导入状态
    LogsBackupRemoteState_IMP_NoBackup,             
    LogsBackupRemoteState_IMP_SyncFromSrvError,     
    LogsBackupRemoteState_IMP_DownloadBackupFailed, 
    LogsBackupRemoteState_IMP_RAWError,             
    LogsBackupRemoteState_IMP_ParseRAWError,        
    LogsBackupRemoteState_IMP_LocalDBFailed,        
    // 导出状态
    LogsBackupRemoteState_EXP_LocalDBFailed,      
    LogsBackupRemoteState_EXP_RAWError,           
    LogsBackupRemoteState_EXP_UploadBackupFailed, 
    LogsBackupRemoteState_EXP_SyncToSrvError,     
    LogsBackupRemoteState_Done,                                                  
    LogsBackupRemoteState_Done_NoLogs,                                           
    LogsBackupRemoteState_End,                                                   
    LogsBackupRemoteState_FinalState_Begin = LogsBackupRemoteState_UserCanceled, 
};
 
enum NIMFullTextSearchRule { kNIMFullTextSearchOrderByAsc = 1, kNIMFullTextSearchOrderByDesc = 2, kNIMFullTextSearchNoGroupBySession = 4 };
 
typedef struct {
    char* (*ExportBackupToRemotePackageCallback)(const char* const file_path, void* user_data);
    char* (*ExportBackupToRemoteEncryptCallback)(const char* const file_path, const char* const encrypt_key, void* user_data);
    char* encrypt_key_; 
    void (*LogsBackupProgressCallback)(enum LogsBackupRemoteOperate op, float progress, void* user_data);
    void (*LogsBackupCompleteCallback)(enum LogsBackupRemoteOperate op, enum LogsBackupRemoteState state, void* user_data);
    bool (*ExportBackupToRemoteLogFiter)(const char* const msg, void* user_data);
    void (*NewPathRelease)(char** data_ptr);
    void* user_data_; 
} NIMLogsBackupExportInfo;
typedef struct {
    char* (*ImportBackupFromRemoteUnPackageCallback)(const char* const file_path, void* user_data);
    char* (*ImportBackupFromRemoteDecryptCallback)(const char* const file_path, const char* const encrypt_key, void* user_data);
    void (*LogsBackupProgressCallback)(enum LogsBackupRemoteOperate op, float progress, void* user_data);
    void (*LogsBackupCompleteCallback)(enum LogsBackupRemoteOperate op, enum LogsBackupRemoteState state, void* user_data);
    void (*NewPathRelease)(char**);
    void* user_data_; 
} NIMLogsBackupImportInfo;
 
static const char* kNIMMsglogQueryJsonExtensionKeyDirection = "direction";
static const char* kNIMMsglogQueryJsonExtensionKeyReverse = "reverse";
static const char* kNIMMsglogQueryJsonExtensionKeyEndTime = "endtime";  // 接口nim_msglog_query_msg_async扩展参数json key定义
 
static const char* kNIMMsglogJsonExtKeyNeedAutoDownloadAttachment = "need_auto_download_attachment";
static const char* kNIMMsglogJsonExtKeyQueryMsgTypeList = "query_msg_type_list";  // 接口nim_msglog_query_msg_online_async扩展参数json_extension key定义
 
static const char* kNIMMsglogJsonExtKeyComposeLastMsg = "compose_last_msg";
static const char* kNIMMsglogJsonExtKeyExcludeMsgType = "exclude_msg_type";  // 接口 nim_msglog_insert_msglog_async 扩展参数 json_extension key 定义
 
enum NIMMsglogSearchDirection {
    kForward = 0,  
    kBackward = 1, 
};
 
enum NIMMsgLogQueryRange {
    kNIMMsgLogQueryRangeP2P = kNIMSessionTypeP2P,   
    kNIMMsgLogQueryRangeTeam = kNIMSessionTypeTeam, 
    kNIMMsgLogQueryRangeSuperTeam = kNIMSessionTypeSuperTeam, 
    kNIMMsgLogQueryRangeAll = 100,                            
    kNIMMsgLogQueryRangeAllP2P = 101,                         
    kNIMMsgLogQueryRangeAllTeam = 102,                        
    kNIMMsgLogQueryRangeAllSuperTeam = 103,                   
    kNIMMsgLogQueryRangeUnknown = 200, 
};
 
typedef struct {
    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_;       
    bool auto_download_attachment_; 
    enum NIMMessageType* msg_type_list_; 
    int type_list_length_;               
    bool is_exclusion_type_; 
} NIMQueryMsgOnlineAsyncParam;
 
typedef struct {
    enum NIMSessionType to_type_; 
    int limit;                    
    int64_t from_time_;           
    int64_t end_time_;            
    bool reverse_; 
} NIMQueryMsgByKeywordOnlineAsyncParam;
 
static const char* kNIMNotificationKeyId = "id";
static const char* kNIMNotificationKeyData = "data";
static const char* kNIMNotificationKeyDataIds = "ids";
static const char* kNIMNotificationKeyDataInvalidIds = "invalid_ids";
static const char* kNIMNotificationKeyDataId = "id";
static const char* kNIMNotificationKeyDataLeave = "leave";
static const char* kNIMNotificationKeyDataMute = "mute";
static const char* kNIMNotificationKeyTeamInfo = "team_info";
static const char* kNIMNotificationKeyTeamMember = "team_member";
static const char* kNIMNotificationKeyUserNameCards = "name_cards";
static const char* kNIMNotificationKeyAttach = "attach";  // 群组通知 Json Keys
 
static const char* kNIMNotificationIdNetCallTypeKey = "calltype";
static const char* kNIMNotificationIdNetCallTimeKey = "time";
static const char* kNIMNotificationIdNetCallIdsKey = "ids";
static const char* kNIMNotificationIdNetCallChannelKey = "channel";
static const char* kNIMNotificationIdNetCallDurationKey = "duration";
static const char* kNIMNotificationIdNetCallFromKey = "from";
static const char* kNIMNotificationIdNetCallEXTKey = "ext";  // kNIMNotificationIdNetcallBill
          // kNIMNotificationIdNetcallMiss
          // kNIMNotificationIdNetcallReject
          // kNIMNotificationIdLocalNetcallReject
          // kNIMNotificationIdLocalNetcallNoResponse
          // Data Keys
 
static const char* kNIMDELMSGSelfNotifyKeySessionID = "session_id";
static const char* kNIMDELMSGSelfNotifyKeyMsgClientID = "client_id";
static const char* kNIMDELMSGSelfNotifyKeyEXT = "ext";  // 单向删除某条消息服务端推送 Json Keys
 
static const char* kNIMTEAMMSGACKREADSUCCESSIDSKEY = "success_ids";
static const char* kNIMTEAMMSGACKREADFAILUREIDSKEY = "failure_ids";
static const char* kNIMTEAMMSGACKREADSIGNOREDIDSKEY = "ignored_ids";  // 单向删除某条消息参数 Json Keys
 
typedef struct {
    enum NIMSessionType to_type_; 
    char from_account[128];       
    char to_account[128];         
    int64_t server_id;            
    char client_id[128];          
    int64_t time;                 
    char ext[1024];               
} NIMDeleteMessagesSelfParam;
 
typedef struct {
    enum NIMSessionType to_type_; 
    char from_account[128];       
    char to_account[128];         
    int64_t server_id;            
    char client_id[128];          
    int64_t time;                 
} NIMQueryMsgAsyncParam;
 
typedef struct {
    int64_t from_time;      
    int64_t to_time;        
    int64_t exclude_msg_id; 
    int32_t limit;          
    int32_t reverse;        
} NIMQueryThreadHistoryMsgAsyncParam;
 
#ifdef __cplusplus
};
#endif  //__cplusplus
#endif  // NIM_SDK_DLL_EXPORT_HEADERS_MSGLOG_DEF_H_