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

Classes

class  DocTransitionParams
 HTTP上传转码文档参数 More...
 
class  HttpExtendedParameters
 NOS扩展上传\下载接口参数 More...
 
class  InitConfigParams
 
class  InitConfigResultParams
 
class  NIMNosInitResult
 
class  NIMNosTagInfo
 
class  NosAPI
 
class  NosNativeMethods
 
class  ProgressData
 上传/下载进度回调数据 More...
 
class  ProgressPair
 
class  UploadResultParam
 

Enumerations

enum  NIMNosUploadType { NIMNosUploadType.kNIMNosUploadTypeNormal = 0, NIMNosUploadType.kNIMNosUploadTypeDocTrans = 1 }
 
enum  NIMNosInitConfigResultType { NIMNosInitConfigResultType.kNIMNosInitConfResTypeTagCountOF = 0, NIMNosInitConfigResultType.kNIMNosInitConfResTypeSuccess, NIMNosInitConfigResultType.kNIMNosInitConfResTypePartSuccessful, NIMNosInitConfigResultType.kNIMNosInitConfResTypeFailure }
 

Functions

delegate void InitConfigHandler (NIMNosInitConfigResultType type, InitConfigResultParams json_result, string json_extension)
 
delegate void DownloadResultHandler (int rescode, string filePath, string callId, string resId)
 下载结果回调 More...
 
delegate void UploadResultHandler (int rescode, string url)
 上传结果回调 More...
 
delegate void UploadResultHandler2 (int rescode, string url, UploadResultParam param)
 
delegate void ProgressResultHandler (ProgressData prgData)
 传输进度回调 More...
 
delegate void DownloadCb (int rescode, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string file_path, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string call_id, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string res_id, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string json_extension, IntPtr user_data)
 下载结果回调 More...
 
delegate void DownloadPrgCb (long downloaded_size, long file_size, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string json_extension, IntPtr user_data)
 下载进度回调 More...
 
delegate void UploadCb (int rescode, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string url, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string json_extension, IntPtr user_data)
 上传结果回调 More...
 
delegate void UploadPrgCb (long uploaded_size, long file_size, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string json_extension, IntPtr user_data)
 上传进度回调 More...
 
delegate void DownloadSpeedCb (long download_speed, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))]string json_extension, IntPtr user_data)
 
delegate void DownloadInfoCb (long actual_download_size, long download_speed, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string json_extension, IntPtr user_data)
 
delegate void UploadSpeedCb (long upload_speed, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string json_extension, IntPtr user_data)
 
delegate void UploadInfoCb (long actual_upload_size, long upload_speed, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))]string json_extension, IntPtr user_data)
 
delegate void InitConfigCb (NIMNosInitConfigResultType type, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))]string json_result, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))]string json_extension, IntPtr user_data)
 
delegate void SafeUrlConverterCb (int rescode, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))]string originUrl, IntPtr userData)
 nim callback function for safe url to origin url More...
 

Enumeration Type Documentation

◆ NIMNosInitConfigResultType

enum NIM.Nos.NIMNosInitConfigResultType
strong
Enumerator
kNIMNosInitConfResTypeTagCountOF 

自定义tag数量超过最大数量

kNIMNosInitConfResTypeSuccess 

所有tag初始成功

kNIMNosInitConfResTypePartSuccessful 

部分tag初始化成功，失败的tag及错误码可以解析json_result来取得

kNIMNosInitConfResTypeFailure 

所有tag初始化失败

◆ NIMNosUploadType

enum NIM.Nos.NIMNosUploadType
strong
Enumerator
kNIMNosUploadTypeNormal 

普通文件上传

kNIMNosUploadTypeDocTrans 

文档转换上传

Function Documentation

◆ DownloadCb()

delegate void NIM.Nos.DownloadCb ( int  rescode,
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string  file_path,
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string  call_id,
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string  res_id,
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string  json_extension,
IntPtr  user_data 
)

下载结果回调

Parameters
rescode下载结果，一切正常200
file_path下载资源文件本地绝对路径
call_id如果下载的是消息中的资源，则为消息所属的会话id，否则为空
res_id如果下载的是消息中的资源，则为消息id，否则为空
json_extensionjson扩展数据（备用）
user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！

◆ DownloadInfoCb()

delegate void NIM.Nos.DownloadInfoCb ( long  actual_download_size,
long  download_speed,
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string  json_extension,
IntPtr  user_data 
)

◆ DownloadPrgCb()

delegate void NIM.Nos.DownloadPrgCb ( long  downloaded_size,
long  file_size,
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string  json_extension,
IntPtr  user_data 
)

下载进度回调

Parameters
downloaded_size已下载数据大小
file_size文件大小
json_extensionjson扩展数据（备用）
user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！

◆ DownloadResultHandler()

delegate void NIM.Nos.DownloadResultHandler ( int  rescode,
string  filePath,
string  callId,
string  resId 
)

下载结果回调

Parameters
rescode下载结果，一切正常200
filePath下载资源文件本地绝对路径
callId如果下载的是消息中的资源，则为消息所属的会话id，否则为空
resId如果下载的是消息中的资源，则为消息id，否则为空

◆ DownloadSpeedCb()

delegate void NIM.Nos.DownloadSpeedCb ( long  download_speed,
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string  json_extension,
IntPtr  user_data 
)

◆ InitConfigCb()

delegate void NIM.Nos.InitConfigCb ( NIMNosInitConfigResultType  type,
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string  json_result,
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string  json_extension,
IntPtr  user_data 
)

◆ InitConfigHandler()

delegate void NIM.Nos.InitConfigHandler ( NIMNosInitConfigResultType  type,
InitConfigResultParams  json_result,
string  json_extension 
)

◆ ProgressResultHandler()

delegate void NIM.Nos.ProgressResultHandler ( ProgressData  prgData)

传输进度回调

Parameters
ProgressData回调数据

◆ SafeUrlConverterCb()

delegate void NIM.Nos.SafeUrlConverterCb ( int  rescode,
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string  originUrl,
IntPtr  userData 
)

nim callback function for safe url to origin url

Parameters
rescode返回的错误码，200成功，404，传入的安全链接(短链)不存在，或不是有效的安全链接(短链)
originUrl源链(长链)
userData

◆ UploadCb()

delegate void NIM.Nos.UploadCb ( int  rescode,
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string  url,
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string  json_extension,
IntPtr  user_data 
)

上传结果回调

Parameters
rescode上传结果，一切正常200
urlurl地址
json_extensionjson扩展数据（备用）
user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！

◆ UploadInfoCb()

delegate void NIM.Nos.UploadInfoCb ( long  actual_upload_size,
long  upload_speed,
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string  json_extension,
IntPtr  user_data 
)

◆ UploadPrgCb()

delegate void NIM.Nos.UploadPrgCb ( long  uploaded_size,
long  file_size,
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string  json_extension,
IntPtr  user_data 
)

上传进度回调

Parameters
uploaded_size已上传数据大小
file_size文件大小
json_extensionjson扩展数据（备用）
user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！

◆ UploadResultHandler()

delegate void NIM.Nos.UploadResultHandler ( int  rescode,
string  url 
)

上传结果回调

Parameters
rescode上传结果，一切正常200
urlurl地址

◆ UploadResultHandler2()

delegate void NIM.Nos.UploadResultHandler2 ( int  rescode,
string  url,
UploadResultParam  param 
)

◆ UploadSpeedCb()

delegate void NIM.Nos.UploadSpeedCb ( long  upload_speed,
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef=typeof(Utf8StringMarshaler))] string  json_extension,
IntPtr  user_data 
)