ShareDeepLinkParameters interface

Package:

@microsoft/teams-js

Represents the parameters used to share a deep link.

Properties

subPageId	The developer-defined unique ID for the sub-page to which this deep link points in the current page. This field should be used to restore to a specific state within a page, such as scrolling to or activating a specific piece of content.
subPageLabel	The label for the sub-page that should be displayed when the deep link is rendered in a client.
subPageWebUrl	The fallback URL to which to navigate the user if the client cannot render the page. This URL should lead directly to the sub-entity.

Property Details

subPageId

The developer-defined unique ID for the sub-page to which this deep link points in the current page. This field should be used to restore to a specific state within a page, such as scrolling to or activating a specific piece of content.

subPageId: string

Property Value

string

subPageLabel

The label for the sub-page that should be displayed when the deep link is rendered in a client.

subPageLabel: string

Property Value

string

subPageWebUrl

The fallback URL to which to navigate the user if the client cannot render the page. This URL should lead directly to the sub-entity.

subPageWebUrl?: string

Property Value

string