NIM C# SDK  6.3.0
Namespaces | Classes | Enumerations | Functions
NIM.Messagelog Namespace Reference

Namespaces

namespace  Delegate
 

Classes

class  MessagelogAPI
 
class  MsglogNativeMethods
 
class  NIMLogsBackupExportInfo
 导出到云端备份参数类 More...
 
struct  NIMLogsBackupExportInfo_C
 
class  NIMLogsBackupImportInfo
 导入云端备份参数类 More...
 
struct  NIMLogsBackupImportInfo_C
 

Enumerations

enum  LogsBackupRemoteOperate { LogsBackupRemoteOperate.LogsBackupRemoteOperate_Export = 0, LogsBackupRemoteOperate.LogsBackupRemoteOperate_Import = 1 }
 导出/导入云端备份操作类型 More...
 
enum  LogsBackupRemoteState {
  LogsBackupRemoteState.LogsBackupRemoteState_Begin = -2, LogsBackupRemoteState.LogsBackupRemoteState_UnDef, LogsBackupRemoteState.LogsBackupRemoteState_UserCanceled = 5, LogsBackupRemoteState.LogsBackupRemoteState_SDKError,
  LogsBackupRemoteState.LogsBackupRemoteState_IMP_NoBackup, LogsBackupRemoteState.LogsBackupRemoteState_IMP_SyncFromSrvError, LogsBackupRemoteState.LogsBackupRemoteState_IMP_DownloadBackupFailed, LogsBackupRemoteState.LogsBackupRemoteState_IMP_RAWError,
  LogsBackupRemoteState.LogsBackupRemoteState_IMP_ParseRAWError, LogsBackupRemoteState.LogsBackupRemoteState_IMP_LocalDBFailed, LogsBackupRemoteState.LogsBackupRemoteState_EXP_LocalDBFailed, LogsBackupRemoteState.LogsBackupRemoteState_EXP_RAWError,
  LogsBackupRemoteState.LogsBackupRemoteState_EXP_UploadBackupFailed, LogsBackupRemoteState.LogsBackupRemoteState_EXP_SyncToSrvError, LogsBackupRemoteState.LogsBackupRemoteState_Done, LogsBackupRemoteState.LogsBackupRemoteState_Done_NoLogs,
  LogsBackupRemoteState.LogsBackupRemoteState_End, LogsBackupRemoteState.LogsBackupRemoteState_FinalState_Begin = LogsBackupRemoteState.LogsBackupRemoteState_UserCanceled
}
 导出/导入云端备份错误码说明 More...
 

Functions

delegate IntPtr _ExportBackupToRemotePackageCallback_C ([MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(NimUtility.Utf8StringMarshaler))] string file_path, IntPtr user_data)
 
delegate IntPtr _ExportBackupToRemoteEncryptCallback_C ([MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(NimUtility.Utf8StringMarshaler))] string file_path, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(NimUtility.Utf8StringMarshaler))] string encrypt_key, IntPtr user_data)
 
delegate void _LogsBackupProgressCallback (LogsBackupRemoteOperate param0, float param1, IntPtr user_data)
 
delegate void _LogsBackupCompleteCallback (LogsBackupRemoteOperate param0, LogsBackupRemoteState param1, IntPtr user_data)
 
delegate bool _ExportBackupToRemoteLogFiter ([MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(NimUtility.Utf8StringMarshaler))] string msg, IntPtr user_data)
 
delegate void _NewPathRelease (ref IntPtr param0)
 
delegate IntPtr _ImportBackupFromRemoteUnPackageCallback_C ([MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(NimUtility.Utf8StringMarshaler))]string file_path, IntPtr user_data)
 
delegate IntPtr _ImportBackupFromRemoteDecryptCallback_C ([MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(NimUtility.Utf8StringMarshaler))]string file_path, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(NimUtility.Utf8StringMarshaler))] string encrypt_key, IntPtr user_data)
 
delegate void DeleteOnlineHistoryResultDelegate (int res_code, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(NimUtility.Utf8StringMarshaler))] string account_id, IntPtr user_data)
 
delegate void QueryLogByMsgIdResultDelegate (ResponseCode code, string msdId, NIMIMMessage msg)
 
delegate void QueryMsglogResultDelegate (ResponseCode code, string accountId, NIMSessionType sType, MsglogQueryResult result)
 
delegate void OperateMsglogResultDelegate (ResponseCode code, string uid, NIMSessionType sType)
 
delegate void OperateSingleLogResultDelegate (ResponseCode code, string msgId)
 
delegate void CommonOperationResultDelegate (ResponseCode code)
 
delegate void ImportProgressDelegate (long importedCount, long totalCount)
 
delegate void MsglogStatusChangedDelegate (ResponseCode res, string result)
 
