Appearance
@qys/ukey-sign-sdk
Table of contents
Classes
Interfaces
- AuthorizedMobileCertificate
- CustomFileData
- MobileAuthorizationTask
- MobileCertificatePlacement
- MobileCertificateState
- QysUKeySdkConfig
Type Aliases
- MobileAuthorizationStatus
- MobileCertificateAvailability
- MobileSigningResult
- PcSigningSource
- QYS_SDK_INNER_EVENTS
- QysUKeyConfigParams
- SigningIdentity
- StamperType
Type Aliases
MobileAuthorizationStatus
Ƭ MobileAuthorizationStatus: "TO_BE_SCAN" | "TO_BE_SIGN" | "SIGNING" | "FINISHED" | "QR_INVALID" | "AUTHORIZE_TIMEOUT" | "AUTHORIZE_CLOSE"
远端授权状态；SIGNING 表示已授权，尚不代表 PDF 签署完成。
MobileCertificateAvailability
Ƭ MobileCertificateAvailability: { available: true } | { available: false ; error: MobileCertificateError }
能力检查结果区分服务不可用与操作失败。
MobileSigningResult
Ƭ MobileSigningResult: { signedFiles: FileDescriptor[] ; status: "success" } | { error: MobileCertificateError ; failedFile: FileDescriptor ; signedFiles: FileDescriptor[] ; status: "failed" }
明确的批量签署结果；失败文件不会被标记为已保存。
PcSigningSource
Ƭ PcSigningSource: { type: "UKEY" } | { type: "MOBILE_CERTIFICATE" }
PC 签署入口的选择独立于浏览器和设备平台检测。
QYS_SDK_INNER_EVENTS
Ƭ QYS_SDK_INNER_EVENTS: Object
Type declaration
| Name | Type | Description |
|---|---|---|
ADD_FILE | FileList | CustomFileData[] | File | CustomFileData | 内部调用：增加文档 |
ADD_STAMPER | StamperType | 内部调用：添加签名 |
APP_MOUNTED | void | 内部调用：页面挂载通知 |
CURRENT_FILE_CHANGE | FileDescriptor | null | 当前文件发生变化（仅在切换为其他文件时变化，文件内容的修改不会触发） |
FILE_LIST_CHANGE | FileDescriptor[] | 文件列表发生变化 |
REMOVE_DOCUMENT | string | 内部调用：移除文档 |
SIGNING_SOURCE_CHANGE | PcSigningSource | PC 端签署方式变化，供签章面板同步选项。 |
SIGN_PDF | void | 内部调用：保存签名 |
SWITCH_DOCUMENT | string | 内部调用：切换文档 |
QysUKeyConfigParams
Ƭ QysUKeyConfigParams: Partial<QysUKeySdkConfig>
SigningIdentity
Ƭ SigningIdentity: { kind: "UKEY" ; sn: string } | { kind: "MOBILE_CERTIFICATE" ; sealId: string }
标识有权提交未保存印章的签署身份。
StamperType
Ƭ StamperType: "SEAL_CORPORATE" | "ACROSS_PAGE" | "TIMESTAMP" | "ANNOTATION"