dlt.downloadFile
简介
下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求,返回文件的本地临时路径 (本地路径)。
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 |
---|---|---|---|---|---|
url | string | 是 | 请求的地址 | ||
saveName | string | 否 | 可为空,如果为空取的是 Url 最后分隔符后的字符串 | ||
header | string | 否 | 设置请求的 header,JSON string | ||
timeout | number | 60000 | 否 | 超时时间,单位为毫秒。默认值为 60000。 | 3.0.0 版本后支持 |
success | function | 否 | 接口调用成功的回调函数 | ||
fail | function | 否 | 接口调用失败的回调函数 | ||
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
object.success 回调函数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
tempFilePath | string | 临时下载保存的路径 |
success | string | true-成功 |
object.fail 回调函数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
errCode | string | 错误码 |
errMsg | string | 错误信息 |
success | string | false-失败 |
errMsg 说明
错误信息 | 说明 |
---|---|
Download Fail,Data storage failed because of insufficient storage space: S001 | 下载失败,存储空间不足 |
Download Fail,Exception_"+t.toString()+ ":D002 | 下载失败:出现异常 |
Download Fail,appId is empty:D003 | 下载失败:小程序 ID 不存在 |
Download Fail,downloadUrl is error:D004 | 下载失败:下载地址有误 |
Download Fail,downloadPath is empty:D005 | 下载失败:下载存储路径为空 |
Download Fail,onFailure_"+e.toString()+":D006 | 下载失败 |
Download Fail,onResponse_" + e.toString() + ":D007 | 下载失败 |
示例代码
// pages/index/index.js
Page({
downloadFile() {
dlt.downloadFile({
url: "xxx",
success(res) {
console.log(res);
},
fail(res) {
console.error(res);
},
});
},
});