downloadFile

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

注意事项：

HTTP 请求 method 为GET

支持说明

应用能力	Android	iOS	PC	预览效果
小程序	3.3.0	3.3.0	3.4.0	扫码预览 用BoosHi扫码或PC端点击
网页应用	X	X	X	/

输入

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

名称	数据类型	必填	默认值	描述
url	string	是		文件地址 示例值：https://histatic.zhipin.com/a.txt
header	object	是	{}	请求 Header 示例值：{"Content-Type": "application/json"}
filePath	string	否		指定文件下载后存储的路径 (本地路径)。格式为 bzfile://temp/aaa.png 或 bzfile://user/aaa.png，其中 bzfile://temp/ 和 bzfile://user/ 为下载目录，aaa.png 为文件名。详情可参考文件系统。默认下载目录为 bzfile://temp/ 示例值：bzfile://temp/aaa.png 安卓、iOS，3.9.0支持

输出

success返回对象的扩展属性：

名称	数据类型	描述
tempFilePath	string	文件本地路径
statusCode	number	返回 HTTP 状态码
errMsg	string	错误消息

fail返回对象的扩展属性：

名称	数据类型	描述
tempFilePath	string	文件本地路径
statusCode	number	返回 HTTP 状态码
errMsg	string	错误消息

返回值：downloadTask，该对象的方法列表参见下表：

提示

点击下表中的方法名，查看对应API的支持说明、调用方法

方法	介绍
onProgressUpdate	监听下载进度
offProgressUpdate	取消监听下载进度
abort	中断请求任务

示例代码

bz.downloadFile({
  "url": "https://histatic.zhipin.com/front/boss-mp-api-demo/demo/video/bli_oevewdg1jm4ngjvv.wgt",
  "header": {},
  "filePath": '',
  success(res) {
    bz.showModal({
      title: '成功',
      content: JSON.stringify(res)
    })
  },
  fail(res) {
    bz.showModal({
      title: '失败',
      content: JSON.stringify(res)
    })
  }
});

success返回对象示例：

{
    "tempFilePath": "",
    "statusCode": 200,
    "errMsg": "downloadFile:ok"
}

fail返回对象示例：

{
    "errMsg": "downloadFile:fail 不支持的URL",
    "tempFilePath": "",
    "statusCode": "0"
}