downloadFile 1.0.0+
下载网络文件到本地临时目录。
提示
网络相关的 API 在使用前需要配置域名白名单。请参考网络请求使用说明
提示
HTTP 请求 method 为GET
输入
继承标准对象输入,扩展属性描述:
名称 | 数据类型 | 属性 | 默认值 | 描述 |
---|---|---|---|---|
url | string | required | N/A | 文件地址 |
header | object | optional | `` | 请求Header |
输出
success
返回对象参数的扩展属性:
名称 | 数据类型 | 描述 |
---|---|---|
tempFilePath | string | 文件本地路径 |
statusCode | number | 返回 HTTP 状态码 |
本 API 的调用结果在通过回调传递的同时会返回一个downloadTask
对象,可以通过该对象的abort
方法中断请求任务;通过onProgressUpdate
方法监听下载进度。
onProgressUpdate
注册的监听方法会收到一个object
类型参数,该参数的属性值有:
名称 | 数据类型 | 描述 |
---|---|---|
progress | number | 下载进度 |
totalBytesWritten | number | 已经下载的数据长度,单位byte |
totalBytesExpectedToWrite | number | 预期需要下载的数据总长度,单位byte |
代码示例
let task = tt.downloadFile({
url: 'somefileurl',
success (res) {
if (res.statusCode === 200) {
console.log(`${res.tempFilePath}`);
}
},
fail (res) {
console.log(`downloadFile调用失败`);
}
});
task.onProgressUpdate((res) => {
this.setData({
progress: res.progress
});
});
if (someReason) {
task.abort();
}
已知问题
原文: https://developer.toutiao.com/docs/api/downloadFile.html