downloadFile 1.0.0+

下载网络文件到本地临时目录。

提示

网络相关的 API 在使用前需要配置域名白名单。请参考网络请求使用说明

提示

HTTP 请求 method 为GET

输入

继承标准对象输入，扩展属性描述：

名称数据类型属性默认值描述
urlstringrequiredN/A文件地址
headerobjectoptional``请求Header

输出

success返回对象参数的扩展属性：

名称数据类型描述
tempFilePathstring文件本地路径
statusCodenumber返回 HTTP 状态码

本 API 的调用结果在通过回调传递的同时会返回一个downloadTask对象，可以通过该对象的abort方法中断请求任务；通过onProgressUpdate方法监听下载进度。

onProgressUpdate注册的监听方法会收到一个object类型参数，该参数的属性值有：

名称数据类型描述
progressnumber下载进度
totalBytesWrittennumber已经下载的数据长度，单位byte
totalBytesExpectedToWritenumber预期需要下载的数据总长度，单位byte

代码示例

  1. let task = tt.downloadFile({
  2.     url: 'somefileurl',
  3.     success (res) {
  4.         if (res.statusCode === 200) {
  5.             console.log(`${res.tempFilePath}`);
  6.         }
  7.     },
  8.     fail (res) {
  9.         console.log(`downloadFile调用失败`);
  10.     }
  11. });
  13. task.onProgressUpdate((res) => {
  14.     this.setData({
  15.         progress: res.progress
  16.     });
  17. });
  19. if (someReason) {
  20.     task.abort();
  21. }

已知问题

原文: https://developer.toutiao.com/docs/api/downloadFile.html