Skip to content

chooseFile

描述

选择本地文件。

网页应用需要完成鉴权后调用该接口。

支持说明

客户端平台WPS协作版本要求
iOS>=2.15.0
Android>=2.15.0

输入

名称数据类型是否必填描述
paramsobject
∟ allowMultipleboolean是否多选,主要取决于系统的支持,推荐先使用 false
默认值:false
∟ mimeTypearray<string>仅显示指定类型文件
类型参考 Multipurpose Internet Mail Extensions
默认为空,显示所有类型文件
∟ sourceTypearray<string>指定文件来源
可选值:
["album"]:相册
["camera"]:相机
["file"]:系统文件选择器
["camera","album","file"]:相册或相机,不分顺序
默认值:["camera","album","file"]
注意:iOS 5.26.0 版本之后支持
onSuccessFunction
onErrorFunction

输出

名称类型描述
fileInfosarray<object>文件信息列表
∟ fileNamestring文件名称
∟ filePathstring文件路径,如:"ksoxz://temp/e1f7c67d89ef4da69337ce35e66e2e04"
注意:该路径为映射值非设备真实路径,得到该路径时,一般配合其他接口的路径参数使用,如上传文件接口,可以传该路径返回作为路径参数。
∟ fileSizenumber图片大小,单位byte
∟ sha1string文件的 SHA1 哈希值
5.25.0 及以上版本支持
∟ sha256string文件的 SHA256 哈希值
5.25.0 及以上版本支持

示例代码

ts
const params = {
  allowMutiple: false,
}
window.ksoxz_sdk.chooseFile({params,onSuccess,onError})

错误码

errnomsg含义
1021006Storage-Access permission not obtained用户未授予 App 文件写入权限(Android 特有)
1041001user canceled用户取消操作
1021003Camera permission not obtained用户未授予 App 相机权限( iOS 特有)
1021004Album permission not obtained用户未授予 App 相册权限(iOS 特有)

除以上错误外,还可能存在公共错误,参考:公共错误码