_ps.on('valid', function(){
  console.log(arguments);
  $('#button').prop('disabled', false);
});

Real-time events to interact with your own app

This reference documents the events that are triggered on the global _ps object. Events are triggered based on interactions with the Ironclad Clickwrap JavaScript library. Examples include when a user clicks all checkboxes (_ps.on('valid')), when acceptance is sent to Ironclad Clickwrap (_ps.on('sent')), or when an error occurs (_ps.on('error')). These callbacks are used to manage interactions so that the experience of plugging Ironclad Clickwrap into your own apps does not disrupt your own flows.

Events

all

A special event that is triggered when any other event is triggered. The name of the original event is always the first argument passed to the callback function. The rest of the arguments will match whatever arguments were passed to the original event's callback function.

_ps.on('all', callback);

Callback Arguments

ready

Triggered once ps.js has been loaded and the _ps object is setup.

_ps.on('ready', callback);

Callback Arguments

No Arguments

create

Triggered when a Site object is created.

_ps.on('create', callback);

Callback Arguments

sent

Triggered when a send command has been completed successfully.

_ps.on('sent', callback);

Callback Arguments

retrieved

Triggered when a retrieve command has been completed successfully.

_ps.on('retrieved', callback);

Callback Arguments

set

Triggered when a parameter is set.

Note: This event will only be triggered for specific parameters. Supported parameters include: signer_id, signer_id_selector, form_selector, position and always_visible.

_ps.on('set', callback);

Callback Arguments

set:parameter

Triggered when the named parameter is set.

Note: This event will only be triggered for specific parameters. Supported parameters include: signer_id, signer_id_selector, form_selector, position and always_visible.

_ps.on('set:[parameter]', callback);

Callback Arguments

Examples

// Listens for the signer_id parameter to be set.
_ps.on('set:signer_id', function(value, context) {
  console.log(value);
});

initialized

Triggered when a Group object is initialized and ready to use.

_ps.on('initialized', callback);

Callback Arguments

rendered

Triggered when a Group object has been rendered.

_ps.on('rendered', callback);

Callback Arguments

displayed

Triggered when a Group object displays a contract.

_ps.on('displayed', callback);

Callback Arguments

hidden

Triggered when a Group object hides a contract.

_ps.on('hidden', callback);

Callback Arguments

valid

Triggered when all of the contracts in a Group have been accepted by a signer.

Note: If a Group's display_all parameter is set to true, this event will only be triggered when all contracts have been accepted and checked.

_ps.on('valid', callback);

Callback Arguments

invalid

Triggered when all of the contracts in a Group are no longer accepted by a signer. This event will be triggered if a signer un-checks a contract on a valid Group.

_ps.on('invalid', callback);

Callback Arguments

scrolled:contract

Triggered when "Force Scroll" has been enabled in your Group Settings and one of the contracts in a Group has been scrolled to the bottom of a "Scroll" or "Embedded" Group style/layout.

_ps.on('scrolled:contract', function(contractHTML, group){
  // you can output what is passed in this callback like so
  // this is called for EACH contract that the user reaches 
  // the bottom of...
  console.log(contractHTML);
  console.log(group);
  console.log(group.get("contracts"));
});

Callback Arguments

scrolled

Triggered when "Force Scroll" has been enabled in your Group Settings and all of the contracts in a Group have been scrolled to the bottom of within a "Scroll" or "Embedded" Group style/layout.

_ps.on('scrolled:contract', function(contractsElement, group){
  // you can output what is passed in this callback like so
  // this is called for EACH contract that the user reaches 
  // the bottom of...
  console.log(contractsElement);
  console.log(contractsElement.innerHTML);
  console.log(group);
  console.log(group.get("contracts"));
});

Callback Arguments

error

Triggered when a send or retrieve command encounters an error before being sent.

_ps.on('error', callback);

Callback Arguments