/
stageView.StageViewParams.yml
100 lines (98 loc) · 2.82 KB
/
stageView.StageViewParams.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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
### YamlMime:TSType
name: StageViewParams
uid: '@microsoft/teams-js.stageView.StageViewParams'
package: '@microsoft/teams-js'
summary: Parameters to open a stage view.
fullName: StageViewParams
remarks: ''
isDeprecated: false
type: interface
properties:
- name: appId
uid: '@microsoft/teams-js.stageView.StageViewParams.appId'
package: '@microsoft/teams-js'
summary: The ID of the Teams application to be opened.
fullName: appId
remarks: ''
isDeprecated: false
syntax:
content: 'appId: string'
return:
description: ''
type: string
- name: contentUrl
uid: '@microsoft/teams-js.stageView.StageViewParams.contentUrl'
package: '@microsoft/teams-js'
summary: The URL of the content to display.
fullName: contentUrl
remarks: ''
isDeprecated: false
syntax:
content: 'contentUrl: string'
return:
description: ''
type: string
- name: entityId
uid: '@microsoft/teams-js.stageView.StageViewParams.entityId'
package: '@microsoft/teams-js'
summary: The entity ID of the Teams application content being opened.
fullName: entityId
remarks: ''
isDeprecated: false
syntax:
content: 'entityId?: string'
return:
description: ''
type: string
- name: openMode
uid: '@microsoft/teams-js.stageView.StageViewParams.openMode'
package: '@microsoft/teams-js'
summary: >-
The open mode for stage content.
Optional param: if not passed, hosts can choose their default openMode.
If a host does not support any specific openMode, It will fallback to
StageViewOpenMode.modal.
fullName: openMode
remarks: ''
isDeprecated: false
syntax:
content: 'openMode?: StageViewOpenMode'
return:
description: ''
type: <xref uid="@microsoft/teams-js.stageView.StageViewOpenMode" />
- name: threadId
uid: '@microsoft/teams-js.stageView.StageViewParams.threadId'
package: '@microsoft/teams-js'
summary: The chat or channel ID.
fullName: threadId
remarks: ''
isDeprecated: false
syntax:
content: 'threadId: string'
return:
description: ''
type: string
- name: title
uid: '@microsoft/teams-js.stageView.StageViewParams.title'
package: '@microsoft/teams-js'
summary: The title to give the stage view.
fullName: title
remarks: ''
isDeprecated: false
syntax:
content: 'title?: string'
return:
description: ''
type: string
- name: websiteUrl
uid: '@microsoft/teams-js.stageView.StageViewParams.websiteUrl'
package: '@microsoft/teams-js'
summary: The Teams application website URL.
fullName: websiteUrl
remarks: ''
isDeprecated: false
syntax:
content: 'websiteUrl?: string'
return:
description: ''
type: string