Interface: IReviewInterfaceApi

This Review Interface Public API Contract defines the front-end API surface for the Review Interface. It is available as the window.review property of the Review Interface iframe as well as via the extension and card frameworks.

Properties

annotations

readonlyannotations: IAnnotationsService

The Annotations API is for interacting with annotations (a.k.a. Relativity markups, image highlights and redactions) and markup sets.

cards

readonlycards: ICardService

The card framework allows developers to add content panes to the Review Interface. This API object handles card definition, creation and management.

configuration

readonlyconfiguration: IConfigurationService

The application configuration contains information about how the Review Interface is configured to run.

contextMenu

readonlycontextMenu: IContextMenuFactory

The Context Menu API controls the menu options that appear in right-click context menu throughout the Review Interface.

convenienceApi

readonlyconvenienceApi: IConvenienceApiService

The Convenience API exposes the Relativity Forms Convenience API for the active coding card. Use IConvenienceApiService.get to retrieve the current API, or null if no coding card is active.

documentActions

readonlydocumentActions: IDocumentActionCollection

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).

documentDataCacheManager

readonlydocumentDataCacheManager: IDocumentDataCacheManager

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.

documentList

readonlydocumentList: IDocumentListCardService

embeddedContextKey?

readonlyoptionalembeddedContextKey: string

Consumer-supplied context key identifying the embedding context. Populated when the interface configuration is Embedded and embeddedContextKey was provided at bootstrap. Extensions can read this via IExtensionParameters.embeddedContextKey.

extensions

readonlyextensions: IExtensionApi

The Extensions API is for interacting with and debugging Relativity Review extensions.

fileService

readonlyfileService: IFileService

The FileService API can be used to interact with the underlying files that are displayed by the viewer.

highlights

readonlyhighlights: IHighlightService

The Persistent Highlighting API is for interacting with IPersistentHighlightSets and IPersistentHighlightTerms.

imaging

readonlyimaging: IImagingService

The Imaging API is now available under IReviewInterfaceApi.fileService as the IFileService.imaging property.

Deprecated

Use fileService.imaging instead.

keyboardShortcuts

readonlykeyboardShortcuts: IKeyboardShortcutManager

The Keyboard Shortcut Manager API is for adding, accessing, enabling, and disabling keyboard shortcuts.

lifecycle

readonlylifecycle: IApplicationLifecycleService

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.

preload

readonlypreload: IPreloadService

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.

readonlytoolbar: IToolbarService

The Toolbar API provides access to toolbars throughout the Review Interface and enables adding buttons and customization for these toolbars.

utilities

readonlyutilities: IUtilitiesApi

Experimental

The Utilities API generates instances of utility classes, such as IHttpClient and IExpirationCache.

This API is in preview and not ready for production use. Expect breaking changes in the future.

version

readonlyversion: IVersionInformation

The Version API exposes the current versions and build type of the Review Interface application.

viewer

readonlyviewer: IViewerService

The Viewer API exposes the main IViewerCollection (which in turn exposes the available viewers) and makes ViewerServiceEventType events available to listen for.

viewerContentKeyCacheManager

readonlyviewerContentKeyCacheManager: IViewerContentKeyCacheManager

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.

viewerSettings

readonlyviewerSettings: IViewerSettingsService

The Viewer Settings API provides methods for showing and hiding the Viewer Settings card

window

readonlywindow: IWindowService

Experimental

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.

This API is in preview and not ready for production use. Expect breaking changes in the future.

Methods

off()

off(eventType, handler): this

Unregisters an event handler on the Review Interface API

If the event is ReviewInterfaceEventType.ApiReady or ReviewInterfaceEventType.Ready, this call will be ignored.

Parameters

• eventType: ReviewInterfaceEventType

Event type to register the listener for

• handler: EventHandler

Event handler

Returns

this

Reference to the API object

on()

on(eventType, handler): this

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.

Copy

api.on("ready", () => {
    // do something here
});