Class MobileClient

document: { content: string; filename?: string }

• content: string

  Description

  Base64 encrypted content of the document

  Example

  ZXhhbXBsZSBzdHJpbmcgaW4gYmFzZTY0Cg==
  Copy

• Optionalfilename?: string

  Description

  Filename of the document. payloadMimeType must be provided if empty. Also, if payloadMimeType is empty, filename must be provided and mimetype must be understood from extension.

  Example

  sample_document.txt
  Copy

Optionalparameters?: {
    autoLoadEform?: boolean;
    checkPDFACompliance?: boolean;
    container?: "ASiC-E" | "ASiC-S";
    containerXmlns?: "http://data.gov.sk/def/container/xmldatacontainer+xml/1.1";
    digestAlgorithm?: "SHA256" | "SHA384" | "SHA512";
    embedUsedSchemas?: boolean;
    en319132?: boolean;
    identifier?: string;
    infoCanonicalization?:
        | "INCLUSIVE"
        | "EXCLUSIVE"
        | "INCLUSIVE_WITH_COMMENTS"
        | "EXCLUSIVE_WITH_COMMENTS"
        | "INCLUSIVE_11"
        | "INCLUSIVE_11_WITH_COMMENTS";
    keyInfoCanonicalization?: | "INCLUSIVE"
    | "EXCLUSIVE"
    | "INCLUSIVE_WITH_COMMENTS"
    | "EXCLUSIVE_WITH_COMMENTS"
    | "INCLUSIVE_11"
    | "INCLUSIVE_11_WITH_COMMENTS";
    level?: | "XAdES_BASELINE_B"
    | "PAdES_BASELINE_B"
    | "CAdES_BASELINE_B"
    | "XAdES_BASELINE_T"
    | "PAdES_BASELINE_T"
    | "CAdES_BASELINE_T";
    packaging?: "ENVELOPED"
    | "ENVELOPING";
    propertiesCanonicalization?:
        | "INCLUSIVE"
        | "EXCLUSIVE"
        | "INCLUSIVE_WITH_COMMENTS"
        | "EXCLUSIVE_WITH_COMMENTS"
        | "INCLUSIVE_11"
        | "INCLUSIVE_11_WITH_COMMENTS";
    schema?: string;
    schemaIdentifier?: string;
    transformation?: string;
    transformationIdentifier?: string;
    transformationLanguage?: string;
    transformationMediaDestinationTypeDescription?: "XHTML"
    | "HTML"
    | "TXT";
    transformationTargetEnvironment?: string;
}

• OptionalautoLoadEform?: boolean

  Description

  Try to find XSD and XSLT for a given eForm and load them automatically. Useful for visualizing and signing eForms. If true, schema, transformation, conatinerXmlns, container, packaging, and identifier parameters are ignored. If resources are not found, the response is 422. If provided document is an ASiC_E container conatining XML Datacontainer or it is an XML Datacontainer itself, XSLT found is used for visualiztion of signing document. Also, XSD and XSLT hashes are compared with hashes of XSD and XSLT found in XML Data Container EForm. If they differ, the response is 422. If the provided document is an XML document, Autogram will try to parse xmlns from root element and find resources based on its value. If successful, XML Datacontainer with xmls="http://data.gov.sk/def/container/xmldatacontainer+xml/1.1" is created, the document is validated against the XSD and visualized using the XSLT. If XSD validation fails, the response is 422. The XSLT transformation is found based on transformationLanguage (defaults to user preferred), transformationMediaDestinationTypeDescription (default XHTML, then HTML, then TXT), and transformationTargetEnvironment. If multiple transformations meet the criteria, the first one found is used.

  Default

  false
  Copy

• OptionalcheckPDFACompliance?: boolean

  Description

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

  Default

  false
  Copy

• Optionalcontainer?: "ASiC-E" | "ASiC-S"

  Description

  Type of Advanced Signature Container. Defaults to null - no container.

  Example

  ASiC-E
  @enum {string}
  Copy

• OptionalcontainerXmlns?: "http://data.gov.sk/def/container/xmldatacontainer+xml/1.1"

  Description

  XML namespace for the XML Datacontainer. Specifies if xmldatacontainer should be created from XML. Doesn't create xmldatacontainer if payloadMimeType is application/vnd.gov.sk.xmldatacontainer+xml already. Accepts http://data.gov.sk/def/container/xmldatacontainer+xml/1.1 only. Defaults to null. Is ignored with autoLoadEform true.

  Example

  http://data.gov.sk/def/container/xmldatacontainer+xml/1.1
  @enum {string}
  Copy

• OptionaldigestAlgorithm?: "SHA256" | "SHA384" | "SHA512"

  Description

  Optional algorithm used to calculate digests.

  Default

  SHA256
  @enum {string}
  Copy

• OptionalembedUsedSchemas?: boolean

  Description

  When creating XML Datacontainer, parameter indicates whether to embed XSD and XML or reference them. Practically this should be only used for ORSR EForms in which case (when identifier contains "justice.gov.sk/Forms") this parameter is overridden to true.

  Example

  false
  Copy

