Gets the page's role within its router, 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.
This method doesn't take any parameters.
Promise<string | undefined>
The page's role within its router, or undefined if the page isn't connected to a router owned by your app.
Last updated: 25 August 2026