openplatform

工具 API

JSSDK 更新于 2026-08-28 阅读 7

自定义分享

share

蓝信版本: ios: >6.5.0 android: >6.5.0 windows: >6.6.110 mac: >6.6.202

示例代码

lx.utils.share({
  title: "String",
  content: "String",
  url: "String",
  pcUrl: "String",
  image: "String",
});

参数说明

字段 类型 必填 说明
title String 分享标题
content String 分享内容
url String 分享 url 地址
pcUrl String 分享的 pc 端地址
image String 分享图片的 URL 地址

上传文件至第三方服务

uploadFile

蓝信客户端会构造 http 请求,将文件二进制数据及附带参数发送至第三方服务

蓝信版本: ios: >6.6.85 android: >6.6.88 windows: >=7.32.30 mac: >6.6.202

示例代码

lx.utils.uploadFile({
  url: "String",
  localId: "String",
  name: "String",
  headers: {},
  formData: {},
});

参数说明

字段 类型 必填 说明
url String 第三方服务完整 url,如http://example-domain.com/uploadPath
localId String 需上传文件的本地 id
name String 文件唯一标识
headers Object HTTP 请求 Header,header 中不能设置 Referer
formData Object HTTP 请求中其他附带参数

SUCCESS 返回值说明

字段 类型 说明
responseBody String 开发者服务器返回的数据
statusCode Number 开发者服务器返回的 HTTP 状态码

errorCode 说明

code 值 message 值 说明
-6 CLIENT_INTERNAL_ERROR 客户端内部错误,发起请求失败
-8 NOT_EXIST 本地资源文件不存在

文件上传至 S3 存储服务

uploadFileToS3

蓝信版本: ios: >6.6.45 android: >6.6.45 windows: >6.6.110 mac: >6.6.202

示例代码

lx.utils.uploadFileToS3({
  localId: "String",
  endpoint: "String",
  accessKey: "String",
  secretKey: "String",
  sessionToken: "String",
  region: "String",
  bucket: "String",
  object: "String",
});

参数说明

字段 类型 必填 说明
localId String 本地文件 id
endpoint String S3 接入点 Url
accessKey String S3 accessKey
secretKey String S3 secretKey
sessionToken String S3 sessionToken
region String S3 region
bucket String S3 bucket
object String S3 object

errorCode 说明

code 值 message 值 说明
-8 NOT_EXIST 本地资源文件不存在
90031 UPLOAD_FAILED 文件上传失败

文件分片上传至 S3 存储服务

uploadFileToS3InChunks

蓝信版本: ios: >=7.12.30 android: >=7.12.30 windows: >=7.32.30 mac: >=7.32.30

示例代码

lx.utils.uploadFileToS3InChunks({
  localId: "String",
  endpoint: "String",
  accessKey: "String",
  secretKey: "String",
  sessionToken: "String",
  region: "String",
  bucket: "String",
  object: "String",
  chunkSize: 1024,
  maxChunkSize: 2048,
  maxChunkNumber: 20,
});

参数说明

字段 类型 必填 说明
localId String 本地文件 id
endpoint String S3 接入点 Url
accessKey String S3 accessKey
secretKey String S3 secretKey
sessionToken String S3 sessionToken
region String S3 region
bucket String S3 bucket
object String S3 object
chunkSize Number 每片上传的期望字节大小,单位 byte
maxChunkSize Number 每片允许上传的最大限制,单位 byte
maxChunkNumber Number 上传允许的最大分片数量

errorCode 说明

code 值 message 值 说明
-1 INVALID_REQUEST 请求参数不合法
-8 NOT_EXIST 本地资源文件不存在
90031 UPLOAD_FAILED 文件上传失败

将文件下载到本地

downloadFile

蓝信版本: ios: >6.6.45 android: >6.6.45 windows: >6.6.110 mac: >6.6.202

示例代码

lx.utils.downloadFile({
  url: "String",
  success: function (res) {
    /**
    {
      localId: 'string' //文件下载后的本地id
    }
    */
  },
  fail: function (err) {},
});

参数说明

字段 类型 必填 说明
url String 文件的 url 地址

SUCCESS 返回值说明

