title: UploadTask

sidebar_label: UploadTask

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

参考文档

方法

abort

中断上传任务

参考文档

  1. () => void

API 支持度

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

offHeadersReceived

取消监听 HTTP Response Header 事件

参考文档

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

API 支持度

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

offProgressUpdate

取消监听上传进度变化事件

参考文档

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

API 支持度

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

onHeadersReceived

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

参考文档

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

API 支持度

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

headersReceived

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

onProgressUpdate

监听上传进度变化事件

参考文档

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

API 支持度

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

progress

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

参数

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 上传进度百分比
totalBytesExpectedToSend number 预期需要上传的数据总长度,单位 Bytes
totalBytesSent number 已经上传的数据长度,单位 Bytes

API 支持度

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