Navigation Api

Helper methods for navigation. These functions are available under the `convenienceApi.navigation` namespace.

Methods

navigateToArtifactId(requestedArtifactId, options) ⇒ Promise

Attempts to navigate to a specific artifact

switchLayout(requestedLayoutId, options) ⇒ Promise

Switches the current Forms page over to the requested layout

navigateToForm(viewModelName, params, routerOptions, navigationOptions) ⇒ Promise

Navigates to a specified route with a given set of parameters and options

Properties Details

navigateToArtifactId(requestedArtifactId, options) ⇒ Promise

Attempts to navigate to a specific artifact

Returns: Promise - promise of an attempted object switch

Param	Type	Description
requestedArtifactId	Number	requested artifact ID
options	Object	navigation options
options.skipVolatileDataWarning	Boolean	whether to skip the confirmation alert about switching and losing unsaved data
options.showLoader	Boolean	whether to show a loader on the screen while the form is loading.

switchLayout(requestedLayoutId, options) ⇒ Promise

Switches the current Forms page over to the requested layout

Returns: Promise - promise that resolves once the layout switch has completed.

Param	Type	Description
requestedLayoutId	Number	requested Layout ID
options	Object	navigation options
options.skipVolatileDataWarning	Boolean	whether to skip the confirmation alert about switching and losing unsaved data

navigateToForm(viewModelName, params, routerOptions, navigationOptions) ⇒ Promise

Navigates to a specified route with a given set of parameters and options

Returns: Promise - promise that resolves when the router navigation has completed

Param	Type	Description
viewModelName	String	name of the view model to navigate to
params	Object	parameters to use when navigating to the specified view model
routerOptions	Object	options for the router
navigationOptions	Object	navigation options
navigationOptions.skipVolatileDataWarning	Boolean	whether to skip the confirmation alert about switching and losing unsaved data
navigationOptions.showLoader	Boolean	whether to show the loader when navigating.
navigationOptions.shouldFirePageUnloadEventHandlers	Boolean	whether to fire pageUnload event handlers