Access to this page requires authorization. You can try signing in or changing directories . Access to this page requires authorization. You can try changing directories . Navigation-specific part of the SDK. Type-safer version of parameters for the navigateToApp function Defines the configuration of the current or desired instance Back button handler function Full screen function Callback function Remove event function Save event function Return focus action items Gets the config for the current instance. Initializes the library with context information for the frame Checks if the pages capability is supported by the host Used to navigate to apps other than your own. If you are looking to navigate within your own app, use navigateToDefaultPage or navigateTo Registers a handler for changes from or to full-screen view for a tab. Only one handler can be registered at a time. A subsequent registration replaces an existing registration. On hosts where there is no support for making an app full screen, the handler registered with this function will never be called. Return focus to the host. Will attempt to send focus to the appropriate part of the host (as specified by returnFocusType) based on where the application container falls in the F6/tab order in the host. On mobile hosts or hosts where there is no keyboard interaction or UI notion of "focus" this function has no effect and will be a no-op when called. Sets/Updates the current frame with new information Shares a deep link that a user can use to navigate back to a specific state in this page. Please note that this method does not yet work on mobile hosts. Function Details Gets the config for the current instance. Promise< InstanceConfig > Promise that resolves with the InstanceConfig object. initialize With Frame Context(Frame Info, handler Function Type, string[]) Initializes the library with context information for the frame Frame information containing the URL used in the iframe on reload and the URL for when the user clicks 'Go To Website' An optional callback that is executed once the application has finished initialization. An optional list of cross-frame message origins. They must have https: protocol otherwise they will be ignored. Example: https:www.example.com Checks if the pages capability is supported by the host

boolean to represent whether the appEntity capability is supported navigate Cross Domain(string) This API is now deprecated. As of 2.0.0, this API is deprecated and can be replaced by the standard JavaScript API, window.location.href, when navigating the app to a new cross-domain URL. Any URL that is redirected to must be listed in the validDomains block of the manifest. Please remove any calls to this API. The URL to navigate the frame to. Promise that resolves when the navigation has completed. navigate ToApp(App Navigation Parameters | Navigate ToApp Params) Used to navigate to apps other than your own. If you are looking to navigate within your own app, use navigateToDefaultPage or navigateTo AppNavigationParameters | NavigateToAppParams Parameters for the navigation a Promise that will resolve if the navigation was successful or reject if it was not register Full Screen Handler(full Screen Change Function Type) Registers a handler for changes from or to full-screen view for a tab. Only one handler can be registered at a time. A subsequent registration replaces an existing registration. On hosts where there is no support for making an app full screen, the handler registered with this function will never be called. The handler to invoke when the user toggles full-screen view for a tab. return Focus(boolean) This API is now deprecated. Return focus to the host. Will move focus forward or backward based on where the application container falls in the F6/tab order in the host. On mobile hosts or hosts where there is no keyboard interaction or UI notion of "focus" this function has no effect and will be a no-op when called. Determines the direction to focus in host. return Focus(Return Focus Type) Return focus to the host. Will attempt to send focus to the appropriate part of the host (as specified by returnFocusType) based on where the application container falls in the F6/tab order in the host. On mobile hosts or hosts where there is no keyboard interaction or UI notion of "focus" this function has no effect and will be a no-op when called. Determines the type of focus to return to in the host. set Current Frame(Frame Info) Sets/Updates the current frame with new information Frame information containing the URL used in the iframe on reload and the URL for when the user clicks 'Go To Website' share Deep Link(Share Deep Link Parameters) Shares a deep link that a user can use to navigate back to a specific state in this page. Please note that this method does not yet work on mobile hosts. ID and label for the link and fallback URL. Was this page helpful? Need help with this topic? Want to try using Ask Learn to clarify or guide you through this topic?