NavigateToAppParams interface

Package:

@microsoft/teams-js

Parameters for the NavigateToApp API

Properties

appId	ID of the application to navigate to
channelId	Optional ID of the Teams Channel where the application should be opened
pageId	Developer-defined ID of the Page to navigate to within the application (Formerly EntityID)
subPageId	Optional developer-defined ID describing the content to navigate to within the Page. This will be passed back to the application via the Context object.
webUrl	Optional URL to open if the navigation cannot be completed within the host

Property Details

appId

ID of the application to navigate to

appId: string

Property Value

string

channelId

Optional ID of the Teams Channel where the application should be opened

channelId?: string

Property Value

string

pageId

Developer-defined ID of the Page to navigate to within the application (Formerly EntityID)

pageId: string

Property Value

string

subPageId

Optional developer-defined ID describing the content to navigate to within the Page. This will be passed back to the application via the Context object.

subPageId?: string

Property Value

string

webUrl

Optional URL to open if the navigation cannot be completed within the host

webUrl?: string

Property Value

string