The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

RouteInstance

A route handler receives a RouteInstance when a new client-side navigation event occurs. RouteInstance contains location information passed to RouteHandler.update. The route handler uses the RouteInstance to determine which view to show.

PropertyTypeRequired/OptionalDescription
idStringRequiredThe unique identifier for the RouteDefinition.
pageReferencePageReference objectRequiredThe PageReference object for the navigation event.

See Also