--- schema_version: "1" id: 864a777977358ab28a4dd717c5fab39a0dea588c6dac217badd99afb06439b29 title: NavigationUtils ReadMe (Managed Package) collection: admin version: current locale: en-us portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/os_navigationutils_readme.md canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.os_navigationutils_readme.htm&release=264.0.0&type=5 source_site: help.salesforce.com content_type: documentation content_hash: 21c117eae0777806b32f1e59bb21ea202312297ba07d645e8690adb8edbff35f description: For the managed package runtime, this page contains a NavigationUtils ReadMe for each Vlocity release. products: - Omnistudio release: "264" --- # NavigationUtils ReadMe (Managed Package) For the managed package runtime, this page contains a NavigationUtils ReadMe for each Vlocity release. ![Managed Package app icon](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_for_managed_packages-264-0-0-production-enus/aa2554ec-624a-4ee6-8da4-6435670e6e62/resources-global/_corporate/images/managedpackageicon.png) This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see [Omnistudio Help](https://help.salesforce.com/s/articleView?id=xcloud.os_omnistudio_standard.htm&language=en_US). ## Vlocity Insurance and Health Spring '20 This module exposes a collection of utilities designed to simplify navigational functions. ## ns/navigationUtils.PageReference Kind: static class of ns/navigationUtils ## new exports.PageReference(type, attributes, \[stateParams\]) To navigate in Lightning Experience, Lightning Communities, or the Salesforce mobile app, define a PageReference object. The PageReference type generates a unique URL format and defines attributes that apply to all pages of that type.

Param

Type

Description

type

PageReferenceType

Page reference type.

attributes

Object

Page reference attributes.

[stateParams]

string ⎮ any

State parameters passed to the target context. Can be in the form of a url query string or an object.
## PageReference.unfreeze(pageReference, newParams) Utility method to unfreeze, and update PageReference object returned from @wire(CurrentPageReference) is frozen Kind: static method of PageReference

Param

Type

Description

pageReference

PageReference

A page reference object received from @wire(CurrentPageReference)

newParams

string ⎮ any

[stateParams] - State parameters to be extended on the current reference. Can be in the form of a url query string or an object.
## ns/navigationUtils.AppPageReference Kind: static class of ns/navigationUtils ## new exports.AppPageReference(appTarget, pageReference) A standard or custom app available from the App Launcher in an org. Use this type to create custom navigation components that take users to a specific app or to a page within an app. Connected apps aren’t supported.

Param

Type

Description

appTarget

string

App that you are navigating to. Pass either the appId or appDeveloperName to the appTarget. - The appId is the DurableId field on the AppDefinition object. - To form the appDeveloperName value, concatenate the app’s namespace with the developer name. To find the app’s developer name, navigate to the App Manager in Setup and look in the Developer Name column. For standard apps, the namespace is standard__. For custom apps it’s c__. For managed packages, it’s the namespace registered for the package.

pageReference

PageReference

Identifies a specific location in the app you are navigating to. Pass in the pageReferenceand applicable attributes for that pageReference type.
## ns/navigationUtils.ComponentPageReference Kind: static class of ns/navigationUtils Supports: Lightning Experience, Salesforce Mobile App ## new exports.ComponentPageReference(name, \[stateParams\]) A Lightning component. To make an addressable Lightning web component, embed it in an Aura component that implements the `lightning:isUrlAddressable` interface.

Param

Type

Description

name

string

The Lightning component name in the format namespace__componentName

[stateParams]

string ⎮ Object

State parameters passed to the target context. Can be in the form of a url query string or an object.
## ns/navigationUtils.KnowledgeArticlePageReference Kind: static class of ns/navigationUtils ## new exports.KnowledgeArticlePageReference(articleType, urlName) A page that interacts with a Knowledge Article record.

Param

Type

Description

articleType

string

The articleType API name of the Knowledge Article record. In Communities, articleType is ignored.

urlName

string

The value of the urlName field on the target KnowledgeArticleVersion record. The urlName is the article's URL.
## ns/navigationUtils.LoginPageReference Kind: static class of ns/navigationUtils ## new exports.LoginPageReference(action, \[stateParams\]) A page for authentication into a community.

Param

Type

Description

action

'login' ⎮ 'logout'

A login-related action to be performed. Possible values are: 'login' or 'logout'.

[stateParams]

string ⎮ Object

State parameters passed to the target context. Can be in the form of a url query string or an object.
## ns/navigationUtils.NamedPageReference Kind: static class of ns/navigationUtils ## new exports.NamedPageReference(pageName, \[stateParams\]) A standard page with a unique name. If an error occurs, the error view loads and the URL isn’t updated.

Param

Type

Description

pageName

string

The unique name of the page.

[stateParams]

string ⎮ any

State parameters passed to the target context. Can be in the form of a url query string or an object.
## ns/navigationUtils.CommNamedPageReference Kind: static class of ns/navigationUtils ## new exports.CommNamedPageReference(pageName, \[stateParams\]) A standard page with a unique name, for use in communities. If an error occurs, the error view loads and the URL isn’t updated.

Param

Type

Description

pageName

string

The unique name of the page.

[stateParams]

string ⎮ any

State parameters passed to the target context. Can be in the form of a url query string or an object.
## ns/navigationUtils.NavItemPageReference Kind: static class of ns/navigationUtils ## new exports.NavItemPageReference(tabName, \[stateParams\]) A page that displays the content mapped to a CustomTab. Visualforce tabs, Web tabs, Lightning Pages, and Lightning Component tabs are supported.

Param

Type

Description

tabName

string

The unique name of the CustomTab.

[stateParams]

string ⎮ any

State parameters passed to the target context. Can be in the form of a url query string or an object.
## ns/navigationUtils.ObjectPageReference Kind: static class of ns/navigationUtils ## new exports.ObjectPageReference(objectName, \[action\], \[filter\]) A page that interacts with a standard or custom object in the org and supports standard actions for that object.

Param

Type

Default

Description

objectName

string

  

The API name of the standard or custom object. For custom objects that are part of a managed package, prefix the custom object with ns__

[action]

string

"home"

The action name to invoke. Valid values include home,list, and new. In Communities, list and homeare the same.

[filter]

string

"Recent"

Id of the object page. Default is Recent.
## ns/navigationUtils.RecordPageReference Kind: static class of ns/navigationUtils ## new exports.RecordPageReference(id, \[objectName\], \[action\]) A page that interacts with a relationship on a particular record in the org. Only related lists are supported.

Param

Type

Default

Description

id

string

  

The 18 character record ID.

[objectName]

string

  

The API name of the record’s object. Optional for lookups.

[action]

string

"view"

The action name to invoke. Valid values include clone,edit, and view. Communities doesn’t support the values clone or edit.
## ns/navigationUtils.RelationshipPageReference Kind: static class of ns/navigationUtils ## new exports.RelationshipPageReference(recordId, \[objectApiName\], \[relationshipApiName\], \[actionName\]) A page that interacts with a relationship on a particular record in the org. Only related lists are supported.

Param

Type

Default

Description

recordId

string

  

The 18 character record ID of the record that defines the relationship.

[objectApiName]

string

  

The API name of the object that defines the relationship. Optional for lookups.

[relationshipApiName]

string

  

The API name of the object’s relationship field.

[actionName]

string

"view"

The action name to invoke. Only view is supported.
## ns/navigationUtils.WebPageReference Kind: static class of ns/navigationUtils ## new exports.WebPageReference(url, replace) An external URL.

Param

Type

Description

url

string

The URL of the page you are navigating to.

replace

Boolean

replace the current page with this URL in your browser’s session history, set replace to true. The current page is not saved in session history, meaning the user can’t navigate back to it.
## ns/navigationUtils.pageReferenceTypes : enum Kind: static enum of ns/navigationUtils Read only: true ## ns/navigationUtils.parseParams(queryString) Expands query params to an object Kind: static method of ns/navigationUtils

Param

Type

Description

queryString

string

key=value pairs separated by &
## ns/navigationUtils.normalizeParams(namespacedParams) ⇒ object Returns a copy of a params object with the namespace values removed. Duplicate values will be overwritten. Kind: static method of ns/navigationUtils

Param

Type

Description

namespacedParams

object

A collection of params derived from pageReference.state.
## ns/navigationUtils~APP : 'App' Kind: inner constant of ns/navigationUtils ## ns/navigationUtils~COMPONENT : 'Component' Kind: inner constant of ns/navigationUtils ## ns/navigationUtils~KNOWLEDGE\_ARTICLE : 'Knowledge Article' Kind: inner constant of ns/navigationUtils ## ns/navigationUtils~LOGIN : 'Login' Kind: inner constant of ns/navigationUtils ## ns/navigationUtils~OBJECT : 'Object' Kind: inner constant of ns/navigationUtils ## ns/navigationUtils~RECORD : 'Record' Kind: inner constant of ns/navigationUtils ## ns/navigationUtils~RELATIONSHIP : 'Record Relationship' Kind: inner constant of ns/navigationUtils ## ns/navigationUtils~NAMED\_PAGE : 'Named Page' Kind: inner constant of ns/navigationUtils ## ns/navigationUtils~COMM\_NAMED\_PAGE : 'Community Named Page' Kind: inner constant of ns/navigationUtils ## ns/navigationUtils~NAVIGATION\_ITEM : 'Navigation Item' Kind: inner constant of ns/navigationUtils ## ns/navigationUtils~WEB\_PAGE : 'Web Page' Kind: inner constant of ns/navigationUtils ## ns/navigationUtils~CURRENT\_PAGE : 'Current Page' Kind: inner constant of ns/navigationUtils ## ns/navigationUtils~parseValue(value) ⇒ string Parse the value of a url parameter. Kind: inner method of ns/navigationUtils Scope: private

Param

Type

value

string