# 文件接口

介绍对接系统的 H5 页面通过 JS-SDK 提供的文件接口,实现下载、打开和代理请求对接系统上的文件。

前提:已部署文件安全隧道,并配置好地址映射,具体见文档《文件安全隧道》

# downloadFile

UPCHAT.M.NAPI.downloadFile(_success, _fail, para);

参数:

{
  url: '文件下载地址',
  method: 'post / get 请求模式',
  encrypt: '0 / 1 是否加密',
  fileExtension:'文件后缀名',
  openApp: 'online 直接打开 / wps 打开',
}

成功回调:

{
	status: '0',
	filePath: '文件本地路径',
	progress: '文件下载进度'
}

# showLoadingProgress

UPCHAT.M.NAPI.showLoadingProgress(success, fail, para);

显示文件的下载进度。

参数:progress,0-1 浮点值。

在 downloadFile 接口的成功回调中,调用此接口,显示文件下载进度。

# openFile

UPCHAT.M.NAPI.openFile(_success, _fail, para);

参数:

{
	filePath: '文件本地路径',
	openApp: 'online 预览线上文件 | app 直接打开 |wps 在WPS中打开',
  fileExtension: 'online模式下,需提供文件的后缀格式',
  WPSEditMode: 'wps编辑模式,“0”:非编辑模式,“1”:编辑模式',
  hasWaterMark: '显示水印, ”0“:不显示水印,”1“:显示水印'
}

在 downloadFile 接口的成功回调中,业务系统选择保存方式存储已下载文件的本地路径。再通过 openFile 接口实现文件预览或 wps 打开、编辑。

# uploadFile

UPCHAT.M.NAPI.uploadFile(_success, _fail, para);

上传文件

{
  url: "对接系统的文件上传接口路径";
  param: "非必填,扩展使用:比如上传者的名称";
  filePath: "文件本地存储路径";
  encrypt: "请求是否加密,“0”:不加密,“1”:加密";
}

# chooseMyFile

UPCHAT.M.NAPI.chooseMyFile(_success, _fail)

进入U聊我的文件,选择需要的文件。

为保证安全性,U聊系统中的文件流转是封闭的。用户收发的所有的文件,均存在我的文件中,也只能在应用中查看。

接口成功回调中,拿到文件对应的 token,业务页面再请求U聊后台,下载对应的文件数据。

上次更新: 6/23/2021, 10:36:05 AM