NIM PC Cross Platform SDK
Public Member Functions | Public Attributes | List of all members
nim::LogsBackupExportInfo Class Reference

导出消息记录到云端参数定义 More...

#include <nim_msglog_helper.h>

Inheritance diagram for nim::LogsBackupExportInfo:
NIMLogsBackupExportInfo

Public Member Functions

void SetEncryptKey (const std::string &encrypt_key)
 
std::string GetEncryptKey () const
 
void SetUserData (void *user_data)
 
void * GetUserData () const
 
NIMLogsBackupExportInfo * ToCStruct () const
 

Public Attributes

std::function< std::string(const std::string &file_path, void *user_data)> ExportBackupToRemotePackageCallback
 
std::function< std::string(const std::string &file_path, const std::string &encrypt_key, void *user_data)> ExportBackupToRemoteEncryptCallback
 
std::function< bool(const IMMessage &msg, void *user_data)> ExportBackupToRemoteLogFiter
 
std::function< void(LogsBackupRemoteOperate op, float progress, void *user_data)> LogsBackupProgressCallback
 
std::function< void(LogsBackupRemoteOperate op, LogsBackupRemoteState state, void *user_data)> LogsBackupCompleteCallback
 
std::string encrypt_key_
 
void * src_user_data_
 
bool cloned_
 

Additional Inherited Members

- Protected Attributes inherited from NIMLogsBackupExportInfo
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_
 APP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！
 

Detailed Description

导出消息记录到云端参数定义

Member Data Documentation

◆ ExportBackupToRemoteEncryptCallback

std::function<std::string(const std::string& file_path, const std::string& encrypt_key, void* user_data)> nim::LogsBackupExportInfo::ExportBackupToRemoteEncryptCallback

自定义的加密方式回调，SDK生成原始数据经过打包（压缩）后会调用开发者自定义的加密方法

Parameters
[in]file_path打包（压缩）后的文件路径
[in]encrypt_key加密秘钥 与 encrypt_key_为同一个值
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！
Returns
std::string 加密后的文件路径

◆ ExportBackupToRemoteLogFiter

std::function<bool(const IMMessage& msg, void* user_data)> nim::LogsBackupExportInfo::ExportBackupToRemoteLogFiter

开发者自定义的导出消息的过滤器

Parameters
[in]msg消息
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！
Returns
bool true:导出这条消息;false:不导出这条消息

◆ ExportBackupToRemotePackageCallback

std::function<std::string(const std::string& file_path, void* user_data)> nim::LogsBackupExportInfo::ExportBackupToRemotePackageCallback

自定义的打包方式回调，SDK生成原始数据文后会调用开发者自定义的打包（压缩）方法

Parameters
[in]file_path原始数据文件路径
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！
Returns
std::string 生成的打包（压缩）文件的路径

◆ LogsBackupCompleteCallback

std::function<void(LogsBackupRemoteOperate op, LogsBackupRemoteState state, void* user_data)> nim::LogsBackupExportInfo::LogsBackupCompleteCallback

导出完成后的结果回调

Parameters
[in]op操作类型 导入/导出
[in]state完成状态参考 LogsBackupRemoteState
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！
Returns
void

◆ LogsBackupProgressCallback

std::function<void(LogsBackupRemoteOperate op, float progress, void* user_data)> nim::LogsBackupExportInfo::LogsBackupProgressCallback

导出过程的进度回调

Parameters
[in]op操作类型 导入/导出
[in]progress进度 0-1
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！
Returns
void
The documentation for this class was generated from the following files: