文件下载 - fileDownload

简介

• 该任务是一个异步任务，需使用async await / promise结构 获取回调值
• 该任务用于下载远端文件到本地端

环境适配说明

环境名称	是否支持	jssdk文件最低版本号	npm包最低版本号
湘易办APP-小程序	✅	1.1.4	0.0.4
湘易办APP-小程序-webview	✅	1.1.8	0.0.4
湘易办APP-webview	✅	2.0.0	0.0.4
三方H5	❌	--	--
三方小程序	❌	--	--

参数

参数名	类型	必填	描述
url	String	是	文件地址
name	String	是	文件名

返回值

仅列出返回体内的子参数，整体是一个Object对象

参数名	子参数	类型	描述
resultObj		Object	文件下载结果
	path	String	文件下载路径
isSuccess		Boolean	文件下载是否成功
errorMsg		String	错误信息

示例

async & await 模式

const fileInfo = {
  url: 'https://www.example.com/file.pdf',
  name: 'file.pdf'
};
const result = await this.$xybAgent.fileDownload(fileInfo);
if (res?.isSuccess) {
  // 执行业务代码
}

promise 模式

const fileInfo = {
  url: 'https://www.example.com/file.pdf',
  name: 'file.pdf'
};
this.$xybAgent.fileDownload(fileInfo).then(res => {
  if (res?.isSuccess) {
    // 执行业务代码
  }
});