This site is currently undergoing maintenance, so instances of "RelativityOne" may still be present. You may also experience 404 errors, search disruptions, and temporary style changes.

Last date modified: 2026-Sep-09

Interface: IRelativityFormsNavigationAPI

The Relativity Forms Navigation API

Methods

navigateToArtifactId(artifactId): Promise<void>

Navigates the Relativity Form to the specified artifactId

Parameters

• artifactId: number

The artifactID to navigate to

Returns

Promise<void>


navigateToForm(mode, formParams, routerOptions?, navigationOptions?): Promise<void>

Updates the mode of the Relativity Form

Parameters

• mode: RelativityFormModelName

The mode to switch too

• formParams: IRelativityFormsNavigateToFormParameters

form parameters

• routerOptions?: object

optional router options

• navigationOptions?: IRelativityFormsNavigateToFormNavigationOptions

optional navigation options

Returns

Promise<void>

Feedback