Interface IRelativityFormsNavigationAPI

The Relativity Forms Navigation API

Hierarchy

IRelativityFormsNavigationAPI

Index

Methods

Methods

navigateToArtifactId

navigateToArtifactId(artifactId: number): Promise<void>

Navigates the Relativity Form to the specified artifactId

Parameters
- artifactId: number
  
  The artifactID to navigate to
Returns Promise<void>

navigateToForm

navigateToForm(mode: RelativityFormModelName, formParams: IRelativityFormsNavigateToFormParameters, routerOptions?: object, navigationOptions?: IRelativityFormsNavigateToFormNavigationOptions): Promise<void>

Updates the mode of the Relativity Form

Parameters
- mode: RelativityFormModelName
  
  The mode to switch too
- formParams: IRelativityFormsNavigateToFormParameters
  
  form parameters
- Optional routerOptions: object
  
  optional router options
- Optional navigationOptions: IRelativityFormsNavigateToFormNavigationOptions
  
  optional navigation options
Returns Promise<void>

Send comments on this topic to Relativity documentation