NIM PC Cross Platform SDK
载入中...
搜索中...
未找到
nim::LogsBackupExportInfo类 参考

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

#include <nim_msglog_helper.h>

类 nim::LogsBackupExportInfo 继承关系图:
NIMLogsBackupExportInfo

Public 成员函数

 LogsBackupExportInfo ()
 
void SetEncryptKey (const std::string &encrypt_key)
 
std::string GetEncryptKey () const
 
void SetUserData (void *user_data)
 
void * GetUserData () const
 
NIMLogsBackupExportInfoToCStruct () const
 

Public 属性

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_
 

Private 成员函数

NIMLogsBackupExportInfoToCStruct_i ()
 

静态 Private 成员函数

static LogsBackupExportInfoCastToCPP (void *data)
 

额外继承的成员函数

- Protected 属性 继承自 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只负责传回给回调函数,不做任何处理!
 

详细描述

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

构造及析构函数说明

◆ LogsBackupExportInfo()

nim::LogsBackupExportInfo::LogsBackupExportInfo ( )
inline

成员函数说明

◆ CastToCPP()

static LogsBackupExportInfo * nim::LogsBackupExportInfo::CastToCPP ( void *  data)
inlinestaticprivate

◆ GetEncryptKey()

std::string nim::LogsBackupExportInfo::GetEncryptKey ( ) const
inline

◆ GetUserData()

void * nim::LogsBackupExportInfo::GetUserData ( ) const
inline

◆ SetEncryptKey()

void nim::LogsBackupExportInfo::SetEncryptKey ( const std::string &  encrypt_key)
inline

◆ SetUserData()

void nim::LogsBackupExportInfo::SetUserData ( void *  user_data)
inline

◆ ToCStruct()

NIMLogsBackupExportInfo * nim::LogsBackupExportInfo::ToCStruct ( ) const
inline

◆ ToCStruct_i()

NIMLogsBackupExportInfo * nim::LogsBackupExportInfo::ToCStruct_i ( )
private

类成员变量说明

◆ cloned_

bool nim::LogsBackupExportInfo::cloned_

◆ encrypt_key_

std::string nim::LogsBackupExportInfo::encrypt_key_

◆ ExportBackupToRemoteEncryptCallback

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

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

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

◆ ExportBackupToRemoteLogFiter

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

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

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

◆ ExportBackupToRemotePackageCallback

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

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

参数
[in]file_path原始数据文件路径
[in]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
std::string 生成的打包(压缩)文件的路径

◆ LogsBackupCompleteCallback

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

导出完成后的结果回调

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

◆ LogsBackupProgressCallback

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

导出过程的进度回调

参数
[in]op操作类型 导入/导出
[in]progress进度 0-1
[in]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void

◆ src_user_data_

void* nim::LogsBackupExportInfo::src_user_data_

该类的文档由以下文件生成: