qq.downloadFile

DownloadTask qq.downloadFile(Object object)

下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求，返回文件的本地临时路径。使用前请注意阅读相关说明。

注意：请在服务端响应的 header 中指定合理的 Content-Type 字段，以保证客户端正确处理文件类型。

参数

Object object
属性类型默认值必填说明最低版本
urlstring是下载资源的 url
headerObject否HTTP 请求的 Header，Header 中不能设置 Referer
filePathstring否指定文件下载后存储的路径
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）
object.success 回调函数

参数

Object res

属性类型说明
tempFilePathstring临时文件路径。如果没传入 filePath 指定文件存储路径，则下载后的文件会存储到一个临时文件
statusCodenumber开发者服务器返回的 HTTP 状态码

返回值

DownloadTask

一个可以监听下载进度变化事件和取消下载的对象

示例代码

  1. qq.downloadFile({
  2.   url: 'https://example.com/audio/123', // 仅为示例，并非真实的资源
  3.   success(res) {
  4.     // 只要服务器有响应数据，就会把响应内容写入文件并进入 success 回调，业务需要自行判断是否下载到了想要的内容
  5.     if (res.statusCode === 200) {
  6.       qq.playVoice({
  7.         filePath: res.tempFilePath
  8.       })
  9.     }
  10.   }
  11. })

DownloadTask

一个可以监听下载进度变化事件，以及取消下载任务的对象

方法

DownloadTask.abort()

中断下载任务

DownloadTask.onProgressUpdate(function callback)

监听下载进度变化事件

DownloadTask.offProgressUpdate(function callback)

取消监听下载进度变化事件

DownloadTask.onHeadersReceived(function callback)

监听 HTTP Response Header 事件。会比请求完成事件更早

DownloadTask.offHeadersReceived(function callback)

取消监听 HTTP Response Header 事件

示例代码

  1. const downloadTask = qq.downloadFile({
  2.   url: 'http://example.com/audio/123', // 仅为示例，并非真实的资源
  3.   success(res) {
  4.     qq.playVoice({
  5.       filePath: res.tempFilePath
  6.     })
  7.   }
  8. })
  10. downloadTask.onProgressUpdate((res) => {
  11.   console.log('下载进度', res.progress)
  12.   console.log('已经下载的数据长度', res.totalBytesWritten)
  13.   console.log('预期需要下载的数据总长度', res.totalBytesExpectedToWrite)
  14. })
  16. downloadTask.abort() // 取消下载任务

.onProgressUpdate

DownloadTask.onProgressUpdate(function callback)

监听下载进度变化事件

参数

function callback

下载进度变化事件的回调函数

参数

Object res

属性类型说明
progressnumber下载进度百分比
totalBytesWrittennumber已经下载的数据长度，单位 Bytes
totalBytesExpectedToWritenumber预期需要下载的数据总长度，单位 Bytes

.onHeadersReceived

DownloadTask.onHeadersReceived(function callback)

监听 HTTP Response Header 事件。会比请求完成事件更早

参数

function callback

HTTP Response Header 事件的回调函数

参数

Object res

属性类型说明
headerObject开发者服务器返回的 HTTP Response Header

.offProgressUpdate

DownloadTask.offProgressUpdate(function callback)

取消监听下载进度变化事件

参数

function callback

下载进度变化事件的回调函数

.offHeadersReceived

DownloadTask.offHeadersReceived(function callback)

取消监听 HTTP Response Header 事件

参数

function callback

HTTP Response Header 事件的回调函数

.abort

DownloadTask.abort()

中断下载任务