DownloadTask.onProgressUpdate(function listener)

基础库 1.4.0 开始支持,低版本需做兼容处理。

微信小程序插件:支持

相关文档: 网络使用说明、局域网通信

功能描述

监听下载进度变化事件

参数

function listener

下载进度变化事件的监听函数

参数

Object res
属性 类型 说明
progress number 下载进度百分比
totalBytesWritten number 已经下载的数据长度,单位 Bytes
totalBytesExpectedToWrite number 预期需要下载的数据总长度,单位 Bytes

DownloadTask.onHeadersReceived(function listener)

基础库 2.1.0 开始支持,低版本需做兼容处理。

微信小程序插件:支持

相关文档: 网络使用说明、局域网通信

功能描述

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

参数

function listener

HTTP Response Header 事件的监听函数

参数

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

DownloadTask.offProgressUpdate(function listener)

基础库 2.1.0 开始支持,低版本需做兼容处理。

微信小程序插件:支持

相关文档: 网络使用说明、局域网通信

功能描述

移除下载进度变化事件的监听函数

参数

function listener

onProgressUpdate 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function (res) { console.log(res) }

DownloadTask.onProgressUpdate(listener)
DownloadTask.offProgressUpdate(listener) // 需传入与监听时同一个的函数对象

DownloadTask.offHeadersReceived(function listener)

基础库 2.1.0 开始支持,低版本需做兼容处理。

微信小程序插件:支持

相关文档: 网络使用说明、局域网通信

功能描述

移除 HTTP Response Header 事件的监听函数

参数

function listener

onHeadersReceived 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function (res) { console.log(res) }

DownloadTask.onHeadersReceived(listener)
DownloadTask.offHeadersReceived(listener) // 需传入与监听时同一个的函数对象

DownloadTask

基础库 1.4.0 开始支持,低版本需做兼容处理。

相关文档: 网络使用说明、局域网通信

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

方法

DownloadTask.abort()

中断下载任务

DownloadTask.onProgressUpdate(function listener)

监听下载进度变化事件

DownloadTask.offProgressUpdate(function listener)

移除下载进度变化事件的监听函数

DownloadTask.onHeadersReceived(function listener)

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

DownloadTask.offHeadersReceived(function listener)

移除 HTTP Response Header 事件的监听函数

示例代码

const downloadTask = wx.downloadFile({
  url: 'http://example.com/audio/123', //仅为示例,并非真实的资源
  success (res) {
    wx.playVoice({
      filePath: res.tempFilePath
    })
  }
})

downloadTask.onProgressUpdate((res) => {
  console.log('下载进度', res.progress)
  console.log('已经下载的数据长度', res.totalBytesWritten)
  console.log('预期需要下载的数据总长度', res.totalBytesExpectedToWrite)
})

downloadTask.abort() // 取消下载任务