downloadFile - 下载文件资源到本地

downloadFile(params: Object)

版本要求:

BaseKit≥2.3.2@ray-js/ray≥0.3.23

支持平台:

iOSAndroid

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

// Promise 调用
try {
  const res = await downloadFile({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

描述

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

参数

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

success 回调参数

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

fail 回调参数

属性	类型	说明
`errorMsg`	string	错误信息
`errorCode`	string \| number	错误码
		错误扩展

返回值

类型：DownloadTask

DownloadTask

属性	类型	说明	BaseKit 最低版本
`abort`	function	中断下载任务	v2.0.1
`onHeadersReceived`	function	监听 HTTP Response Header 事件。会比请求完成事件更早	v2.0.1
`offHeadersReceived`	function	取消监听 HTTP Response Header 事件	v2.0.1
`onProgressUpdate`	function	监听下载进度变化事件	v2.0.1
`offProgressUpdate`	function	取消监听下载进度变化事件	v2.0.1

示例代码

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

downloadFile({
  url: "https://airtake-public-data-1254153901.cos.ap-shanghai.myqcloud.com/ttttestfile/test_video.mp4",
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});