上传下载

接口声明

{"name": "system.request"}

导入模块

import request from '@system.request'const request = require('@system.request')

接口定义

request.upload(OBJECT)

上传文件

参数:

参数名 类型 必填 说明
url String 资源url
header Object 请求的header,会将其所有属性设置到请求的header部分。useragent设置无效。
method String 默认为POST,可以是: POST, PUT
files Array 需要上传的文件列表,使用multipart/form-data方式提交
data 正式版本可用 Array HTTP请求中其他额外的form data
success Function 成功返回的回调函数
fail Function 失败的回调函数
complete Function 结束的回调函数(调用成功、失败都会执行)
files参数 :

files参数是一个file对象的数组,file对象的结构如下:

参数名 类型 必填 说明
filename String multipart提交时,header中的文件名
name String multipart提交时,表单的项目名,默认file
uri String 文件的本地地址
type String 文件的Content-Type格式,默认会根据filename或者uri的后缀获取
data参数 正式版本可用
参数名 类型 必填 说明
name String form元素的名称。
value String form元素的值。
success返回值:
参数名 类型 说明
code Integer 服务器状态code
data String 如果服务器返回的header中type是text/*或application/json、application/javascript、application/xml,值是文本内容,否则是存储的临时文件的uri临时文件如果是图片或者视频内容,可以将图片设置到image或video控件上显示
headers Object 服务器response的所有header

示例:

request.upload({
  url: 'http://www.example.com',
  files: [
    {
      uri: 'internal://xxx/xxx/test',
      name: 'file1',
      filename: 'test.png'
    }
  ],
  data: [
    {
      name: 'param1',
      value: 'value1'
    }
  ],
  success: function (data) {
    console.log('handling success')
  },
  fail: function (data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

request.download(OBJECT)

下载文件

参数:

参数名 类型 必填 说明
url String 资源url
header String 请求的header,会将其所有属性设置到请求的header部分。useragent设置无效。
success Function 成功返回的回调函数
fail Function 失败的回调函数
complete Function 结束的回调函数(调用成功、失败都会执行)
success返回值:
参数名 类型 说明
token String 下载的token,根据此token获取下载状态

示例:

request.download({
  url: 'http://www.example.com',
  success: function (data) {
    console.log(`handling success${data.token}`)
  },
  fail: function (data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

request.onDownloadComplete(OBJECT)

监听下载任务

参数:

参数名 类型 必填 说明
token String download接口返回的token
success Function 成功返回的回调函数
fail Function 失败的回调函数
complete Function 结束的回调函数(调用成功、失败都会执行)
success返回值:
参数名 类型 说明
uri String 下载文件的Uri
fail返回错误代码:
错误码  说明
1000 下载失败
1001 下载任务不存在

示例:

request.onDownloadComplete({
  token: '123',
  success: function (data) {
    console.log(`handling success${data.uri}`)
  },
  fail: function (data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

条匹配 "" 的结果

    没有搜索到与 "" 相关的内容