sud.downloadFile
JS
sud.downloadFile (Object object)下载文件资源到本地
客户端直接发起一个 HTTP GET 请求,返回文件的本地文件路径。单次下载允许的最大文件为 50MB
参数
- Object object: 传入参数,具体说明见下图
object 的属性说明:
| 属性 | 键值类型 | 是否必填 | 说明 |
|---|---|---|---|
| url | string | 是 | 下载资源的 url |
| header | Object | 否 | HTTP 请求的 Header,Header 中不能设置 Referer |
| timeout | number | 否 | 超时时间,单位为毫秒 |
| filePath | string | 是 | 指定文件下载后存储的路径 |
| success | function | 否 | 接口调用成功的回调函数 |
| fail | function | 否 | 接口调用失败的回调函数 |
| complete | function | 否 | 接口调用结束的回调函数 |
success 回调函数的参数
- Object res: 返回下载信息
res 的属性说明:
| 属性 | 键值类型 | 说明 |
|---|---|---|
| tempFilePath | string | 临时文件路径。没有传入 filePath 指定文件存储路径时会返回,下载后的文件会存储到临时目录 |
| filePath | string | 用户文件路径。传入 filePath 时会返回,跟传入的 filePath 一致 |
| statusCode | number | 服务器返回的 HTTP 状态码 |
返回值
- DownloadTask: 返回一个可以监听下载进度变化事件,以及取消下载任务的对象