currentApp module

Package:

@microsoft/teams-js

Provides functions for navigating within your own app

Interfaces

NavigateWithinAppParams

Parameters provided to the navigateTo function

Functions

isSupported()	Checks if pages.currentApp capability is supported by the host
navigateTo(NavigateWithinAppParams)	Navigate within the currently running app
navigateToDefaultPage()	Navigate to the currently running app'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 app

function navigateTo(params: NavigateWithinAppParams): Promise<void>

Parameters

params

NavigateWithinAppParams

Parameters for the navigation

Returns

Promise<void>

Promise that will resolve if the navigation was successful and reject if not

Remarks

If you are looking to navigate to a different app, use navigateToApp.

navigateToDefaultPage()

Navigate to the currently running app's first static page defined in the application manifest.

function navigateToDefaultPage(): Promise<void>

Returns

Promise<void>

Promise that will resolve if the navigation was successful and reject if not