ek.downloadFile
下载文件资源到本地。客户端直接发起一个 GET 请求,返回文件的本地临时路径 (本地路径)。
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
url | string | 是 | 下载资源的 url | |
header | Object | 否 | HTTP 请求的 Header | |
timeout | number | 60000 | 否 | 超时时间,单位为毫秒 |
filePath | string | 否 | 指定文件下载后存储的路径 (本地路径) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
成功返回
属性 | 类型 | 说明 |
---|---|---|
tempFilePath | string | 临时文件路径 (本地路径)。没传入 filePath 指定文件存储路径时会返回,下载后的文件会存储到一个临时文件 |
filePath | string | 用户文件路径 (本地路径)。传入 filePath 时会返回,跟传入的 filePath 一致 |
dataLength | number | 服务器返回的数据长度 |
header | Object | 服务器返回的 HTTP Response Header |
statusCode | number | 服务器返回的 HTTP 状态码 |
返回值
Example
ts
ek.downloadFile({
url: 'https://example.com/file/test.png',
success: res => {
console.log(res.tempFilePath)
},
fail: res => {
ek.showToast({ title: 'network error', icon: 'error' })
}
})