Class DesktopClient

Constructors

constructor

Methods

endBatch launch sign signRequest startBatch stateType

Constructors

constructor

Methods

endBatch

  • endBatch(
        batchId: string,
        abortController?: AbortController,
    ): Promise<{ status?: "FINISHED" | "NOT_FINISHED" }>

    Parameters

    • batchId: string
    • OptionalabortController: AbortController

    Returns Promise<{ status?: "FINISHED" | "NOT_FINISHED" }>

launch

  • launch(
        abortController?: AbortController,
        onStateChange?: DesktopSigningStateConsumer,
        options?: { minimumAppVersion?: string },
    ): Promise<
        {
            availableDrivers?: (
                | "eid"
                | "cz_eid"
                | "secure_store"
                | "monet"
                | "gemalto"
                | "fake"
                | "keystore"
                | "custom_pkcs11"
            )[];
            features?: (
                | "CONTENT_TIMESTAMP"
                | "EXTERNAL_CONTENT_TIMESTAMP"
                | "TIMESTAMP"
                | "EN319132"
                | "BATCH_SIGN"
                | "PDF_A_CHECK"
                | "PDF_EMBEDDED_ATTACHMENTS_CHECK"
                | "SIGNING_CERTIFICATE_QUALIFIED_CHECK"
                | "PADES"
                | "PADES_VISUAL_SIGNATURE"
                | "CADES"
                | "XADES"
                | "ASICE"
                | "ASICE_MULTIPLE_DOCUMENTS"
                | "ASICS"
                | "AUTOLOAD_EFORMS"
                | "XDC_SIGN"
                | "XDC_VISUALIZE"
                | "XDC_CREATE"
                | "XDC_EMBEDDED_SIGN"
                | "XDC_EMBEDDED_VISUALIZE"
                | "XDC_EMBEDDED_CREATE"
                | "SIGNATURE_VALIDATION"
            )[];
            status?: "READY";
            version?: string;
        },
    >

    Makes sure Autogram is running (launching it if needed) and returns its info. With minimumAppVersion an older Autogram emits the appVersionTooLow state and throws AutogramAppVersionTooLowException.

    Parameters

    • OptionalabortController: AbortController
    • OptionalonStateChange: DesktopSigningStateConsumer
    • Optionaloptions: { minimumAppVersion?: string }

    Returns Promise<
        {
            availableDrivers?: (
                | "eid"
                | "cz_eid"
                | "secure_store"
                | "monet"
                | "gemalto"
                | "fake"
                | "keystore"
                | "custom_pkcs11"
            )[];
            features?: (
                | "CONTENT_TIMESTAMP"
                | "EXTERNAL_CONTENT_TIMESTAMP"
                | "TIMESTAMP"
                | "EN319132"
                | "BATCH_SIGN"
                | "PDF_A_CHECK"
                | "PDF_EMBEDDED_ATTACHMENTS_CHECK"
                | "SIGNING_CERTIFICATE_QUALIFIED_CHECK"
                | "PADES"
                | "PADES_VISUAL_SIGNATURE"
                | "CADES"
                | "XADES"
                | "ASICE"
                | "ASICE_MULTIPLE_DOCUMENTS"
                | "ASICS"
                | "AUTOLOAD_EFORMS"
                | "XDC_SIGN"
                | "XDC_VISUALIZE"
                | "XDC_CREATE"
                | "XDC_EMBEDDED_SIGN"
                | "XDC_EMBEDDED_VISUALIZE"
                | "XDC_EMBEDDED_CREATE"
                | "SIGNATURE_VALIDATION"
            )[];
            status?: "READY";
            version?: string;
        },
    >

