NavigateToAppParams interface
Warning
This API is now deprecated.
This interface has been deprecated in favor of a more type-safe interface using AppNavigationParameters
Parameters for the navigateToApp function
Properties
app |
ID of the app to navigate to |
channel |
For apps installed as a channel tab, this ID can be supplied to indicate in which Teams channel the app should be opened |
chat |
Optional ID of the chat or meeting where the app should be opened |
page |
Developer-defined ID of the page to navigate to within the app (formerly called |
sub |
Developer-defined ID describing the content to navigate to within the page. This ID is passed to the application via the subPageId property on the Context object (retrieved by calling getContext) |
web |
Fallback URL to open if the navigation cannot be completed within the host (e.g. if the target app is not installed) |
Property Details
appId
ID of the app to navigate to
appId: string
Property Value
string
channelId
For apps installed as a channel tab, this ID can be supplied to indicate in which Teams channel the app should be opened
channelId?: string
Property Value
string
chatId
Optional ID of the chat or meeting where the app should be opened
chatId?: string
Property Value
string
pageId
Developer-defined ID of the page to navigate to within the app (formerly called entityId
)
pageId: string
Property Value
string
subPageId
Developer-defined ID describing the content to navigate to within the page. This ID is passed to the application via the subPageId property on the Context object (retrieved by calling getContext)
subPageId?: string
Property Value
string
webUrl
Fallback URL to open if the navigation cannot be completed within the host (e.g. if the target app is not installed)
webUrl?: string
Property Value
string