startDownloadFile ^8.11
开始文件下载
#请求参数
| Prop |
Type |
Required |
Default |
Comment |
downloadFolder |
String |
N |
downFiles |
自定义下载目录,默认目录为 WeexApp/downFiles. downloadPath 为相对路径时,如为某个 sn8 对应的目录是 WeexApp/sn8. 支持绝对路径 |
urls |
Array |
Y |
N/A |
需要下载的文件的 url 数组,支持分片下载。如果数组长度大于 1,则下载完成后会合并为一个文件 |
fileSuffix |
String |
N |
N/A |
保存的文件后缀. 如果 urls 的长度大于 1 则是必要的,否则非必要 |
#接口调用示例
const params = {
downloadFolder: "downFiles",
urls: [
"http://dolphin-weex-dev.msmartlife.cn/hybrid/docs/assets/img/1.daeeb425.png",
],
fileSuffix: "png",
};
this.$bridge
.startDownloadFile(
params,
(res) => {
console.log("startDownloadFile-res", res);
},
(err) => {
console.log("startDownloadFile-err", err);
}
);
#返回参数
| Prop |
Type |
Required |
Comment |
code |
Number |
Y |
返回码 0-开始下载,其它:-1001-(缺少参数 fileSuffix,缺少参数 urls, 参数 urls 不能为空,下载失败,业务异常),-3007-手机空间不足,请清理空间再下载, -4009-存储未授权 |
msg |
String |
N |
返回信息 |
status |
Number |
Y |
当前下载状态。0-等待中, 1-下载中,2-下载成功,3-下载失败 |
fileSize |
Number |
N |
文件大小,单位是字节 |
progress |
Number |
Y |
当前下载状态进度(0-100) |
filePath |
String |
N |
下载的所有文件的合并后的文件的绝对路径(非必须,当下载完成后返回) |
#返回示例
// 成功返回
// 下载过程中,成功回调可能会多次触发,直到下载完成或者失败
{
code: 0,
msg: "success",
status: 2,
progress: 100,
filePath: "/storage/emulated/0/Android/data/com.midea.ai.appliances/files/WeexApp/downFiles/1.daeeb425.png",
fileSize: 10972
}
// 失败返回
{
code: -1001,
errorMsg: "缺少参数 urls"
}