下载文件

文件下载

方法名：downloadFile
作用：下载文件

请求参数说明：

参数	类型	是否必填	含义	备注
url	String	是	要下载的文件的url
name	String	否	文件名
headers	Object	否	下载请求头
isSaveCustomPath	Boolean	否	是否自定义下载路径	默认为false 【仅PC端支持】

1、如果存在文件名必须填写完整后缀，例如日报.xlsx
2、在未指定文件名的时候,下载文件接口中需要按如下图配置文件名

结果参数说明：

参数	类型	含义	备注
filePath	String	本地文件路径	对应打开本地文件openLocalFile 中的url参数
name	String	文件名

文件下载进度回调结果

参数	类型	含义	备注
currentBytes	Number	已经下载文件大小	byte单位
totalBytes	Number	总文件大小	byte单位
progress	Number	进度值	进度值为 0-100，totoalBytes没取到为0时，进度是0
tag	String	下载标识	用于取消下载的参数，目前是下载url

代码示例

cxApi.downloadFile({
	url: 'xxxxxxxxx',
	name: 'xxx.xlsx', // 非必填
	headers: {
		Authorization: "xxx" // 一般用于传递下载需要传递鉴权信息(非必填)
	},
    // 文件下载进度回调【非必要】
	onProgress: (res) => {
		//todo
	},
	onSuccess: (res) => {
		// todo

	},
	onFail: (res) => {
		// todo
	}
})

// 下载成功返回 res 
{
  
    "filePath":"/storage/emulated/0/Android/data/com.raycom.securesms/files/APP93CFA4A3B3C2156F25866003/0/健康日报.zip",
    "name":"健康日报.zip"
    
}
// 下载进度回调
{
    "currentBytes": 21917602,
    "progress": 16,
    "tag": "http://xxx/CX/test.apk",
    "totalBytes": 130600065
 }

取消下载

方法名：cancelDownloadFile
作用：取消下载

请求参数说明：

参数	类型	是否必填	含义	备注
tag	String	是	下载中的文件标识	普通下载是url,安全下载是`tag`

结果参数说明：

参数	类型	含义	备注
code	Number	错误码
msg	String	错误信息

注意：取消下载成功后，下载文件接口会返回错误码：-10002

代码示例

文件下载#

取消下载#

文件下载

取消下载