currentApp module

Package:

@microsoft/teams-js

Note

This namespace is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Provides functions for navigating without needing to specify your application ID.

Interfaces

NavigateWithinAppParams

Parameters for the NavigateWithinApp

Functions

isSupported()	Checks if pages.currentApp capability is supported by the host
navigateTo(NavigateWithinAppParams)	Navigate within the currently running application with page ID, and sub-page ID (for navigating to specific content within the page).
navigateToDefaultPage()	Navigate to the currently running application's first static page defined in the application manifest.

Function Details

isSupported()

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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)

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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()

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

function navigateToDefaultPage(): Promise<void>

Returns

Promise<void>