delegate void UpdateLocalExtDelegate (ResponseCode res, string msgId)
 
delegate void LogsBackupProgressDelegate (LogsBackupRemoteOperate oprate, float progress)
 导出/导入进度回调 More...
 
delegate void LogsBackupCompleteDelegate (LogsBackupRemoteOperate oprate, LogsBackupRemoteState state)
 导出/导入完成后的结果回调 More...
 
delegate string ImportBackupFromRemoteUnPackageDelegate (string file_path)
 自定义的解包方式回调，从云端步的备份文件经解密后会回调开发者自定义的解包（解压）方法 More...
 
delegate string ImportBackupFromRemoteDecryptDelegate (string file_path, string encrypt_key)
 自定义的解密方式回调，SDK从云端同步完备份文件后会调用开发者自定义的解密方法 More...
 
delegate string ExportBackupToRemotePackageDelegate (string file_path)
 自定义的打包方式回调，SDK生成原始数据文后会调用开发者自定义的打包（压缩）方法 More...
 
delegate string ExportBackupToRemoteEncryptDelegate (string file_path, string encrypt_key)
 自定义的加密方式回调，SDK生成原始数据经过打包（压缩）后会调用开发者自定义的加密方法 More...
 
delegate bool ExportBackupToRemoteLogFiterDelegate (string msg)
 开发者自定义的导出消息的过滤器 More...
 

Enumeration Type Documentation

◆ LogsBackupRemoteOperate

enum NIM.Messagelog.LogsBackupRemoteOperate
strong

导出/导入云端备份操作类型

Enumerator
LogsBackupRemoteOperate_Export 

导出

LogsBackupRemoteOperate_Import 

导入

◆ LogsBackupRemoteState

enum NIM.Messagelog.LogsBackupRemoteState
strong

导出/导入云端备份错误码说明

Enumerator
LogsBackupRemoteState_Begin 

定义开始

LogsBackupRemoteState_UnDef 

未定义

LogsBackupRemoteState_UserCanceled 

已取消

LogsBackupRemoteState_SDKError 

SDK 已出错

LogsBackupRemoteState_IMP_NoBackup 

没有备份文件

LogsBackupRemoteState_IMP_SyncFromSrvError 

查询备份失败一般是网络错误

LogsBackupRemoteState_IMP_DownloadBackupFailed 

下载备份文件出错

LogsBackupRemoteState_IMP_RAWError 

解密/解压出来的源文件格式错误

LogsBackupRemoteState_IMP_ParseRAWError 

解析源文件格式错误

LogsBackupRemoteState_IMP_LocalDBFailed 

导入本地DB出错

LogsBackupRemoteState_EXP_LocalDBFailed 

打开本地DB失败

LogsBackupRemoteState_EXP_RAWError 

导出到源文件失败

LogsBackupRemoteState_EXP_UploadBackupFailed 

上传备份文件出错

LogsBackupRemoteState_EXP_SyncToSrvError 

同步到服务器出错一般是网络错误

LogsBackupRemoteState_Done 

完成

LogsBackupRemoteState_Done_NoLogs 

完成，但未导出任何记录

LogsBackupRemoteState_End 

定义结束

LogsBackupRemoteState_FinalState_Begin 

是否已是最终状态的一个标识，可以判断state是否为终态(state >= LogsBackupRemoteState_FinalState_Begin)

Function Documentation

◆ _ExportBackupToRemoteEncryptCallback_C()

delegate IntPtr NIM.Messagelog._ExportBackupToRemoteEncryptCallback_C ( [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(NimUtility.Utf8StringMarshaler))] string  file_path,
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(NimUtility.Utf8StringMarshaler))] string  encrypt_key,
IntPtr  user_data 
)

◆ _ExportBackupToRemoteLogFiter()

delegate bool NIM.Messagelog._ExportBackupToRemoteLogFiter ( [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(NimUtility.Utf8StringMarshaler))] string  msg,
IntPtr  user_data 
)

◆ _ExportBackupToRemotePackageCallback_C()

delegate IntPtr NIM.Messagelog._ExportBackupToRemotePackageCallback_C ( [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(NimUtility.Utf8StringMarshaler))] string  file_path,
IntPtr  user_data 
)

◆ _ImportBackupFromRemoteDecryptCallback_C()

delegate IntPtr NIM.Messagelog._ImportBackupFromRemoteDecryptCallback_C ( [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(NimUtility.Utf8StringMarshaler))] string  file_path,
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(NimUtility.Utf8StringMarshaler))] string  encrypt_key,
IntPtr  user_data 
)

◆ _ImportBackupFromRemoteUnPackageCallback_C()

