BlueInk Embed JS

Global

Members

<constant> EVENT :string

Event types that can be emitted by BlueInkEmbed. These can be accessed via the BlueInkEmbed class, e.g. BlueInkEmbed.EVENT.COMPLETE, etc.
Type:
  • string
Properties:
Name Type Default Description
ANY string any Any event occurred. Use this if you want to listen for all events with a single callback.
LOAD string load The initial load of the iFrame content is complete. Note, the documents may not yet be ready to sign.
READY string ready The documents are ready to sign.
COMPLETE string complete The signing is complete.
AUTH_FAIL string auth_fail Signer authentication failed.
AUTH_SUCCESS string auth_success Signer authentication succeeded. Note, this event is still fired if no authentication options were selected.
ERROR string error An error that prevents embedded signing from continuing.
Source:
Examples
embed = new BlueInkEmbed(myPublicAPIKey);

embed.on(BlueInkEmbed.EVENT.COMPLETE, () => {
  console.log('signing complete!');
});
embed.on(BlueInkEmbed.EVENT.ERROR, (eventData) => {
  console.log('Signing error occurred.');
  console.log(eventData.message);
});

Type Definitions

EventErrorData

An event payload for an error event
Type:
  • Object
Properties:
Name Type Description
message string A description of the error that occurred.
Source:

EventAnyData

An event payload for a signing event
Type:
  • Object
Properties:
Name Type Description
eventType string The type of the event. One of EVENT.COMPLETE, EVENT.READY, etc.
eventData EventErrorData | null Additional data for the event, or {}.
Source: