# upload()

文件上传

示例

this.file = this.$app.upload({
            url: 'http://inflex.oicp.net/mock-example/file/upload', // 上传url
            filePath: '_doc/222.zip', // 上传文件的路径
            success: function (success) {
              console.log('success', success);
            },
            error: function (error) {
              console.log(error);
            }
          });
          console.log('app/upload=====', this.file);
          // this.file.start(); 文件对象创建完成之后调用

入参说明

参数名 类型 必填 说明
data object 上传任务详细参数

data参数说明

参数名 类型 必填 说明
url String 上传url。
success Function 可选 上传成功时回调。
error Function 可选 上传失败时回调。
filePath String 上传文件的路径。
fileAttr Object 可选 文件标识、文件名称、文件类型等
formdata Object 可选 上传时参数。
addDataSuccess Function 可选 添加数据成功回调。
addFileSuccess Function 可选 添加文件成功回调。
blocksize Number 可选 上传任务每次上传的文件块大小(暂不支持)。单位为Byte(字节),默认值为102400,若设置值小于等于0则表示不分块上传。仅在支持断点续传的服务有效
chunkSize Number 可选 分块上传的大小。单位为Kb,设置值小于等于0则不分块上传,默认为不分块上传。注意:分块上传需要服务器支持,如果服务器不支持则会上传失败
method String 可选 网络请求类型,仅支持http协议的“POST”请求。
header Object 可选 上传任务HTTP报文头
priority Number 可选 上传任务的优先级(暂不支持),数值越大优先级越高,默认优先级值为0
timeout Number 可选 上传任务超时时间(暂不支持),单位为s(秒),默认值为120s。 超时时间为服务器响应请求的时间(不是上传任务完成的总时间),如果设置为0则表示永远不超时
retry Number 可选 上传任务重试次数(暂不支持),默认为重试3次
retryInterval Number 可选 上传任务重试间隔时间(暂不支持),单位为s(秒),默认值为30s

success 返回参数说明:

参数名 类型 说明
res object 上传任务

# pause()

文件上传暂停

示例

          this.file.pause()

# resume()

文件上传恢复

示例

          this.file.resume()

# uploadEnumerate()

文件上传查询

示例

          this.$app.uploadEnumerate().then(res => {
            console.log('app/uploadEnumerate====', res);
          });

success 返回参数说明:

参数名 类型 说明
tasks Array 上传任务

# abort()

文件上传取消

示例

          this.file.abort()

# uploadClear()

清除上传任务

示例

          this.$app.uploadClear().then(res => {
            console.log('app/uploadClear====', res);
          });

# download()

文件下载

示例

this.task = this.$app.download({
            url: 'https://ss2.baidu.com/-vo3dSag_xI4khGko9WTAnF6hhy/exp/w=500/sign=ced6daeb3812b31bc76ccd29b6193674/908fa0ec08fa513d9bcc2a723c6d55fbb2fbd93c.jpg', // 下载文件URL地址
            filename: '_doc/222/test.jpg', // 下载文件保存的路径
            success: function (success) {
              console.log('success', success);
            },
            error: function (error) {
              console.log('error000', error);
            }
          });
          console.log('app/download=====', this.task);
          this.task.start();

入参说明

参数名 类型 必填 说明
data object 下载任务详细参数

data参数说明

参数名 类型 必填 说明
url String 下载文件URL地址。
method String 可选 网络请求类型,支持http协议的“GET”、“POST”,默认为“GET”请求。
data object 可选 POST请求时提交的数据,仅在网络请求类型method设置为"POST"时有效
header object 可选 下载任务HTTP报文头
success Function 可选 下载成功回调。
error Function 可选 下载失败回调。
filename String 下载文件保存的路径,保存的文件夹要已经存在。保存文件路径仅支持以"_downloads/"、"_doc/"、"_documents/"开头的字符串。文件路径以文件后缀名结尾(如"_doc/download/sdk.doc")表明指定保存文件目录及名称,以“/”结尾则认为指定保存文件的目录(此时程序自动生成文件名)。
priority Number 可选 下载任务的优先级(暂不支持),数值越大优先级越高,默认优先级值为0
timeout Number 可选 下载任务超时时间(暂不支持),单位为s(秒),默认值为120s。 超时时间为服务器响应请求的时间(不是下载任务完成的总时间),如果设置为0则表示永远不超时。
retry Number 可选 下载任务重试次数(暂不支持),默认为重试3次
retryIntervalretry Number 可选 下载任务重试间隔时间(暂不支持),单位为s(秒),默认值为30s

success 返回参数说明:

参数名 类型 说明
res object 下载任务

# pause()

文件下载暂停

示例

      this.task.pause()

# resume()

文件下载恢复

示例

      this.task.resume()

# downloadEnumerate()

文件下载查询

示例

          this.$app.downloadEnumerate().then(res => {
            console.log('app/downloadEnumerate====', res);
          });

success 返回参数说明:

参数名 类型 说明
tasks Array 下载任务

# abort()

文件下载取消

示例

      this.task.abort()

# downloadClear()

清除下载任务

