Skip to content
On this page

ek.downloadFile

下载文件资源到本地。客户端直接发起一个 GET 请求,返回文件的本地临时路径 (本地路径)。

参数

参数类型默认值必填说明
urlstring下载资源的 url
headerObjectHTTP 请求的 Header
timeoutnumber60000超时时间,单位为毫秒
filePathstring指定文件下载后存储的路径 (本地路径)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

成功返回

属性类型说明
tempFilePathstring临时文件路径 (本地路径)。没传入 filePath 指定文件存储路径时会返回,下载后的文件会存储到一个临时文件
filePathstring用户文件路径 (本地路径)。传入 filePath 时会返回,跟传入的 filePath 一致
dataLengthnumber服务器返回的数据长度
headerObject服务器返回的 HTTP Response Header
statusCodenumber服务器返回的 HTTP 状态码

返回值

DownloadTask

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' })
  }
})