The Annotations API is for interacting with annotations (a.k.a. Relativity markups, image highlights and redactions) and markup sets.
The card framework allows developers to add content panes to the Review Interface. This API object handles card definition, creation and management.
The application configuration contains information about how the Review Interface is configured to run.
The Context Menu API controls the menu options that appear in right-click context menu throughout the Review Interface.
The Document Actions API manages (access/add/remove/enable/disable) document actions in the header dropdown (where the Control Number is at the top of the page).
The Document Data Cache Manager allows loaded OutsideIn documents to be removed from the Review Interface's front-end in-memory cache. OutsideIn is the document viewing library that is at the heart of the viewer. Clearing this cache may be necessary when one or more of a document's underlying files have been changed.
The Extensions API is for interacting with and debugging Relativity Review extensions.
The FileService API can be used to interact with the underlying files that are displayed by the viewer.
The Persistent Highlighting API is for interacting with IPersistentHighlightSets and IPersistentHighlightTerms.
The Imaging API is now available under IReviewInterfaceApi.fileService as the IFileService.imaging property.
The Keyboard Shortcut Manager API is for adding, accessing, enabling, and disabling keyboard shortcuts.
The Application Lifecycle API enables interaction with the Review Interface application lifecycle. It can be used to prepare the Review Interface for user interaction (IApplicationLifecycleService.activate) or to exit the Review Interface in one of several ways.
The Preload API prepares upcoming documents to be displayed quickly in the viewer by requesting the data required for display ahead of when it will be used and caching the data in the front-end.
The Toolbar API provides access to toolbars throughout the Review Interface and enables adding buttons and customization for these toolbars.
The Utilities API generates instances of utility classes, such as IHttpClient and IExpirationCache.
The Version API exposes the current versions and build type of the Review Interface application.
The Viewer API exposes the main IViewerCollection (which in turn exposes the available viewers) and makes ViewerServiceEventType events available to listen for.
The Viewer Content Key Cache Manager allows converted cache entry information to be removed from the Review Interface's front-end caches (in-memory and in browser session storage). Clearing this cache may be necessary when one or more of a document's underlying files have been changed.
The Viewer Settings API provides methods for showing and hiding the Viewer Settings card
The application window management API enables interaction with browser windows running the Review Interface. This API is especially useful when the Review Interface is running across multiple browser windows: for example, when the popout or standalone viewers are open.
Registers an event handler on the Review Interface API
If the ReviewInterfaceEventType.ApiReady or ReviewInterfaceEventType.Ready event has already fired, event handlers for these event types will be invoked immediately.
api.on("ready", () => {
// do something here
});Event type to register the listener for
Event handler
Reference to the API object
This Review Interface Public API Contract defines the front-end API surface for the Review Interface. It is available as the
window.reviewproperty of the Review Interface iframe as well as via the extension and card frameworks.