html5plus Uploader模块管理网络上传
摘要:Uploader模块管理网络上传,用于从本地上传各种文件到网络,支持跨域访问操作。通过plus.uploader可获取上传管理对象。
uploader
Uploader模块管理网络上传,用于从本地上传各种文件到网络,支持跨域访问操作。通过plus.uploader可获取上传管理对象。
方法:
- createUpload: 新建上传任务
- enumerate: 枚举应用的所有上传任务
- clear: 清除上传任务
- startAll: 开始所有上传任务
对象:
- Upload: Upload对象用于管理单个上传任务
- UploadState: 上传任务的状态,Number类型
- UploadOption: JSON对象,创建上传任务的参数
- UploadFileOption: JSON对象,创建上传文件选项的参数
回调方法:
- UploadCompletedCallback: 上传任务完成时的回调函数
- UploadStateChangedCallback: 上传任务状态变化回调函数,在上传任务状态发生变化时调用
- UploadEnumerateCallback: 枚举上传任务回调函数,在枚举上传任务完成时时调用
权限:
permissions
"Uploader": { "description": "管理上传任务" }
Upload
Upload对象用于管理单个上传任务
属性:
- url: 上传文件的服务器地址
- state: 任务的状态
- options: 上传任务的参数
- responseText: 上传任务完成后服务器返回的数据
- uploadedSize: 已完成上传文件的大小,单位为字节(byte)
- totalSize: 上传任务文件的总大小,单位为字节(byte)
方法:
- addFile: 添加上传文件
- addData: 添加上传数据
- start: 开始上传任务
- pause: 停止上传任务
- resume: 恢复上传任务
- abort: 取消上传任务
- addEventListener: 添加上传任务事件监听器
UploadState
上传任务的状态,Number类型
属性:
- 0: 初始状态,在创建之后触发此状态事件,上传任务处于可调度状态
- 1: 上传任务开始处理,开始建立网络连接
- 2: 上传任务请求已经接收,网络连接已建立
- 3: 上传任务请求处理中,上传过程中不断触发
- 4: 上传任务已完成(成功或失败)
- 5: 上传任务暂停状态,可重新开始
- -1: 非任务状态,用于enumerate()和clear()操作所有上传任务
UploadOption
JSON对象,创建上传任务的参数
属性:
- method: 网络请求类型,必须是http协议的“POST”
- blocksize: 上传任务每次上传的文件块大小(仅在支持断点续传的服务有效),单位为字节,默认值为102400,若设置值小于等于0则表示不分块上传
- priority: 上传任务的优先级,数值越大优先级越高
- timeout: 上传任务超时时间,单位为s,默认为120s
- retry: 上传任务重试次数,默认为3次
UploadFileOption
JSON对象,创建上传文件选项的参数
属性:
UploadCompletedCallback
上传任务完成时的回调函数
void uploadCompleted( Upload upload, Number status ) { // File upload completed code. }
说明:
在上传任务完成时调用,上传任务失败也将触发此回调。
参数:
-
upload: ( Upload ) 必选 上传任务对象
-
status: ( Number ) 必选 Http传输协议状态码
如果未获取传输状态则其值则为0,如上传成功其值通常为200。
返回值:
void : 无UploadStateChangedCallback
上传任务状态变化回调函数,在上传任务状态发生变化时调用
void onStateChanged( Upload upload, status ) { // Upload state changed code. }
参数:
-
upload: ( Upload ) 必选 上传任务对象
-
status: ( Number ) 必选 Http传输协议状态码
如果未获取传输状态则其值则为0,如上传成功其值通常为200。
返回值:
void : 无UploadEnumerateCallback
枚举上传任务回调函数,在枚举上传任务完成时时调用
void onEnumerated( Upload[] uploads ) { // Upload enumerate completed code. }
参数:
-
uploads: ( Upload ) 必选 枚举到的上传任务对象数组
返回值:
void : 无相关文章
最新发布
阅读排行
热门文章
猜你喜欢