-
Notifications
You must be signed in to change notification settings - Fork 6
/
DeepLinkParameters.yml
61 lines (59 loc) · 1.82 KB
/
DeepLinkParameters.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
### YamlMime:TSType
name: DeepLinkParameters
uid: '@microsoft/teams-js.DeepLinkParameters'
package: '@microsoft/teams-js'
summary: ''
fullName: DeepLinkParameters
remarks: ''
isDeprecated: true
customDeprecatedMessage: >-
As of TeamsJS v2.0.0, please use
[ShareDeepLinkParameters](xref:@microsoft/teams-js.ShareDeepLinkParameters)
instead.
type: interface
properties:
- name: subEntityId
uid: '@microsoft/teams-js.DeepLinkParameters.subEntityId'
package: '@microsoft/teams-js'
summary: >-
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.
fullName: subEntityId
remarks: ''
isDeprecated: false
syntax:
content: 'subEntityId: string'
return:
description: ''
type: string
- name: subEntityLabel
uid: '@microsoft/teams-js.DeepLinkParameters.subEntityLabel'
package: '@microsoft/teams-js'
summary: >-
The label for the sub-entity that should be displayed when the deep link
is rendered in a client.
fullName: subEntityLabel
remarks: ''
isDeprecated: false
syntax:
content: 'subEntityLabel: string'
return:
description: ''
type: string
- name: subEntityWebUrl
uid: '@microsoft/teams-js.DeepLinkParameters.subEntityWebUrl'
package: '@microsoft/teams-js'
summary: >-
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.
fullName: subEntityWebUrl
remarks: ''
isDeprecated: false
syntax:
content: 'subEntityWebUrl?: string'
return:
description: ''
type: string