PageProof

The Accounts API.

The repository of registered adapters.

The AdapterRepository helps provide the functionality of the SDK to the APIs (API).

The Comments API.

The Dashboard API.

The Files API.

The Proofs API.

The current session.

The session object is used to make authorized requests to PageProof. If there is no session, it's not possible to send any requests to the API other than those which have been made explicitly public.

See:

• PageProof#setSession

The Users API.

The Workflows API.

Returns the Admin API (experimental).

Please use this API with caution. This functionality is primarily used within the app, so these APIs are updated regularly. Please ensure you have registered a error.deprecated event to be notified when these APIs become incompatible with the version of the SDK you're running.

We also advise you to let us know when you incorporate this API into your app, as we will try our best to notify you of major breaking changes. Email us at hello@pageproof.com.

This feature is only for team/enterprise administrators. If you call this method while authenticated with a non-admin account, the promise will reject. Only the first call to this method is potentially async, as it verifies the account is actually an administrator.

Example:

const client = new PageProof(...);
const admin = await client.admin();
const users = await admin.team.users.active(); // retrieve a list of all the active users in your team
console.log(users); // [User, User, User]

Registers an event handler.

The SDK exposes some events/hooks, which you can use to make it easier for yourself to use it seamlessly. For example, we have an event ("error.unauthorized") which is emitted when an endpoint responds with a 401 (Unauthorized). If you return a Promise, it will automatically retry the request.

All event handlers are invoked at the same time. Returning a Promise in one, will not defer the others.

Here is a list of currently supported events.

• error.unauthorized
• error.deprecated
• error.throttled
• error.response

Example:

const client = new PageProof({ <omitted> });
 
client.on('error.unauthorized', () => {
  // If the "error.unauthorized" event handler returns a promise, the SDK
  // will automatically retry the request if it notices the session has changed.
  return client.accounts.login('user@example.com', '<password>');
});

const client = new PageProof({ <omitted> });
 
client.on('error.deprecated', (event) => {
  // Some custom code which notifies you (the developer) that it's probably time
  // to update the SDK. We will never deprecate APIs without an update to the
  // SDK with a replacement.
});

Sets the current session.

This method should be called when restoring a session. You can either pass an object (containing all the properties, or an instance of an existing Session object.