在调用接口页面的<script>部分增加如下配置。
import uploadtask from '@system.uploadtask'
或
var uploadtask = require("@system.uploadtask") 接口 | 描述 |
|---|---|
创建一个上传请求,每次调用成功将返回一个新的UploadTask对象。 | |
监听上传进度变化事件。 | |
取消监听上传进度变化事件。 | |
监听 HTTP Response Header 事件。 | |
取消监听 HTTP Response Header 事件。 | |
中断上传任务。 |
描述
创建一个upload请求,每次调用成功将返回一个新的UploadTask对象。
参数
参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
url | string | 是 | 资源url。 |
header | Object | 否 | 请求的header,会将其所有属性设置到请求的header部分。useragent设置无效。 |
method | string | 否 | 默认为POST,可以是: POST,PUT。 |
files | array | 是 | 需要上传的文件列表,使用multipart/form-data方式提交。 files是一个file对象的数组,file对象的结构请参见“files参数说明”。 |
data | array | 否 | HTTP请求中其他额外的form data,data的结构请参见“data说明”。 |
timeout | number | 否 | 超时时间,指连接超时时间,非读写超时时间。单位ms,默认值为10000。 |
success | function | 否 | 成功的回调函数。 |
fail | function | 否 | 失败的回调函数。 |
complete | function | 否 | 结束的回调函数(调用成功、失败都会执行)。 |
files参数说明
参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
filename | string | 否 | multipart提交时,header中的文件名。如果文件名未填,默认从uri中获取文件名上传。 |
name | string | 否 | multipart提交时,表单的项目名,默认值为file。 |
uri | string | 是 | 文件的本地地址。 |
type | string | 否 | 文件的Content-Type格式,不填则根据filename或uri的后缀从系统的映射表中查询对应的content-type,如果获取失败则报参数非法异常。 |
data说明
success返回值
参数 | 类型 | 说明 |
|---|---|---|
statusCode | number | 服务器状态code。 |
data | string | 如果服务器返回的header中type是text/*或application/json、application/javascript、application/xml,值是文本内容,否则是存储的临时文件的uri。如果是图片或者视频内容,可以将图片设置到image或video控件上显示。 |
headers | object | 服务器response的所有header。 |
fail返回值
参数 | 类型 | 说明 |
|---|---|---|
msg | object | 携带错误信息,错误信息获取方式为msg.errMsg。 |
code | number | 返回的错误码。 |
示例代码
uploadWithTask() {
const that = this
this.upload_task = uploadtask.uploadFile({
url: "https://uploadtest.com", /*非真实网址*/
header: { "Accept-Encoding": "gzip, deflate", "Accept-Language": "zh-CN,en-US;q=0.8,en;q=0.6" },
files: [
{
uri: "internal://mass/videoupload.mp4",
name: "file1",
type: "video"
}
], data: [
{
name: "key1",
value: "value1"
}
],
success: function (data) {
console.log("handling success:" + JSON.stringify(data));
},
fail: function (data, code) {
console.log("handling fail, data =" + data.statusText);
}
})
},
abort() {
this.upload_task.abort()
}, 描述
监听上传进度变化事件。
参数
上传进度变化事件的回调函数。
callback返回参数
Object类型。
属性 | 类型 | 说明 |
|---|---|---|
progress | number | 上传进度百分比。 |
totalBytesSent | number | 已经上传的数据长度,单位 Bytes。 |
totalBytesExpectedToSend | number | 预期需要上传的数据总长度,单位 Bytes。 |
示例代码
this.upload_task.onProgressUpdate(res => {
console.log("Upload onProgressUpdate = " + JSON.stringify(res))
that.progress = JSON.stringify(res)
}) 描述
取消监听上传进度变化事件。
参数
上传进度变化事件的回调函数。
示例代码
this.upload_task.offProgressUpdate()
描述
监听 HTTP Response Header 事件。在文件上传成功回调之前触发。
参数
HTTP Response Header 事件的回调函数。
callback返回参数
Object类型。
属性 | 类型 | 说明 |
|---|---|---|
header | object | 开发者服务器返回的 HTTP Response Header。 |
示例代码
this.upload_task.onHeadersReceived(res => {
console.log("Upload onHeaderReceived = " + JSON.stringify(res))
that.header = JSON.stringify(res)
}) 描述
取消监听 HTTP Response Header 事件。
参数
HTTP Response Header 事件的回调函数。
示例代码
this.upload_task.offHeadersReceived()
对于HTTPS请求,对证书要求如下:
从安全性考虑,建议也支持TLS1.3。1200及以上版本在配置加密套件时排除不安全算法:TEA/DES/DESX/DES40/RC2/RC4/RIPEMD/NULL/SHA0/MD2/MD4/MD5/ANON/TLS_EMPTY_RENEGOTIATION_INFO_SCSV;1200以下版本在配置加密套件时排除不安全算法:TEA/DES/DESX/DES40/RC2/RC4/RIPEMD/eNULL/aNULL/NULL/SHA0/MD2/MD4/MD5/ANON/TLS_EMPTY_RENEGOTIATION_INFO_SCSV。部分CA可能不被操作系统信任,请开发者在选择证书时注意操作系统的相关通告。