Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRelativityConfiguration

Configuration used for communicating with a Relativity Instance

Hierarchy

  • IRelativityConfiguration

Index

Properties

Properties

Optional authMode

authMode: AuthMode

Authentication mode

Optional baseUrl

baseUrl: string

The Base Url used for routing.

type

{string}

Optional bearerToken

bearerToken: string

Bearer Token

Optional enableRelativityInternalRouting

enableRelativityInternalRouting: boolean

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

type

{boolean}

initialIndex

initialIndex: number

Initial review queue index

Optional initialLongTextArtifactId

initialLongTextArtifactId: number

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

Optional initialPageLayout

initialPageLayout: ViewerScrollMode

Optional - Initial Page Layout

Optional initialProductionArtifactId

initialProductionArtifactId: number

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

Optional initialReviewQueueDocuments

initialReviewQueueDocuments: number[]
deprecated

Use initialReviewQueueItemIdentifiers instead Initial review queue documents

Optional initialReviewQueueItemIdentifiers

initialReviewQueueItemIdentifiers: IQueueItemIdentifier[]

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

initialThumbnailVisibility

initialThumbnailVisibility: boolean

Initial Thumbnail Visibility

initialType

initialType: ViewerType

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

Optional servicesBaseUrl

servicesBaseUrl: string

Base URL for Relativity services

workspaceId

workspaceId: number

Workspace artifact ID