【小程序】应用程序编程接口能力汇总——网络API（二）

UploadFileTask 

UploadFileTask.abort

中断上传任务

参数

Object object

中断上传任务的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 中断上传任务
 */
export function abort(params: {
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: null) => void;
  failure?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

 

UploadFileTask.onHeadersReceived

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

参数

function callback

监听 HTTP Response Header 事件。会比请求完成事件更早的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
header	any		是	开发者服务器返回的 HTTP Response Header
requestId	string		是	网络请求 id

 

UploadFileTask.offHeadersReceived

取消监听 HTTP Response Header 事件

参数

function callback

取消监听 HTTP Response Header 事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
header	any		是	开发者服务器返回的 HTTP Response Header
requestId	string		是	网络请求 id

 

UploadFileTask.onProgressUpdate

监听上传进度变化事件

参数

function callback

监听上传进度变化事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
progress	number		是	上传进度百分比
totalBytesSent	number		是	已经上传的数据长度，单位 Bytes
totalBytesExpectedToSend	number		是	预期需要上传的数据总长度，单位 Bytes
requestId	string		是	网络请求 id

 

UploadFileTask.offProgressUpdate

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

参数

function callback

取消监听上传进度变化事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
progress	number		是	上传进度百分比
totalBytesSent	number		是	已经上传的数据长度，单位 Bytes
totalBytesExpectedToSend	number		是	预期需要上传的数据总长度，单位 Bytes
requestId	string		是	网络请求 id

 

DownloadFileTask

DownloadFileTask.abort

中断下载任务

参数

Object object

中断下载任务的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 中断下载任务
 */
export function abort(params: {
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: null) => void;
  failure?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

 

DownloadFileTask.onHeadersReceived

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

参数

function callback

监听 HTTP Response Header 事件。会比请求完成事件更早的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
header	any		是	开发者服务器返回的 HTTP Response Header
requestId	string		是	网络请求 id

 

DownloadFileTask.offHeadersReceived

取消监听 HTTP Response Header 事件

参数

function callback

取消监听 HTTP Response Header 事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
header	any		是	开发者服务器返回的 HTTP Response Header
requestId	string		是	网络请求 id

 

DownloadFileTask.onProgressUpdate

监听下载进度变化事件

参数

function callback

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

回调参数 Object res

属性	类型	默认值	必填	说明
progress	number		是	下载进度百分比
totalBytesSent	number		是	已经下载的数据长度，单位 Bytes
totalBytesExpectedToSend	number		是	预期需要下载的数据总长度，单位 Bytes
requestId	string		是	网络请求 id

 

DownloadFileTask.offProgressUpdate

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

参数

function callback

取消监听下载进度变化事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
progress	number		是	下载进度百分比
totalBytesSent	number		是	已经下载的数据长度，单位 Bytes
totalBytesExpectedToSend	number		是	预期需要下载的数据总长度，单位 Bytes
requestId	string		是	网络请求 id

👉 立即开发。