title: DownloadTask

sidebar_label: DownloadTask

方法

abort

中断下载任务

参考文档

  1. () => void

API 支持度

API 微信小程序 H5 React Native
DownloadTask.abort ✔️

offHeadersReceived

取消监听 HTTP Response Header 事件

参考文档

  1. (callback: OffHeadersReceivedCallback) => void
参数 类型 说明
callback OffHeadersReceivedCallback HTTP Response Header 事件的回调函数

API 支持度

API 微信小程序 H5 React Native
DownloadTask.offHeadersReceived ✔️

offProgressUpdate

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

参考文档

  1. (callback: OffProgressUpdateCallback) => void
参数 类型 说明
callback OffProgressUpdateCallback 下载进度变化事件的回调函数

API 支持度

API 微信小程序 H5 React Native
DownloadTask.offProgressUpdate ✔️

onHeadersReceived

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

参考文档

  1. (callback: OnHeadersReceivedCallback) => void
参数 类型 说明
callback OnHeadersReceivedCallback HTTP Response Header 事件的回调函数

API 支持度

API 微信小程序 H5 React Native
DownloadTask.onHeadersReceived ✔️

onProgressUpdate

监听下载进度变化事件

参考文档

  1. (callback: OnProgressUpdateCallback) => void
参数 类型 说明
callback OnProgressUpdateCallback 下载进度变化事件的回调函数

API 支持度

API 微信小程序 H5 React Native
DownloadTask.onProgressUpdate ✔️

参数

OffHeadersReceivedCallback

HTTP Response Header 事件的回调函数

  1. (res: CallbackResult) => void
参数 类型
res CallbackResult

OffProgressUpdateCallback

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

  1. (res: CallbackResult) => void
参数 类型
res CallbackResult

OnHeadersReceivedCallback

HTTP Response Header 事件的回调函数

  1. (result: OnHeadersReceivedCallbackResult) => void
参数 类型
result OnHeadersReceivedCallbackResult

OnProgressUpdateCallback

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

  1. (result: OnProgressUpdateCallbackResult) => void
参数 类型
result OnProgressUpdateCallbackResult

OnHeadersReceivedCallbackResult

参数 类型 说明
header Record<string, any> 开发者服务器返回的 HTTP Response Header

OnProgressUpdateCallbackResult

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

API 支持度

API 微信小程序 H5 React Native
DownloadTask.abort ✔️
DownloadTask.offHeadersReceived ✔️
DownloadTask.offProgressUpdate ✔️
DownloadTask.onHeadersReceived ✔️
DownloadTask.onProgressUpdate ✔️