BlueInk Embed JS

Class: BlueInkEmbed

BlueInkEmbed

Class that helps create and manage embedded signing iFrames powered by BlueInk.

new BlueInkEmbed(publicAPIKey)

Create a new BlueInkEmbed instance, which you can use to mount and unmount embedded signing iFrames.
Parameters:
Name Type Description
publicAPIKey string the public API key for your BlueInk API App. This can be obtained by logging into your BlueInk Dashboard, or via the BlueInk API at /account/
Source:

Extends

  • EventEmitter

Members

iFrameEl

Source:

Methods

mount(container, embeddedSigningURL, options)

Parameters:
Name Type Default Description
container string body the css selector of the container into which the embedded signing iFrame will be injected
embeddedSigningURL string the embedded signing URL, as returned by an API call to /packets//embed_url/
options object optional arguments
Properties
Name Type Description
debug boolean if true, additional information will be printed to the console and displayed in the iFrame (if there is an error)
isTest boolean set to true when testing in a development environment (or locally), to turn off verification of the referring domain. This is only valid for embedded signing of test Bundles (which were created with is_test set to true)
locale string set the initial language / locale for the embedded signature iFrame
redirectURL string If provided, the parent page (not the iFrame) will be redirected to this URL upon successful completion of a signing
replace string If true, the signing iFrame replaces the contents of container, instead of being appended to the contents
Source:
Throws:
when (1) there is already a mounted BlueInkEmbed iFrame instance, (2) the container element does not exist, or (3) the container selector corresponds to more than one element.
Type
BlueInkEmbedError

unmount()

Remove the BlueInk eSignature iFrame. If there is no iFrame (ie, mount(...) was not called previously), this is a noop.
Source:

Type Definitions

eventCallback(eventData)

A callback function that will be invoked with event data.
Parameters:
Name Type Description
eventData EventAnyData | EventErrorData | null depending on the event type
Source: