Configuring the RoundTrip API

About this task

The RoundTrip JavaScript API supports JavaScript communication with the viewer during a Redaction or Document Builder process.

See the general flow of using this API in the following steps.

Procedure

  1. Open a document.
  2. Check out the document.
  3. Edit the document, or add redaction.
  4. Undo the check-out or set commit parameters.
  5. Perform specific actions in Edit mode.
  6. Commit the updated document.
  7. The taskStart event (event ID: 78) is fired, and if you listened for this event, you must call the associated callback.
  8. The taskStarted event (event ID: 79) is fired if your call to the taskStart callback allowed this.
  9. The taskStatus event is fired one or more times as the output is produced, and one last time specifying that the document has completed building or that redaction has completed.

What to do next

See RoundTrip events to find the list of calls and the information they supply, as well as any information that your client is expected to respond with. To listen to RoundTrip events, all RoundTrip events must be registered.