SDK Classes and Methods

DottedSignEmbeddedSign

DottedSignEmbeddedSign is the foundation class used to interact with the core functionalities of the SDK. While the specific details of the class might vary depending on the SDK version, the responsibilities of DottedSignEmbeddedSign mainly includes:

  • Initialization: Initialize DottedSign Embedded Signing.
  • Session Management: Methods for creating, managing, and closing embedded signing sessions.
  • Customization: Methods for customizing the signing interface, such as adjusting layout options.

Members

elementsId

Includes element IDs for multiple UI components, see SDK Constants for more details.

embedTypes

Includes session management embeddeding actions, see SDK Constants for more details.

eventListener

A collection of callbacks for the embedded signing interface.

Methods

close()

Closes the embedded signing interface iframe.

hideElement(id)

Hides an element by its elementsId.

ParameterTypeDescription
idConstants.ELEMENTS_IDIdentifier for the target element to hide.

Example:

dottedSign.hideElement(dottedSign.elementsId.createLabels);

open(domElement, options)

Initializes and appends an iframe to a target DOM element using specified authentication parameters.

Parameters:

ParameterTypeDescription
domElementHTMLElementThe target DOM element where the iframe will be appended.
optionsObjectConfiguration options required for initializing the iframe.

Options:

ParameterTypeDescription
tokenStringAccess token that is authorized to use DottedSign Embedded Signing.
typeConstants.EMBED_TYPEThe embedType associated with the iframe.

Example:

dottedSign.open(element, {
  accessToken: token,
  type: dottedsign.embedTypes.create
});

setLanguage(language)

Changes the language of the interface.

NameTypeDescription
languageStringLanguage for the signing interface. Options: en, de, es, fr, it, ja, ko, zh-cn, zh-tw.

Example:

dottedsign.setLanguage("zh-tw");

EventListener

Methods

onCancel()

Invoked when task creation is canceled.

onCreate(id)

Invoked when a task is created.

ParameterTypeDescription
idNumberTask ID.

onLoad()

Invoked when the elements are fully loaded.