Appearance
SDK 通用设置
本节介绍页面展示、签署开关、文件限制与结果回调等通用设置。具体的插入 Ukey、PIN 验证或手机扫码操作，分别见 Ukey签章和移动签章。
创建实例时配置
完成快速上手中的 SDK 引入后，通过构造函数传入所需设置：
typescript
/** 两种签章方式共用的页面配置和结果回调。 */
const sdk = new QysUKeySdk({
canSign: true,
showSaveBtn: true,
hideDocThumbnail: true,
signFileMaxSize: 50 * 1024 * 1024,
signCb(files) {
files.forEach(file => {
console.info('已签署文件：', file.filename, file.rawFileData);
});
},
errorCb(message, type) {
console.error(type, message);
},
});
| 配置项 | 默认值 | 使用说明 |
|---|---|---|
canSign | true | 是否允许签署；设为 false 时禁止签章操作。 |
showSaveBtn | true | 是否展示页面头部“保存”按钮；隐藏后可由业务按钮调用 sdk.signPdf()。 |
hideDocThumbnail | false | 初始化页面时是否隐藏缩略图面板，后续仍可由用户手动打开。 |
autoAddAnnotation | false | 在 PC 页面放置新的普通章时自动打开批注编辑面板，并在章面工具栏提供“批注”入口，详见批注。 |
signFileMaxSize | 50 * 1024 * 1024 | 单个签署文件的大小上限，单位为字节。 |
file | 未设置 | 初始化时加载的文件，也可在页面渲染后调用 addFile() 加载。 |
signCb | 无业务处理 | 接收本批次成功签署的文件数组，文件的 rawFileData 为签署后的 PDF 字节。 |
errorCb | 使用内置提示 | 接收错误或警告文案及 error／warn 类型，便于接入业务系统自己的提示。 |
完整参数类型见 QysUKeySdkConfig。Ukey 的指定设备、指定章面与免密验证属于签章方式专属配置。
更新配置
使用 sdk.updateConfig() 更新当前实例配置：
typescript
/** 将当前页面切换为禁止签署，并隐藏内置保存按钮。 */
sdk.updateConfig({ canSign: false, showSaveBtn: false });
updateConfig() 也会将新配置同步到已挂载的页面。设置初始化文件、页面容器及重新渲染的用法见签章页面的渲染与卸载。
按通用能力继续接入
- 签章页面的渲染与卸载：设置容器、渲染页面及释放实例。
- SDK 与签章页面的交互：监听文件列表和当前文件变化。
- SDK 中的文件操作：加载、切换、保存、下载文件及获取验签结果。
- SDK 与签章页面工具栏的交互：控制缩略图、签章和验签工具。
- 自定义错误提示：替换内置提示。
- WebSocket 连接调试：调试本地签署驱动连接。
- 批注：开启普通章批注、编辑文字样式并随章面保存。