Skip to content
文档目录

Interface: QysUKeySdkConfig

Implemented by

Table of contents

Properties

Properties

autoAddAnnotation

• autoAddAnnotation: boolean

盖章时自动添加批注


autoAddTimestampFormat

• autoAddTimestampFormat: TimestampFormatType

自动带出时间戳


cMapUrl

• Optional cMapUrl: string

pdfjs 中文字体包地址


canSign

• canSign: boolean

控制是否可以签署


enablePasswordFree

• enablePasswordFree: boolean

允许免密签署


errorCb

• Optional errorCb: (error: string, type: "error" | "warn") => unknown

Type declaration

▸ (error, type): unknown

覆盖错误提示: 默认为 antd 提示样式

Parameters
NameType
errorstring
type"error" | "warn"
Returns

unknown


file

• Optional file: CustomFileData | File | FileList | CustomFileData[]

初始渲染需要添加到文件列表中的文件,初始渲染后会将其从 config 中移除


fontMaps

• fontMaps: { cmapUrl?: string ; fontName: string }[]

字体设置


hideDocThumbnail

• hideDocThumbnail: boolean

页面渲染后是否隐藏缩略图: 默认不隐藏


hideThirdBtnFn

• hideThirdBtnFn: () => void

Type declaration

▸ (): void

Returns

void


showAddBtn

• showAddBtn: boolean

配置页面是否展示添加签章按钮


showSaveBtn

• showSaveBtn: boolean

配置页面是否展示保存按钮


showThirdBtnFn

• showThirdBtnFn: () => void

Type declaration

▸ (): void

Returns

void


signCb

• signCb: (data: FileDescriptor[]) => unknown

Type declaration

▸ (data): unknown

签署后的回调函数

Parameters
NameTypeDescription
dataFileDescriptor[]文件描述对象列表
Returns

unknown


signDevice

• Optional signDevice: SignDeviceConfig

指定用于签署的设备信息,可选参数。

属性类型说明
deviceIdstringUkey 设备号,只能使用指定的 Ukey 进行签署。
sealNamesstring[]仅支持 PC;按章面名称指定该设备可用于签署的章面,未配置时允许使用该设备的所有章面。

signFileMaxSize

• Optional signFileMaxSize: number

签署文件的最大值,默认为 50MB (50 * 1024 * 1024),设置过大可能会导致浏览器崩溃


wsOptions

• Optional wsOptions: Object

UKey 连接的 websocket 地址,默认不需要改动

Type declaration

NameType
urlstring