• 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
  Copy

• Optionalidentifier?: string

  Description

  Optional identifier of the document template. Required if containerXmlns is http://data.gov.sk/def/container/xmldatacontainer+xml/1.1. Defaults to null. Is ignored with autoLoadEform true.

  Example

  https://data.gov.sk/id/egov/eform/App.GeneralAgenda/1.9
  Copy

• OptionalinfoCanonicalization?:
      | "INCLUSIVE"
      | "EXCLUSIVE"
      | "INCLUSIVE_WITH_COMMENTS"
      | "EXCLUSIVE_WITH_COMMENTS"
      | "INCLUSIVE_11"
      | "INCLUSIVE_11_WITH_COMMENTS"

  Description

  Optional info canonicalization method.

  Default

  INCLUSIVE
  @enum {string}
  Copy

• OptionalkeyInfoCanonicalization?:
      | "INCLUSIVE"
      | "EXCLUSIVE"
      | "INCLUSIVE_WITH_COMMENTS"
      | "EXCLUSIVE_WITH_COMMENTS"
      | "INCLUSIVE_11"
      | "INCLUSIVE_11_WITH_COMMENTS"

  Description

  Optional key info canonicalization method.

  Default

  INCLUSIVE
  @enum {string}
  Copy

• Optionallevel?:
      | "XAdES_BASELINE_B"
      | "PAdES_BASELINE_B"
      | "CAdES_BASELINE_B"
      | "XAdES_BASELINE_T"
      | "PAdES_BASELINE_T"
      | "CAdES_BASELINE_T"

  Description

  Signature level.

  Example

  XAdES_BASELINE_B
  @enum {string}
  Copy

• Optionalpackaging?: "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. Is ignored with autoLoadEform true.

  Default

  ENVELOPED
  @enum {string}
  Copy

• OptionalpropertiesCanonicalization?:
      | "INCLUSIVE"
      | "EXCLUSIVE"
      | "INCLUSIVE_WITH_COMMENTS"
      | "EXCLUSIVE_WITH_COMMENTS"
      | "INCLUSIVE_11"
      | "INCLUSIVE_11_WITH_COMMENTS"

  Description

  Optional properties canonicalization method.

  Default

  INCLUSIVE
  @enum {string}
  Copy

• Optionalschema?: string

  Description

  Optional XML schema used to validate the signing document and to compute digest used in "UsedXSDReference" in "DigestValue" attribute inside created XML Datacontainer. Format (plaintext or base64) is dictated by payloadMimeType. Is ignored with autoLoadEform true.

  Example

  <?xml version="1.0"?><xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name="Document"><xs:complexType><xs:sequence><xs:element name="Title" type="xs:string" /></xs:sequence></xs:complexType></xs:element></xs:schema>
  Copy

• OptionalschemaIdentifier?: string

  Description

  Optional identifier of the XML schema. The value is used in "UsedXSDReference" field inside created XML Datacontainer. If provided with autoLoadEform true, Autogram will try to find such schema. Default value is "http://schemas.gov.sk/form///form.xsd".

  Example

  http://schemas.gov.sk/form/App.GeneralAgenda/1.9/form.xsd
  Copy

• Optionaltransformation?: string

  Description

  Optional XML transformation used to present the signing document to user and to compute digest used in "UsedPresentationSchemaReference" in "DigestValue" attribute inside created XML Datacontainer. Format (plaintext or base64) is dictated by payloadMimeType. Is ignored with autoLoadEform true.

  Example

  <?xml version="1.0"?><xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"><xsl:template match = "/"><h1><xsl:value-of select="/Document/Title"/></h1></xsl:template></xsl:stylesheet>
  Copy

• OptionaltransformationIdentifier?: string

  Description

  Optional identifier of the XML transformation. If provided with autoLoadEform true, Autogram will try to find such transformation. Default value is "http://schemas.gov.sk/form///form.xslt".

  Example

  http://schemas.gov.sk/form/App.GeneralAgenda/1.9/form.xslt
  Copy

• OptionaltransformationLanguage?: string

  Description

  Optional language of the XML transformation. If autoLoadEform is true, Autogram will try to find signing XSLT with this language. Otherwise transformation must be provided. Default value is user preferred or "sk".

  Example

  sk
  Copy

• OptionaltransformationMediaDestinationTypeDescription?: "XHTML" | "HTML" | "TXT"

  Description

  Optional media destination type description of the XML transformation. If autoLoadEform is true, Autogram will try to find signing XSLT with this type. Otherwise transformation must be provided. Overrides value of the output method in provided or auto-loaded transformation which is used by default.

  Example

  HTML
  @enum {string}
  Copy

• OptionaltransformationTargetEnvironment?: string

  Description

  Optional target environment of the XML transformation. If autoLoadEform is true, Autogram will try to find signing XSLT with this target. Otherwise transformation must be provided. Null and not used by default.

  Example

  example-value
  Copy

OptionalpayloadMimeType?: string

text/plain;base64
Copy

OptionalnotifyDevices?: boolean