currentApp module
Provides functions for navigating without needing to specify your application ID.
Interfaces
NavigateWithinAppParams |
Parameters for the NavigateWithinApp |
Functions
is |
Checks if pages.currentApp capability is supported by the host |
navigate |
Navigate within the currently running application with page ID, and sub-page ID (for navigating to specific content within the page). |
navigate |
Navigate to the currently running application's first static page defined in the application manifest. |
Function Details
isSupported()
Checks if pages.currentApp capability is supported by the host
function isSupported(): boolean
Returns
boolean
boolean to represent whether the pages.currentApp capability is supported
navigateTo(NavigateWithinAppParams)
Navigate within the currently running application with page ID, and sub-page ID (for navigating to specific content within the page).
function navigateTo(params: NavigateWithinAppParams): Promise<void>
Parameters
- params
- NavigateWithinAppParams
Parameters for the navigation
Returns
Promise<void>
a promise that will resolve if the navigation was successful
navigateToDefaultPage()
Navigate to the currently running application's first static page defined in the application manifest.
function navigateToDefaultPage(): Promise<void>
Returns
Promise<void>
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for