智能小程序 Ray 开发——网络 API 合集（二）

UploadFileTask

UploadFileTask.abort

中断上传任务

参数

Object object

中断上传任务的回调函数

回调参数 Object res

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

函数定义示例

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

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。 

 

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

 

downloadFile

下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求，返回文件的本地临时路径 (本地路径)，单次下载允许的最大文件为 200MB。使用前请注意阅读相关说明。 注意：请在服务端响应的 header 中指定合理的 Content-Type 字段，以保证客户端正确处理文件类型。的回调函数

引入

import { downloadFile } from '@ray-js/ray';

回调参数 Object res

属性	类型	默认值	必填	说明
url	string		是	下载资源的 url
header	any		否	HTTP 请求的 Header，Header 中不能设置 Referer
timeout	number		否	超时时间，单位为毫秒
filePath	string		否	指定文件下载后存储的路径 (本地路径)
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性	类型	说明
tempFilePath	string	临时文件路径 (本地路径)。没传入 filePath 指定文件存储路径时会返回，下载后的文件会存储到一个临时文件
filePath	string	用户文件路径 (本地路径)。传入 filePath 时会返回，跟传入的 filePath 一致
statusCode	number	开发者服务器返回的 HTTP 状态码
profile	Profile	网络请求过程中一些调试信息

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

返回值

DownloadFileTask

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

 👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。