delegate IntPtr NIM.Messagelog._ImportBackupFromRemoteUnPackageCallback_C ( [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(NimUtility.Utf8StringMarshaler))] string  file_path,
IntPtr  user_data 
)

◆ _LogsBackupCompleteCallback()

delegate void NIM.Messagelog._LogsBackupCompleteCallback ( LogsBackupRemoteOperate  param0,
LogsBackupRemoteState  param1,
IntPtr  user_data 
)

◆ _LogsBackupProgressCallback()

delegate void NIM.Messagelog._LogsBackupProgressCallback ( LogsBackupRemoteOperate  param0,
float  param1,
IntPtr  user_data 
)

◆ _NewPathRelease()

delegate void NIM.Messagelog._NewPathRelease ( ref IntPtr  param0)

◆ CommonOperationResultDelegate()

delegate void NIM.Messagelog.CommonOperationResultDelegate ( ResponseCode  code)

◆ DeleteOnlineHistoryResultDelegate()

delegate void NIM.Messagelog.DeleteOnlineHistoryResultDelegate ( int  res_code,
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(NimUtility.Utf8StringMarshaler))] string  account_id,
IntPtr  user_data 
)

◆ ExportBackupToRemoteEncryptDelegate()

delegate string NIM.Messagelog.ExportBackupToRemoteEncryptDelegate ( string  file_path,
string  encrypt_key 
)

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

Parameters
file_path打包（压缩）后的文件路径
encrypt_key加密秘钥 与 encrypt_key_为同一个值
Returns
加密后的文件路径

◆ ExportBackupToRemoteLogFiterDelegate()

delegate bool NIM.Messagelog.ExportBackupToRemoteLogFiterDelegate ( string  msg)

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

Parameters
msg消息的详细数据 json格式
Returns
true:导出这条消息;false:不导出这条消息

◆ ExportBackupToRemotePackageDelegate()

delegate string NIM.Messagelog.ExportBackupToRemotePackageDelegate ( string  file_path)

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

Parameters
file_path原始数据文件路径
Returns
生成的打包（压缩）文件的路径

◆ ImportBackupFromRemoteDecryptDelegate()

delegate string NIM.Messagelog.ImportBackupFromRemoteDecryptDelegate ( string  file_path,
string  encrypt_key 
)

自定义的解密方式回调，SDK从云端同步完备份文件后会调用开发者自定义的解密方法

Parameters
file_path从云端同步到的文件路径
encrypt_key解密秘钥 与导出时加密密钥相同
Returns
解密后的文件路径

◆ ImportBackupFromRemoteUnPackageDelegate()

delegate string NIM.Messagelog.ImportBackupFromRemoteUnPackageDelegate ( string  file_path)

自定义的解包方式回调，从云端步的备份文件经解密后会回调开发者自定义的解包（解压）方法

Parameters
file_path经解密后文件路径
Returns
解压缩后的文件路径

◆ ImportProgressDelegate()

delegate void NIM.Messagelog.ImportProgressDelegate ( long  importedCount,
long  totalCount 
)

◆ LogsBackupCompleteDelegate()

delegate void NIM.Messagelog.LogsBackupCompleteDelegate ( LogsBackupRemoteOperate  oprate,
LogsBackupRemoteState  state 
)

导出/导入完成后的结果回调

Parameters
oprate导出/导入云端备份操作类型
state错误码

◆ LogsBackupProgressDelegate()

delegate void NIM.Messagelog.LogsBackupProgressDelegate ( LogsBackupRemoteOperate  oprate,
float  progress 
)

导出/导入进度回调

Parameters
oprate导出/导入云端备份操作类型
progress当前任务进度状态 [0-1]

◆ MsglogStatusChangedDelegate()

delegate void NIM.Messagelog.MsglogStatusChangedDelegate ( ResponseCode  res,
string  result 
)

◆ OperateMsglogResultDelegate()

delegate void NIM.Messagelog.OperateMsglogResultDelegate ( ResponseCode  code,
string  uid,
NIMSessionType  sType 
)

◆ OperateSingleLogResultDelegate()

delegate void NIM.Messagelog.OperateSingleLogResultDelegate ( ResponseCode  code,
string  msgId 
)

◆ QueryLogByMsgIdResultDelegate()

delegate void NIM.Messagelog.QueryLogByMsgIdResultDelegate ( ResponseCode  code,
string  msdId,
NIMIMMessage  msg 
)

◆ QueryMsglogResultDelegate()

delegate void NIM.Messagelog.QueryMsglogResultDelegate ( ResponseCode  code,
string  accountId,
NIMSessionType  sType,
MsglogQueryResult  result 
)

◆ UpdateLocalExtDelegate()

delegate void NIM.Messagelog.UpdateLocalExtDelegate ( ResponseCode  res,
string  msgId 
)