NavigateWithinAppParams interface

Package:

@microsoft/teams-js

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.

Parameters for the NavigateWithinApp

Properties

pageId	The developer-defined unique ID for the page defined in the manifest or when first configuring the page. (Known as entityId prior to TeamsJS v.2.0.0)
subPageId	Optional developer-defined unique ID describing the content to navigate to within the page. This can be retrieved from the Context object app.Context.page.subPageId

Property Details

pageId

The developer-defined unique ID for the page defined in the manifest or when first configuring the page. (Known as entityId prior to TeamsJS v.2.0.0)

pageId: string

Property Value

string

subPageId

Optional developer-defined unique ID describing the content to navigate to within the page. This can be retrieved from the Context object app.Context.page.subPageId

subPageId?: string

Property Value

string