字段 类型 说明
localId String 文件下载后的本地 id,用于文件预览,音频播放,图片查看等

errorCode 说明

code 值 message 值 说明
-8 NOT_EXIST 下载文件不存在
90041 DOWNLOAD_FAILED 下载文件失败

文件预览

previewFile 对于 Android,如果 url 中 hostName,文件名称,文件大小,文件类型一致,则认为是同一个文件

蓝信版本: ios: >6.6.45 android: >6.6.45 windows: 不支持 mac: 不支持

示例代码

lx.utils.previewFile({
  url: "String",
  name: "String",
  size: 1000,
  type: "String",
  moreHidden: false
});

参数说明

字段 类型 必填 说明
url String 文件 URL,或文件选择/下载后的 localId,或 mediaId(服务端 API 返回)
name String 需要预览文件的文件名(不填的话取 url 的最后部分)
size Number 需要预览文件的大小,单位 B
type String 需要预览文件的后缀
moreHidden Boolean 是否隐藏文件预览的右上角更多按钮,默认 false

errorCode 说明

code 值 message 值 说明
-3 SERVER_INTERNAL_ERROR 服务器内部错误
-8 NOT_EXIST 资源文件不存在

保存文件

saveFile

保存文件,mac 端为唤起文件保存窗口,windows 端为直接保存到本地磁盘

蓝信版本: ios: 不支持 android: 不支持 windows: >6.6.110 mac: >6.6.202

示例代码

lx.utils.saveFile({
  url: "String",
  target: ["local", "cloud"],
});

参数说明

字段 类型 必填 说明
url String 文件 URL,或文件选择/下载后的 localId
target Array 文件保存位置,local 本地,cloud 云盘,默认为两者都可选

监听文件上传进度

onUploadProgress

监听文件上传进度

蓝信版本: ios: >6.6.45 android: >6.6.45 windows: >6.6.110 mac: >6.6.202

示例代码

lx.utils.onUploadProgress((result) => {});

result 说明

字段 类型 说明
localId String 文件下载后的本地 id,用于文件预览,音频播放,图片查看等
total Number 文件总大小,单位 B
loaded Number 已上传大小,单位 B

监听文件下载进度

onDownloadProgress

监听文件下载进度

蓝信版本: ios: >6.6.45 android: >6.6.45 windows: >6.6.110 mac: >6.6.202

示例代码

lx.utils.onDownloadProgress((result) => {});

result 说明

字段 类型 说明
localId String 文件本地 id
total Number 文件总大小,单位 B
loaded Number 已下载大小,单位 B

基于第三方 SDK 提供本地文件签批功能

signFile

基于第三方 SDK 提供本地文件签批功能

蓝信版本: ios: 不支持 android: >7.0.75 windows: 不支持 mac: 不支持

应用实现文件的签批流程: 1、应用调用 utils.downloadFile 接口,将 url 文件下载到本地 2、传入 1 中的 localId 调用 utils.signFile 接口完成签批功能 3、传入 2 中的 localId 调用 utils.uploadFileToS3 或 utils.uploadFile 完成上传

示例代码

lx.utils.signFile({
  platform: 'OFD',
  url: 'local://xxxx',
  mode: 'viewer'
  permissions: ['read','review']
})

参数说明

字段 类型 必填 说明
platform String 使用的签批平台[OFD]
url String 文件下载后的 localId; L 安卓仅支持 OFD 格式文件
mode String 进入的模式[viewer、editor]
permissions Array 允许的权限[read、review、approve]。; 1、当模式为 viewer 时; (1)当权限为[read]时,只有查看功能; (2)当权限为[read、review]时,显示查阅按钮功能; (3)当权限为[read、approve]时,显示批阅按钮功能; 2、当模式为 editer 时; (1)当权限为[read、approve]时,显示批阅功能

SUCCESS 返回值说明

字段 类型 说明
localId String 签批完成后的本地文件 ID

errorCode 说明

code 值 message 值 说明
0 OK 成功; permissions 备注的场景
-7 CANCEL 取消
90 UNSUPPORT FORMAT TYPES 不支持的文件格式
91 INVALID PERMISSION 无效的权限或权限不合法