Interface: IRelativityConfiguration

Configuration used for communicating with a Relativity Instance

Properties

authMode?

optionalauthMode: AuthMode

Authentication mode

baseUrl?

optionalbaseUrl: string

The Base Url used for routing.

bearerToken?

optionalbearerToken: string

Bearer Token

enableRelativityInternalRouting?

optionalenableRelativityInternalRouting: boolean

Optional - Allows router to update query strings on window.top whenever a user navigates

environmentType

environmentType: string

the Environment Type we are running in, dev, reg or prod

initialIndex

initialIndex: number

Initial review queue index

initialLongTextArtifactId?

optionalinitialLongTextArtifactId: number

Initial long text artifact ID for use in the text viewer (optional)

initialPageLayout?

optionalinitialPageLayout: ViewerScrollMode

Optional - Initial Page Layout

initialProductionArtifactId?

optionalinitialProductionArtifactId: number

Initial production artifact ID for use in the production viewer (optional)

initialProductionType?

optionalinitialProductionType: ProductionType

Initial production type for use in the production viewer (optional)

initialReviewQueueDocuments?

optionalinitialReviewQueueDocuments: number[]

Deprecated

Use initialReviewQueueItemIdentifiers instead Initial review queue documents

initialReviewQueueItemIdentifiers?

optionalinitialReviewQueueItemIdentifiers: IQueueItemIdentifier[]

Initial review queue items TODO: make non-optional once intialReviewQueueDocuments is no longer needed

initialThumbnailVisibility

initialThumbnailVisibility: boolean

Initial Thumbnail Visibility

initialType

initialType: string

Initial viewer type

initialZoomLevel

initialZoomLevel: number

Initial zoom level

This property is only used when initialZoomMode is set to ViewerZoomMode.percentage. See ViewerZoomMode for more details.

initialZoomMode

initialZoomMode: ViewerZoomMode

Initial zoom mode

launchDarklySdkId

launchDarklySdkId: string

SDK id for connecting the launch darkly process

region

region: string

what region the review interface is being hosted in

servicesBaseUrl?

optionalservicesBaseUrl: string

Base URL for Relativity services

tenantId

tenantId: string

Tenant ID/Instance ID, the guid of the tennat

workspaceId

workspaceId: number

Workspace artifact ID