Interface: IExtensionParameters

Parameters passed to extension scripts registered as application resource files

Properties

applicationContext

readonlyapplicationContext: ApplicationContext

Context the application is currently running in

This can be used to determine which extension features should be registered.

---

configuration

readonlyconfiguration: IExtensionConfigurationSettings

The configuration settings in the configuration service

---

embeddedContextKey?

readonlyoptionalembeddedContextKey: string

Optional consumer-supplied context key, populated when running in the Embedded interface configuration. Extensions can use this to gate behavior to specific embedding contexts (e.g., "a4cs.fact-navigator").

---

extensionDetails

readonlyextensionDetails: IExtensionDetails

Details about the extension

---

foundationInstance?

readonlyoptionalfoundationInstance: any

Optional Foundation instance provided by extension using assetResolution strategy.

If the assetResolution method returns an object containing a foundationInstance property, this will be passed back to the extension via this property.

This property may be undefined even when using assetResolution if the extension's entry point URL was served from the LocalStorage cache — in that case resolveAssetURL is not called and the callback that provides the Foundation instance is never invoked. Extensions using assetResolution must be able to create their own Foundation instance when this property is undefined.

---

getResourceFileUrl()

readonlygetResourceFileUrl: (fileName) => string

Method that can be used to return the URL to the resource for the given file name in Relativity.

This can be used to figure out the URL to other application resource files (e.x images).

Parameters

• fileName: string

Returns

string

---

getResourceUrl()

readonlygetResourceUrl: (fileName) => string

Method that can be used to return the URL to the resource for the given file name using external resources.

This can be used to figure out the URL to other external files (e.x images).

Parameters

• fileName: string

Returns

string

---

relativityTenantContext

readonlyrelativityTenantContext: IRelativityTenantContext

Relativity tenant context information from relativity-foundation.

This is an experimental property, and may return undefined if relativity-foundation throws an unexpected error.

---

version

readonlyversion: IVersionInformation

Application version information

This can be used to ensure an extension is only registered in supported versions of the Relativity Review application.