示例

          this.$app.downloadClear().then(res => {
            console.log('app/downloadClear====', res);
          });

# convertLocalFileSystemURL()

本地扩展相对路径转换成平台绝对路径

示例

this.$app.convertLocalFileSystemURL('_downloads/202001081458.txt').then(res => {
            console.log('app/convertLocalFileSystemURL====', res);
          });

入参说明

参数名 类型 必填 说明
url string 平台扩展相对路径,如:_doc/xxx/xxx.txt

success 返回参数说明:

参数名 类型 说明
path string 平台扩展绝对路径,如:/var/xxx/PRIVATE_DOC/xxx/xxx.txt

# convertAbsoluteFileSystem()

平台绝对路径转换成本地扩展相对路径

示例

this.$app.convertAbsoluteFileSystem('/storage/emulated/0/Android/data/com.yusys.yump/files/webapp/downloads/share/202001081458.txt').then(res => {
            console.log('app/convertAbsoluteFileSystem====', res);
          });

入参说明

参数名 类型 必填 说明
url string 平台绝对路径

success 返回参数说明:

参数名 类型 说明
path string 平台相对路径

# requestFileSystem()

请求本地扩展文件系统

示例

 this.$app.requestFileSystem(2).then(res => {
            console.log('app/requestFileSystem====', res);
          });

入参说明

参数名 类型 必填 说明
type Number 本地文件系统常量,1是foxsdk.io.PRIVATE_WWW, 2是foxsdk.io.PRIVATE_DOC, 3是window.foxsdk.io.PUBLIC_DOCUMENT, 4是window.foxsdk.io.PUBLIC_DOWNLOADS

success 返回参数说明:

参数名 类型 说明
name string 文件系统名称,共4种文件系统:PRIVATE_WWW、PRIVATE_DOC、PUBLIC_DOCUMENTS、PUBLIC_DOWNLOADS
root:{FileSystem} object 文件或目录操作对象

FileSystem 返回参数说明:

参数名 类型 说明
name string 文件名
root:{FileSystem} object 文件对应的文件系统对象
fullPath string 文件平台绝对路径
remoteURL string 文件本地扩展相对路径
isFile string 操作对象的是否为文件,FileEntry对象固定其值为true
isDirectory string 操作对象是否为目录,FileEntry对象固定其值为false

# resolveLocalFileSystemURL()

快速获取指定的目录或文件操作对象

示例

          this.$app.resolveLocalFileSystemURL('_doc/111').then(res => {
            console.log('app/resolveLocalFileSystemURL====', res);
          });

入参说明

参数名 类型 必填 说明
url string 要操作文件或目录的URL地址,如:_doc/xxx/xxx.txt

success 返回参数说明:

参数名 类型 说明
name string 文件名
fullPath string 文件平台绝对路径
remoteURL string 文件本地扩展相对路径
fileSystem object 文件对应的文件系统对象
isFile string 操作对象的是否为文件,FileEntry对象固定其值为true
isDirectory string 操作对象是否为目录,FileEntry对象固定其值为false

# moveTo()

移动本地文件

示例

          this.$app.moveTo('_doc/111', '_doc/', '222').then(res => {
            console.log('app/moveTo====', res);
          });

入参说明

参数名 类型 必填 说明
url string 需要移动的原始文件路径
targetUrl string 需要移动到的目的地文件路径
newName string 移动后的文件名称

success 返回参数说明:

参数名 类型 说明
res object 目录或文件操作对象

# copyTo()

复制本地文件

示例

          this.$app.copyTo('_doc/picture.JPG', '_doc/', 'PICTURE2').then(res => {
            console.log('app/copyTo====', res);
          });

入参说明

参数名 类型 必填 说明
url string 需要复制的原始文件路径
targetUrl string 需要复制到的目的地文件路径
newName string 复制后的文件名称

success 返回参数说明:

参数名 类型 说明
res object 目录或文件操作对象

# remove()

删除本地文件

示例

          this.$app.remove('_doc/PICTURE2.JPG', false).then(res => {
            console.log('app/remove====', res);
          });

入参说明

参数名 类型 必填 说明
url string 需要删除的原始文件路径
recursive Boolean 是否递归查询

success 返回参数说明:

参数名 类型 说明
res object

# getFileListMetadata()

获取目录的属性

示例

          this.$app.getFileListMetadata('_doc/222', true).then(res => {
            console.log('app/getFileListMetadata====', res);
          });

入参说明

参数名 类型 必填 说明
url string 目录路径
recursive Boolean 可选 是否递归查询,默认false

success 返回参数说明:

参数名 类型 说明
filelist Array[Object] 文件或目录的状态信息对象

filelist 返回参数说明:

参数名 类型 说明
size Number 文件大小,单位:byte
createTime Number 创建时间戳
filePath string 文件路径

# getFileDigestInfo()

获取文件摘要信息

示例

          this.$app.getFileDigestInfo('_doc/222/000.text', 'md5').then(res => {
            console.log('app/getFileDigestInfo====', res);
          });

入参说明

