Use Extension JavaScript API to interact with the Relativity Review Extension framework. You can use it from the extensions themselves and from the developer tools console in the browser.
Additionally, you can perform the following tasks with this API:
For complete reference content, see IExtensionApi.
This page contains the following information:
Use the Extension API to determine whether the extensions are being loaded. Extensions aren't loaded when the Relativity Review Interface is running as the embedded Image and Production viewers within the legacy HTML5 Viewer.
To confirm whether the Review Extension framework is enabled, execute the following command in the developer tools console of the browser.
Note: Execute this command from within the HTML frame where the Relativity Review Interface application is hosted.
review.extensions.enabled;Use the Extension API to retrieve a list of all extensions with their associated statuses and properties. Additionally, use it to retrieve a specific extension by ID.
To retrieve a list of all loaded extensions, execute the following command iin the developer tools console of the browser.
Note: Execute this command from within the HTML frame where the Relativity Review Interface application is hosted.
review.extensions.all;To retrieve a specific extension by ID, execute the following command in the developer tools console of the browser.
Note: Execute this command from within the HTML frame where the Relativity Review Interface application is hosted.
review.extensions.getById("extension.id.here");Use the Extension Debug API to debug extensions from the developer tools console in the browser. You can use this API to temporarily disable the Relativity Review extension framework and specific extensions, and perform other tasks. For more information, see IExtensionDebugApi.
See the following sections:
Use the Extension Debug API to temporarily disable the Relativity Review extension framework. This process doesn't modify any Relativity applications or affect other Relativity users.
The IExtensionDebugApi.disableExtensionFramework method reloads the web page and starts the Relativity Review Interface in a special debug mode doesn't retrieve or load Review extensions.
Use this API for debugging purposes only. It is cleared when the user logs out of Relativity or when the sessionStorage for the browser is cleared.
To temporarily disable the Relativity Review extension framework, execute the following command in the developer tools console for the browser.
Note: Execute this command from within the HTML frame where the Relativity Review Interface application is hosted.
review.extensions.debug.disableExtensionFramework();To re-enable the extension framework without logging out of Relativity or clearing the sessionStorage for the browser, run the following command.
Note: Execute this command from within the HTML frame where the Relativity Review Interface application is hosted.
review.extensions.debug.enableExtensionFramework();Use the Extension Debug API to temporarily disable specific Review extensions without modifying any Relativity applications or affecting other Relativity users.
The IExtensionDebugApi.disableById method reloads the web page and prevents the Relativity Review Interface application from registering any extensions with the provided extension ID.
Use this This API for debugging purposes only. It is cleared when the user logs out of Relativity or when the browser's sessionStorage is cleared.
To temporarily disable a specific Review extension by ID, execute the following command in the developer tools console for the browser.
Note: Execute this command from within the HTML frame where the Relativity Review Interface application is hosted.
review.extensions.debug.disableById("extension.id.here");To re-enable a temporarily-disabled Review extension by ID without logging out of Relativity or clearing the sessionStorage for the browser, run the following command.
Note: Execute this command from within the HTML frame where the Relativity Review Interface application is hosted.
review.extensions.debug.enableById("extension.id.here");To re-enable all temporarily-disabled Review extensions, run the following command.
Note: Execute this command from within the HTML frame where the Relativity Review Interface application is hosted.
review.extensions.debug.enableAll();