DeepLinkParameters interface

Package:

@microsoft/teams-js

Warning

This API is now deprecated.

As of 2.0.0, please use ShareDeepLinkParameters instead.

Properties

subEntityId	The developer-defined unique ID for the sub-entity to which this deep link points in the current entity. This field should be used to restore to a specific state within an entity, such as scrolling to or activating a specific piece of content.
subEntityLabel	The label for the sub-entity that should be displayed when the deep link is rendered in a client.
subEntityWebUrl	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

subEntityId

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

subEntityId: string

Property Value

string

subEntityLabel

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

subEntityLabel: string

Property Value

string

subEntityWebUrl

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.

subEntityWebUrl?: string

Property Value

string