bl.downloadFile
下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求,返回文件的本地临时路径。使用前请注意阅读网络域名限制相关说明
参数说明
Object object
属性 | 类型 | 默认值 | 必填 | 说明 | 版本 |
---|---|---|---|---|---|
url | string | 是 | 下载资源的 url,不可以以 // 开头,单次下载资源大小限制50M内,超过会走fail回调 | ||
header | object | 否 | HTTP 请求 Header,header 中不能设置 Referer | ||
filePath | object | 否 | 指定文件下载后存储的路径 | 2.0.0 | |
success | function | 否 | 下载成功后以 tempFilePath 的形式传给页面,res = {tempFilePath: '文件的临时路径'} | ||
fail | function | 否 | 接口调用失败的回调函数 |
注:文件的临时路径,在小程序本次启动期间可以正常使用,如需持久保存,需在主动调用 bl.saveFile,才能在小程序下次启动时访问得到。
注:请在 header 中指定合理的 Content-Type 字段,以保证客户端正确处理文件类型
success参数说明
Object res
属性 | 类型 | 说明 | 版本 |
---|---|---|---|
tempFilePath | string | 临时文件路径。没传入 filePath 指定文件存储路径时会返回,下载后的文件会存储到一个临时文件 | |
filePath | string | 用户文件路径。传入 filePath 时会返回,跟传入的 filePath 一致 | |
statusCode | number | 开发者服务器返回的 HTTP 状态码 |
返回值
基础库版本 >=
2.3.0
支持
返回一个 downloadTask
对象,通过 downloadTask
,可监听下载进度变化事件,以及取消下载任务。
downloadTask 对象的方法列表
方法 | 参数 | 说明 | 版本 |
---|---|---|---|
onProgressUpdate | callback | 监听下载进度变化 | 2.3.0 |
abort | 无 | 中断下载任务 | 2.3.0 |
onProgressUpdate 返回参数说明
属性 | 类型 | 说明 | 版本 |
---|---|---|---|
progress | number | 下载进度百分比 | 2.3.0 |
totalBytesWritten | number | 已经下载的数据长度,单位 Bytes | 2.3.0 |
totalBytesExpectedToWrite | number | 预期需要下载的数据总长度,单位 Bytes | 2.3.0 |