参数名 类型 必填 说明
url string 文件路径
digestAlgorithm String 可选 摘要算法,目前仅支持md5,默认md5

success返回参数说明:

参数名 类型 说明
digest string 文件摘要信息
size Number 文件大小,单位:byte

# getDirectory()

创建子目录

示例

          this.$app.getDirectory('_doc/', '222/441100', { create: true }).then(res => {
            console.log('app/getDirectory====', res);
          });

入参说明

参数名 类型 必填 说明
url string 要操作的文件
path string 要操作的目录相对于当前操作对象目录的地址
flag object 操作文件或目录的参数{create: false, exclusive: false},create:如果文件夹/文件已存在,则返回文件夹/文件信息;exclusive: 如果 文件夹/文件不存在,则先创建,然后再返回文件(夹)信息;exclusive仅在create为true时生效

success 返回参数说明:

参数名 类型 说明
res object 目录操作对象

# getFile()

创建文件或返回文件对象信息

示例

          this.$app.getFile('_doc/', '222/000.text', { create: true }).then(res => {
            console.log('app/getFile====', res);
          });
    // 此示例为创建'_doc/222'/000.text',或者返回‘_doc/222'/000.text’文件对象的信息

入参说明

参数名 类型 必填 说明
url string 要操作的文件目录
path string 要操作的文件,相对于当前操作对象url目录的地址
flag object 操作文件或目录的参数{create: false, exclusive: false},create:如果文件夹/文件已存在,则返回文件夹/文件信息;exclusive: 如果 文件夹/文件不存在,则先创建,然后再返回文件(夹)信息;,exclusive仅在create为true时生效

success 返回参数说明:

参数名 类型 说明
res object 目录操作对象

# compress()

压缩生成Zip文件

示例

           this.$app.compress('_doc/222', '_doc/0000.zip').then(res => {
            console.log('app/compress====', JSON.stringify(res));
          });

入参说明

参数名 类型 必填 说明
url string 要压缩文件或文件夹的真实路径
zipFile string 压缩完成产生的压缩文件路径

success 返回参数说明:

参数名 类型 说明
data string 压缩后的文件路径

# decompress()

解压缩Zip文件

示例

          this.$app.decompress('_doc/loction.zip', '_doc/location').then(res => {
            console.log('app/decompress====', JSON.stringify(res));
          });

入参说明

参数名 类型 必填 说明
zipFile string 要解压文件的真实路径,相对路径/绝对路径
url string 解压完成生产的文件路径

success 返回参数说明:

参数名 类型 说明
data string 解压成功的路径

# compressImage()

图片压缩转换

示例

          this.$app.compressImage({
            src: '_doc/picture.JPG',
            dst: '_doc/picture2.JPG'
          }).then(res => {
            console.log('app/compressImage====', JSON.stringify(res));
          });

入参说明

参数名 类型 必填 说明
data object 压缩图片参数配置

data参数说明

参数名 类型 必填 说明
src string 压缩转换原始图片的相对路径
dst string 压缩转换目标图片的相对路径
overwrite Boolean 可选 覆盖生成新文件,仅在dst制定的路径文件存在时有效: true:覆盖,false:不覆盖(如果文件存在,则返回失败)。 默认:false
quality string 可选 压缩图片的质量,取值范围为1-100,默认:50
width string 可选 缩放图片的宽度,支持像素值(如"100px")、百分比(如"50%")、自动计算(如"auto",即根据height与源图高的缩放比例计算,若未设置height则使用源图高度); 默认:"auto
height string 可选 缩放图片的高度,支持像素值(如"100px")、百分比(如"50%")、自动计算(如"auto",即根据width与源图宽的缩放比例计算,若未设置width则使用源图高度); 默认:"auto"
rotate Number 可选 旋转图片的角度,支持值:90-表示旋转90度;180-表示旋转180度;270-表示旋转270度。
clip object 可选 裁剪图片的区域,值参考ClipImageOptions定义,若设置clip属性值不合法,则不对图片进行裁剪操作
outSize string 可选 图片的指定大小,单位byte

clip参数说明

参数名 类型 必填 说明
top string 可选 图片裁剪区域与原图片上边界的偏移距离,支持像素值(如"10px")、百分比(如"10%");默认值为"0px"。注意:如果top值加height值超出原图片高度,则使用"auto"值进行裁 (下几个参数相同)
left string 可选 图片裁剪区域与原图片左边界的偏移距离,支持像素值(如"10px")、百分比(如"10%");默认值为"0px"。
width string 可选 图片裁剪区域的宽度,支持像素值(如"100px")、百分比(如"50%")、自动计算(如"auto",即从left位置到图片右边界的宽度);默认值为"auto"。
height string 可选 图片裁剪区域的高度,支持像素值(如"100px")、百分比(如"50%")、自动计算(如"auto",即从top位置到图片下边界的高度);默认值为"auto"

success 返回参数说明:

参数名 类型 说明
target string 图片相对路径,"_www/thrial.png"
size string 图片压缩之后的大小
width string 图片压缩之后的宽
height string 图片压缩之后的高
Last Updated: 6/22/2022, 6:14:45 PM