# 文件

# 上传文件

# 使用说明

Android iOS PC 是否需要鉴权
支持 支持 支持 不需要

# 参数说明

参数 参数类型 必传 说明
image Object
image[multiple] Boolean 是否多选,默认为false
image[compress] Boolean 是否压缩,默认为true
image[max] Number 最多选择的图片数目,最多支持9张
file Object
file[max] Number 最多选择的图片数目,最多支持9张
types Array 支持上传附件的文件类型,至少一个,最多支持四种类型,photo、camera、file

# 返回说明

若上传取消,则返回-1

参数 参数类型 说明
count Number 上传文件数量
data Object 上传返回内容
data[fileUrl] String 文件地址
data[fileId] String 文件 id
data[fileName] String 文件名称
data[fileSize] String 文件大小
data[fileType] String 文件类型
ext Object 额外信息
ext[width] Number 图片宽度
ext[height] Number 图片高度
// 全量引入调用方式
yy.biz.util.uploadAttachment({
  image: {
    multiple: true,
    compress: false,
    max: 9,
  },
  file: {
    multiple: true,
    compress: false,
    max: 30,
  },
  types: ["photo", "file"],
  onSuccess: function (result) {
    /*
      true
    */
  },
  onFail: function () {},
});

// 按需加载调用方式,参数与全量引入相同
uploadAttachment({...});

# 调试

biz.util.uploadAttachment

# 下载文件

# 使用说明

Android iOS PC 是否需要鉴权
不支持 不支持 支持 不需要

# 参数说明

参数 参数类型 必传 说明
url string 要下载的文件的url
name string 定义下载文件名字

# 返回说明

// 全量引入调用方式
yy.biz.util.downloadFile({
  url:
    "http://static.dingtalk.com/media/lADOADTWJM0C2M0C7A_748_728.jpg_60x60q90.jpg", //要下载的文件的url
  name: "一个图片.jpg", //定义下载文件名字
  onProgress: function (msg) {
    // 文件下载进度回调
  },
  onSuccess: function (result) {
    /*
          true
        */
  },
  onFail: function () {},
});

// 按需加载调用方式,参数与全量引入相同
downloadFile({...});

# 调试

biz.util.downloadFile

# 文件预览

PDF 预览,目前仅支持https://yach-static.zhiyinlou.com下的资源预览

# 使用说明

Android iOS PC 是否需要鉴权
支持 支持 支持 v3.1.0 增加type字段 不需要

# 返回说明

// 全量引入调用方式
yy.biz.util.previewFile({
    type: '文件类型',  
    file: '文件url',
    size: '文件大小',
  	name:'文件名'
    onSuccess : function(result) {
    },
    onFail : function() {}
})

// 按需加载调用方式,参数与全量引入相同
previewFile({...});

# 调试

biz.util.previewFile

# 上传剪贴板内文件 v1.1.3

# 使用说明

Android iOS PC 是否需要鉴权
不支持 不支持 支持 不需要

# 返回说明

// 全量引入调用方式
yy.biz.util.clipboardFileUpload({
  onSuccess: function (result) {
    /*
      true
    */
  },
  onFail: function () {},
});

// 按需加载调用方式,参数与全量引入相同
clipboardFileUpload({...});

# 调试

biz.util.clipboardFileUpload

# 图片预览

# 使用说明

调用此 api,将进行预览图片。

Android iOS PC 是否需要鉴权
支持 支持 支持 不需要
// 全量引入调用方式
yy.biz.util.previewImage({
  urls: [String], //图片地址列表
  current: String, //当前显示的图片链接
  onSuccess: function (result) {
    /**/
  },
  onFail: function (err) {}
});

// 按需加载调用方式,参数与全量引入相同
previewImage({...});

# 参数说明

参数 参数类型 必传 说明
urls Array[String]
图片地址列表
current String
当前显示的图片链接

# 返回说明

# 调试

biz.util.previewImage
上次更新: 7/30/2020, 10:36:17 PM
foo