sign

  • sign(
        documents: DocumentToSign | DocumentToSign[],
        parameters?: {
            checkPDFACompliance?: boolean;
            checkPDFEmbeddedAttachments?: boolean;
            container?: null | "ASiC_E";
            digestAlgorithm?: null | "SHA256" | "SHA384" | "SHA512";
            form?: null | "XAdES" | "PAdES" | "CAdES";
            infoCanonicalization?:
                | null
                | "INCLUSIVE"
                | "EXCLUSIVE"
                | "INCLUSIVE_WITH_COMMENTS"
                | "EXCLUSIVE_WITH_COMMENTS"
                | "INCLUSIVE_11"
                | "INCLUSIVE_11_WITH_COMMENTS";
            keyInfoCanonicalization?: | null
            | "INCLUSIVE"
            | "EXCLUSIVE"
            | "INCLUSIVE_WITH_COMMENTS"
            | "EXCLUSIVE_WITH_COMMENTS"
            | "INCLUSIVE_11"
            | "INCLUSIVE_11_WITH_COMMENTS";
            packaging?: null
            | "ENVELOPED"
            | "ENVELOPING";
            profile?: null | "BASELINE_B" | "BASELINE_T";
            propertiesCanonicalization?:
                | null
                | "INCLUSIVE"
                | "EXCLUSIVE"
                | "INCLUSIVE_WITH_COMMENTS"
                | "EXCLUSIVE_WITH_COMMENTS"
                | "INCLUSIVE_11"
                | "INCLUSIVE_11_WITH_COMMENTS";
        } & { en319132?: boolean; requireQualifiedCertificate?: boolean },
        options?: DesktopSignOptions,
    ): Promise<SignedDocumentResult>

    Signs one or more documents. Multiple documents are signed together into a single ASiC_E container ("spoločná autorizácia dokumentov").

    Autogram >= 2.8.0 is used via POST /api/v1/sign. Older versions fall back to the legacy POST /sign endpoint, which supports one document only – signing multiple documents (or requesting v1-only checks) with an older Autogram emits the appVersionTooLow state and throws AutogramAppVersionTooLowException (code app-version-too-low).

    Parameters

    • documents: DocumentToSign | DocumentToSign[]

      document(s) to sign, each with its own mimeType/encoding and optional xdcParameters

    • Optionalparameters: {
          checkPDFACompliance?: boolean;
          checkPDFEmbeddedAttachments?: boolean;
          container?: null | "ASiC_E";
          digestAlgorithm?: null | "SHA256" | "SHA384" | "SHA512";
          form?: null | "XAdES" | "PAdES" | "CAdES";
          infoCanonicalization?:
              | null
              | "INCLUSIVE"
              | "EXCLUSIVE"
              | "INCLUSIVE_WITH_COMMENTS"
              | "EXCLUSIVE_WITH_COMMENTS"
              | "INCLUSIVE_11"
              | "INCLUSIVE_11_WITH_COMMENTS";
          keyInfoCanonicalization?: | null
          | "INCLUSIVE"
          | "EXCLUSIVE"
          | "INCLUSIVE_WITH_COMMENTS"
          | "EXCLUSIVE_WITH_COMMENTS"
          | "INCLUSIVE_11"
          | "INCLUSIVE_11_WITH_COMMENTS";
          packaging?: null
          | "ENVELOPED"
          | "ENVELOPING";
          profile?: null | "BASELINE_B" | "BASELINE_T";
          propertiesCanonicalization?:
              | null
              | "INCLUSIVE"
              | "EXCLUSIVE"
              | "INCLUSIVE_WITH_COMMENTS"
              | "EXCLUSIVE_WITH_COMMENTS"
              | "INCLUSIVE_11"
              | "INCLUSIVE_11_WITH_COMMENTS";
      } & { en319132?: boolean; requireQualifiedCertificate?: boolean }
      • OptionalcheckPDFACompliance?: boolean

        Description

        Check for PDF/A compliance and show warning if not compliant.

        Default

        false
      • OptionalcheckPDFEmbeddedAttachments?: boolean

        Description

        Check for attachments embedded inside PDF file and show warning if any are found.

        Default

        false
      • Optionalcontainer?: null | "ASiC_E"

        Description

        Optional container type that should be used to place the file with signature to. Defaults to null. For a document with xdcParameters.autoLoadEform=true, this value can be overridden by the resolved eForm requirements.

        Example

        ASiC_E
        @enum {string}
      • OptionaldigestAlgorithm?: null | "SHA256" | "SHA384" | "SHA512"

        Description

        Optional algorithm used to calculate digests.

        Default

        SHA256
        @enum {string}
      • Optionalform?: null | "XAdES" | "PAdES" | "CAdES"

        Description

        Signature format. Format PAdES is usable only with documents of type application/pdf. Format XAdES is usable with XML or with any file type if using an ASiC container. Format is not required when signing already signed documents - PAdES or ASiC-E.

        Example

        XAdES
        @enum {string}
      • OptionalinfoCanonicalization?:
            | null
            | "INCLUSIVE"
            | "EXCLUSIVE"
            | "INCLUSIVE_WITH_COMMENTS"
            | "EXCLUSIVE_WITH_COMMENTS"
            | "INCLUSIVE_11"
            | "INCLUSIVE_11_WITH_COMMENTS"

        Description

        Optional info canonicalization method.

        Default

        INCLUSIVE
        @enum {string}
      • OptionalkeyInfoCanonicalization?:
            | null
            | "INCLUSIVE"
            | "EXCLUSIVE"
            | "INCLUSIVE_WITH_COMMENTS"
            | "EXCLUSIVE_WITH_COMMENTS"
            | "INCLUSIVE_11"
            | "INCLUSIVE_11_WITH_COMMENTS"

        Description

        Optional key info canonicalization method.

        Default

        INCLUSIVE
        @enum {string}
      • Optionalpackaging?: null | "ENVELOPED" | "ENVELOPING"

        Description

        Optional form of packaging used with XML. ENVELOPED adds the signature as a child of the root element while ENVELOPING wraps the XML in a new element. Only applies to XAdES signatures. Must be ENVELOPING when used without ASiC container and with non XML documents. For a document with xdcParameters.autoLoadEform=true, this value can be overridden by the resolved eForm requirements.

        Default

        ENVELOPED
        @enum {string}
      • Optionalprofile?: null | "BASELINE_B" | "BASELINE_T"

        Description

        Signature profile. If null, the BASELINE_B profile is used by default.

        Example

        BASELINE_B
        @enum {string}
      • OptionalpropertiesCanonicalization?:
            | null
            | "INCLUSIVE"
            | "EXCLUSIVE"
            | "INCLUSIVE_WITH_COMMENTS"
            | "EXCLUSIVE_WITH_COMMENTS"
            | "INCLUSIVE_11"
            | "INCLUSIVE_11_WITH_COMMENTS"

        Description

        Optional properties canonicalization method.

        Default

        INCLUSIVE
        @enum {string}
      • Optionalen319132?: boolean

        Description

        Optional flag to control whether the signature should be made according to ETSI EN 319132 for XAdES and ETSI EN 319122 for CAdES and PAdES.

        Default

        false
      • OptionalrequireQualifiedCertificate?: boolean

        Description

        Require the signing certificate to be qualified.

        Default

        false
    • Optionaloptions: DesktopSignOptions

    Returns Promise<SignedDocumentResult>

signRequest

startBatch

StaticstateType

Settings

Member Visibility

On This Page

Constructors
Methods