NIM SDK API  9.0.0
nim_nos_def.h
Go to the documentation of this file.
1 
8 #ifndef NIM_SDK_DLL_EXPORT_HEADERS_NOS_DEF_H_
9 #define NIM_SDK_DLL_EXPORT_HEADERS_NOS_DEF_H_
10 
11 #include "public_defines.h"
12 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
21 };
35  const char* json_result,
36  const char* json_extension,
37  const void* user_data);
38 
54 typedef void (*nim_nos_download_cb_func)(int rescode,
55  const char* file_path,
56  const char* call_id,
57  const char* res_id,
58  const char* json_extension,
59  const void* user_data);
60 
69 typedef void (*nim_nos_download_prg_cb_func)(int64_t downloaded_size, int64_t file_size, const char* json_extension, const void* user_data);
70 
78 typedef void (*nim_nos_download_speed_cb_func)(int64_t download_speed, const char* json_extension, const void* user_data);
79 
91 typedef void (*nim_nos_download_info_cb_func)(int64_t actual_download_size,
92  int64_t download_speed,
93  const char* json_extension,
94  const void* user_data);
95 
104 typedef void (*nim_nos_upload_cb_func)(int rescode, const char* url, const char* json_extension, const void* user_data);
105 
114 typedef void (*nim_nos_upload_prg_cb_func)(int64_t uploaded_size, int64_t file_size, const char* json_extension, const void* user_data);
115 
123 typedef void (*nim_nos_upload_speed_cb_func)(int64_t upload_speed, const char* json_extension, const void* user_data);
124 
133 typedef void (*nim_nos_upload_info_cb_func)(int64_t actual_upload_size, int64_t upload_speed, const char* json_extension, const void* user_data);
134 
142 typedef void (*nim_nos_safeurl_to_originurl_cb_func)(int rescode, const char* origin_url, const void* user_data);
143 
151 typedef void (*nim_nos_custom_token_cb_func)(const char* url, char* token, const int length);
152 
157 };
158 
160 static const char* kNIMNosLowLimit = "low_limit";
163 static const char* kNIMNosLowTime = "low_time";
165 static const char* kNIMNosTimeout = "timeout";
167 static const char* kNIMNosTaskId = "task_id";
169 static const char* kNIMNosNeedContinueTrans = "continue_trans";
171 static const char* kNIMNosFileSize = "download_filesize";
173 static const char* kNIMNosSaveAsFilePath = "saveas_filepath";
175 static const char* kNIMNosUploadType = "upload_type";
177 static const char* kNIMNosDocTransName = "name";
179 static const char* kNIMNosDocTransSourceType = "source_type";
181 static const char* kNIMNosDocTransPicType = "pic_type";
183 static const char* kNIMNosDocTransExt = "doc_trans_ext";
185 static const char* kNIMNosUploadTag = "upload_tag"; // NOS扩展上传\下载接口参数json_extension Json key for nim_nos_upload_ex && nim_nos_download_ex
187 
189 static const char* kNIMNosResId = "res_id";
192 static const char* kNIMNosCallId = "call_id"; // NOS扩展上传回调参数json_extension, Json key for upload cb
194 
196 static const char* kNIMNosDefaultTagResource = "nim_default_profile_icon";
199 static const char* kNIMNosDefaultTagIM = "nim_default_im"; // NOS 上传文件到Nos缺省tag定义
201 
203 static const char* kNIMNosUploadTagName = "nim_nos_tag_name";
206 static const char* kNIMNosUploadTagSurvivalTime = "nim_nos_tag_survival_time";
208 static const char* kNIMNosInitConfigSucceed = "nim_nos_init_config_succeed";
210 static const char* kNIMNosInitConfigFailure = "nim_nos_init_config_failure";
212 static const char* kNIMNosInitConfigIgnore = "nim_nos_init_config_ignore";
214 static const char* kNIMNosInitConfigErrcode = "nim_nos_init_config_errcode";
216 static const char* kNIMNosInitConfigRetcode = "nim_nos_init_config_retcode"; // NOS 初始化参数定义
218 
219 #ifdef __cplusplus
220 };
221 #endif //__cplusplus
222 #endif // NIM_SDK_DLL_EXPORT_HEADERS_NOS_DEF_H_
kNIMNosCallId
static const char * kNIMNosCallId
string 上传文件的会话id
Definition: nim_nos_def.h:192
NIMNosUploadType
NIMNosUploadType
Definition: nim_nos_def.h:154
nim_nos_custom_token_cb_func
void(* nim_nos_custom_token_cb_func)(const char *url, char *token, const int length)
Definition: nim_nos_def.h:151
nim_nos_download_speed_cb_func
void(* nim_nos_download_speed_cb_func)(int64_t download_speed, const char *json_extension, const void *user_data)
Definition: nim_nos_def.h:78
kNIMNosInitConfResTypeFailure
@ kNIMNosInitConfResTypeFailure
Definition: nim_nos_def.h:20
kNIMNosFileSize
static const char * kNIMNosFileSize
int64 HTTP下载任务的文件大小,需要续传功能必填,单位Byte,其他情况不需要填
Definition: nim_nos_def.h:171
nim_nos_upload_cb_func
void(* nim_nos_upload_cb_func)(int rescode, const char *url, const char *json_extension, const void *user_data)
Definition: nim_nos_def.h:104
kNIMNosInitConfResTypePartSuccessful
@ kNIMNosInitConfResTypePartSuccessful
Definition: nim_nos_def.h:19
kNIMNosUploadTypeNormal
@ kNIMNosUploadTypeNormal
Definition: nim_nos_def.h:155
kNIMNosUploadTypeDocTrans
@ kNIMNosUploadTypeDocTrans
Definition: nim_nos_def.h:156
kNIMNosUploadTagSurvivalTime
static const char * kNIMNosUploadTagSurvivalTime
int32_t 资源所对应的tag生命周期 s
Definition: nim_nos_def.h:206
kNIMNosUploadType
static const char * kNIMNosUploadType
NIMNosUploadType HTTP上传任务的类型
Definition: nim_nos_def.h:175
nim_nos_upload_prg_cb_func
void(* nim_nos_upload_prg_cb_func)(int64_t uploaded_size, int64_t file_size, const char *json_extension, const void *user_data)
Definition: nim_nos_def.h:114
nim_nos_safeurl_to_originurl_cb_func
void(* nim_nos_safeurl_to_originurl_cb_func)(int rescode, const char *origin_url, const void *user_data)
Definition: nim_nos_def.h:142
nim_nos_download_cb_func
void(* nim_nos_download_cb_func)(int rescode, const char *file_path, const char *call_id, const char *res_id, const char *json_extension, const void *user_data)
Definition: nim_nos_def.h:54
kNIMNosInitConfigFailure
static const char * kNIMNosInitConfigFailure
object array 初始化失败了的tag
Definition: nim_nos_def.h:210
kNIMNosDocTransSourceType
static const char * kNIMNosDocTransSourceType
NIMDocTranscodingFileType (HTTP上传转码文档使用)转码源文档的文件类型, nim_doc_trans_def.h.
Definition: nim_nos_def.h:179
nim_nos_download_info_cb_func
void(* nim_nos_download_info_cb_func)(int64_t actual_download_size, int64_t download_speed, const char *json_extension, const void *user_data)
Definition: nim_nos_def.h:91
kNIMNosUploadTagName
static const char * kNIMNosUploadTagName
string tag的名称
Definition: nim_nos_def.h:204
kNIMNosResId
static const char * kNIMNosResId
string 上传文件的id,如果是文档转换则为服务器的文档id
Definition: nim_nos_def.h:190
kNIMNosLowLimit
static const char * kNIMNosLowLimit
int HTTP通用配置,传输速度,每秒字节数(默认10)
Definition: nim_nos_def.h:161
NIMNosInitConfigResultType
NIMNosInitConfigResultType
Definition: nim_nos_def.h:16
public_defines.h
NIM SDK 及 NIM ChatRoom SDK 公用头文件
kNIMNosInitConfigErrcode
static const char * kNIMNosInitConfigErrcode
int 初始化tag失败时的错误码
Definition: nim_nos_def.h:214
kNIMNosDefaultTagResource
static const char * kNIMNosDefaultTagResource
string 资源类文件上传tag 如头像、群头像等, 可以通过 nim_nos_init_tags修改资源的过期时间
Definition: nim_nos_def.h:197
kNIMNosTaskId
static const char * kNIMNosTaskId
HTTP通用配置,任务ID,上传下载断点续传必填,如果传入的ID是曾经未完成的需要续传功能的传输任务的ID,则会开始续传(用户需要保证ID的唯一性)
Definition: nim_nos_def.h:167
nim_nos_upload_speed_cb_func
void(* nim_nos_upload_speed_cb_func)(int64_t upload_speed, const char *json_extension, const void *user_data)
Definition: nim_nos_def.h:123
kNIMNosInitConfigSucceed
static const char * kNIMNosInitConfigSucceed
string array 初始化成功了的tag
Definition: nim_nos_def.h:208
nim_nos_upload_info_cb_func
void(* nim_nos_upload_info_cb_func)(int64_t actual_upload_size, int64_t upload_speed, const char *json_extension, const void *user_data)
Definition: nim_nos_def.h:133
kNIMNosInitConfigRetcode
static const char * kNIMNosInitConfigRetcode
NIMNosInitConfigResultType nos config初始化结果
Definition: nim_nos_def.h:216
kNIMNosSaveAsFilePath
static const char * kNIMNosSaveAsFilePath
string HTTP下载任务的文件存放本地路径,不填则默认路径回调中返回
Definition: nim_nos_def.h:173
kNIMNosInitConfResTypeTagCountOF
@ kNIMNosInitConfResTypeTagCountOF
Definition: nim_nos_def.h:17
kNIMNosInitConfResTypeSuccess
@ kNIMNosInitConfResTypeSuccess
Definition: nim_nos_def.h:18
kNIMNosInitConfigIgnore
static const char * kNIMNosInitConfigIgnore
string array 因为指定的survival_time 相同而被忽略了的tag
Definition: nim_nos_def.h:212
kNIMNosDocTransName
static const char * kNIMNosDocTransName
string (HTTP上传转码文档使用)名称
Definition: nim_nos_def.h:177
kNIMNosNeedContinueTrans
static const char * kNIMNosNeedContinueTrans
bool HTTP通用配置,任务是否需要续传功能
Definition: nim_nos_def.h:169
nim_nos_init_config_cb_func
void(* nim_nos_init_config_cb_func)(enum NIMNosInitConfigResultType rescode, const char *json_result, const char *json_extension, const void *user_data)
Definition: nim_nos_def.h:34
kNIMNosUploadTag
static const char * kNIMNosUploadTag
string, 上传文件时使用的场景标签(可参见nos删除策略)
Definition: nim_nos_def.h:185
kNIMNosLowTime
static const char * kNIMNosLowTime
int HTTP通用配置,传输过程中当low_time秒时间内传输速度小于low_limit时(字节每秒),下载任务会返回超时而取消(默认60)
Definition: nim_nos_def.h:163
kNIMNosDocTransExt
static const char * kNIMNosDocTransExt
string (HTTP上传转码文档使用)文档转换时的扩展参数,在成功后能查询到
Definition: nim_nos_def.h:183
kNIMNosDefaultTagIM
static const char * kNIMNosDefaultTagIM
string im消息类文件上传tag 如图片、文件、音视频消息等, 可以通过 nim_nos_init_tags修改资源的过期时间
Definition: nim_nos_def.h:199
kNIMNosTimeout
static const char * kNIMNosTimeout
int HTTP通用配置,超时时间,单位ms,下载时最小10000,上传时最小30000,不设置默认30000
Definition: nim_nos_def.h:165
nim_nos_download_prg_cb_func
void(* nim_nos_download_prg_cb_func)(int64_t downloaded_size, int64_t file_size, const char *json_extension, const void *user_data)
Definition: nim_nos_def.h:69
kNIMNosDocTransPicType
static const char * kNIMNosDocTransPicType
NIMDocTranscodingImageType (HTTP上传转码文档使用)转码目标图片的文件类型, nim_doc_trans_def.h.
Definition: nim_nos_def.h:181