generateUrl()
Generates a URL for a specified page reference.
Method Input | Type | Required/Optional | Description |
---|---|---|---|
context | String | Required | The ID of the parent router container nearest to the component that's generating a URL. A ContextId is an opaque value that you get from the NavigationContext wire. |
pageReference | String | Required | The PageReference value for which to generate a URL. |
- If
pageReference
is valid,generateUrl()
returns a string with the generated URL for the specified route. - If
pageReference
is invalid, it returnsnull
. - If
context
is invalid,generateUrl()
fails.
See Also