getRouter()

Gets read-only access to the router the page is connected to, or undefined when the page is not connected to a router owned by the calling app.

Note: This method is available for site page extensions. It's not available from a site widget or plugin's settings panel. It rejects there with an internal host error. See the Page API introduction for details.

Syntax

Copy

Parameters

This method doesn't take any parameters.

Returns

Promise<IRouter | undefined>

Read-only access to the page's router, or undefined if the page isn't connected to a router owned by your app.

Example

Copy

Last updated: 25 August 2026

Did this help?