Interface: IConfigurationOptions

Configuration options passed to the ReviewInterface constructor

Properties

developerMode?

optionaldeveloperMode: boolean

Optional - Developer Mode flag

---

elementId

elementId: string

ID of the DOM element where the Review Interface should be rendered

---

embeddedContextKey?

optionalembeddedContextKey: string

Optional - An arbitrary string key identifying the consumer's embedding context (e.g., "a4cs.fact-navigator"). Exposed to extensions via IExtensionParameters and readable via the public IReviewInterfaceApi.

---

embeddedFeatureConfig?

optionalembeddedFeatureConfig: IEmbeddedFeatureConfig

Optional - Embedded feature configuration. Only used when interfaceConfiguration is InterfaceConfiguration.Embedded. Controls which opt-in features are activated in the embedded viewer.

---

enabledViewerTypes?

optionalenabledViewerTypes: string[]

Optional - Viewer types that should be enabled

---

enableUrlRouting?

optionalenableUrlRouting: boolean

Optional - Determines whether the URL will be updated on navigation and whether the URL can drive navigation

---

initializeFoundationCore?

optionalinitializeFoundationCore: boolean

Optional - Whether to initialize foundation-core (default: false)

This is used to determine if the Review Interface should initialize foundation-core. This is useful for testing scenarios, where the Review Interface is not being embedded in a page that already has foundation-core initialized.

---

instanceSettings

instanceSettings: IInstanceSettings

Optional - Relativity Instance Settings that can be overridden

---

interfaceConfiguration?

optionalinterfaceConfiguration: InterfaceConfiguration

Interface Configuration Type

---

monitoring?

optionalmonitoring: IMonitoringConfigration

Optional - Monitoring configuration

This is used to provide monitoring data to the Review Interface, such as whether the Review Interface is being opened as the initial participant in page base.

This can be used to determine if the Review Interface should report a "cold load" metric.

---

performanceReportOptions

performanceReportOptions: IReportOptions

Optional - Performance metrics reporting settings

---

relativity

relativity: IRelativityConfiguration

Relativity configuration

---

reviewMode?

optionalreviewMode: ReviewMode

Optional - Determines whether the coding card is in view or edit mode

---

signalRTransportMethod

signalRTransportMethod: string

Optional - Transport Settings to attempt when connecting to SignalR

---

staticContentPath?

optionalstaticContentPath: string

Optional - This path will be appended to the relative path of static content

---

testingMode?

optionaltestingMode: boolean

Optional - Testing Mode flag