`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.

Parameter	Type	Description
`id`	`Constants.ELEMENTS_ID`	Identifier 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:

Parameter	Type	Description
`domElement`	`HTMLElement`	The target DOM element where the iframe will be appended.
`options`	`Object`	Configuration options required for initializing the iframe.

Options:

Parameter	Type	Description
`token`	`String`	Access token that is authorized to use DottedSign Embedded Signing.
`type`	`Constants.EMBED_TYPE`	The `embedType` associated with the iframe.
`templateId`	`String`	Optional. Only applicable when `type` is `CREATE`. Creates the task directly from the specified template.
`draftId`	`String`	Optional. Only applicable when `type` is `DRAFT`. The draft to continue task creation from.
`fileMergeMissionId`	`Number`	Optional. Only applicable when `type` is `CREATE`. ID of a file merge mission that has finished uploading and has `status: completed`. When provided, the files from that mission are automatically downloaded and applied to the create flow, so users don't need to select files manually. Takes precedence over `templateId` if both are provided. If the mission was created from multiple files, only the merged single file is shown; the individual source files are not displayed separately.

Example:

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

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

`setLanguage(language)`

Changes the language of the interface.

Name	Type	Description
`language`	`String`	Language 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.

Parameter	Type	Description
`id`	`Number`	Task ID.

`onLoad()`

Invoked when the elements are fully loaded.