SDK Classes and Methods
DottedSignEmbeddedSign
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
elementsId
Includes element IDs for multiple UI components, see SDK Constants for more details.
embedTypes
embedTypes
Includes session management embeddeding actions, see SDK Constants for more details.
eventListener
eventListener
A collection of callbacks for the embedded signing interface.
Methods
close()
close()
Closes the embedded signing interface iframe.
hideElement(id)
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)
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. |
Example:
dottedSign.open(element, {
accessToken: token,
type: dottedsign.embedTypes.create
});
setLanguage(language)
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
EventListener
Methods
onCancel()
onCancel()
Invoked when task creation is canceled.
onCreate(id)
onCreate(id)
Invoked when a task is created.
Parameter | Type | Description |
---|---|---|
id | Number | Task ID. |
onLoad()
onLoad()
Invoked when the elements are fully loaded.
Updated 4 months ago