-
Notifications
You must be signed in to change notification settings - Fork 8
/
pages.yml
224 lines (207 loc) · 8.21 KB
/
pages.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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
### YamlMime:TSPackage
uid: '@microsoft/teams-js.pages'
name: pages
summary: Navigation-specific part of the SDK.
type: module
typeAliases:
- '@microsoft/teams-js.pages.backButtonHandlerFunctionType'
- '@microsoft/teams-js.pages.fullScreenChangeFunctionType'
- '@microsoft/teams-js.pages.handlerFunctionType'
- '@microsoft/teams-js.pages.removeEventType'
- '@microsoft/teams-js.pages.saveEventType'
interfaces:
- '@microsoft/teams-js.pages.InstanceConfig'
- '@microsoft/teams-js.pages.NavigateToAppParams'
enums:
- '@microsoft/teams-js.pages.ReturnFocusType'
package: '@microsoft/teams-js'
functions:
- name: getConfig()
uid: '@microsoft/teams-js.pages.getConfig'
package: '@microsoft/teams-js'
summary: Gets the config for the current instance.
remarks: ''
isDeprecated: false
syntax:
content: 'function getConfig(): Promise<InstanceConfig>'
return:
description: >-
Promise that resolves with the
[InstanceConfig](xref:@microsoft/teams-js.pages.InstanceConfig)
object.
type: Promise<<xref uid="@microsoft/teams-js.pages.InstanceConfig" />>
- name: initializeWithFrameContext(FrameInfo, handlerFunctionType, string[])
uid: '@microsoft/teams-js.pages.initializeWithFrameContext'
package: '@microsoft/teams-js'
summary: Initializes the library with context information for the frame
remarks: ''
isDeprecated: false
syntax:
content: >-
function initializeWithFrameContext(frameInfo: FrameInfo, callback?:
handlerFunctionType, validMessageOrigins?: string[])
parameters:
- id: frameInfo
type: <xref uid="@microsoft/teams-js.FrameInfo" />
description: >-
Frame information containing the URL used in the iframe on reload
and the URL for when the
user clicks 'Go To Website'
- id: callback
type: <xref uid="@microsoft/teams-js.pages.handlerFunctionType" />
description: >-
An optional callback that is executed once the application has
finished initialization.
- id: validMessageOrigins
type: string[]
description: >-
An optional list of cross-frame message origins. They must have
https: protocol otherwise they will be ignored. Example:
https:www.example.com
- name: isSupported()
uid: '@microsoft/teams-js.pages.isSupported'
package: '@microsoft/teams-js'
summary: Checks if the pages capability is supported by the host
remarks: ''
isDeprecated: false
syntax:
content: 'function isSupported(): boolean'
return:
description: boolean to represent whether the appEntity capability is supported
type: boolean
- name: navigateCrossDomain(string)
uid: '@microsoft/teams-js.pages.navigateCrossDomain'
package: '@microsoft/teams-js'
summary: ''
remarks: ''
isDeprecated: true
customDeprecatedMessage: >-
As of 2.0.0, this API is deprecated and can be replaced by the standard
JavaScript
API, window.location.href, when navigating the app to a new cross-domain
URL. Any URL
that is redirected to must be listed in the validDomains block of the
manifest. Please
remove any calls to this API.
syntax:
content: 'function navigateCrossDomain(url: string): Promise<void>'
parameters:
- id: url
type: string
description: The URL to navigate the frame to.
return:
description: Promise that resolves when the navigation has completed.
type: Promise<void>
- name: navigateToApp(NavigateToAppParams)
uid: '@microsoft/teams-js.pages.navigateToApp'
package: '@microsoft/teams-js'
summary: >-
Used to navigate to apps other than your own.
If you are looking to navigate within your own app, use
[navigateToDefaultPage](xref:@microsoft/teams-js.pages.currentApp.navigateToDefaultPage)
or [navigateTo](xref:@microsoft/teams-js.pages.currentApp.navigateTo)
remarks: ''
isDeprecated: false
syntax:
content: 'function navigateToApp(params: NavigateToAppParams): Promise<void>'
parameters:
- id: params
type: <xref uid="@microsoft/teams-js.pages.NavigateToAppParams" />
description: Parameters for the navigation
return:
description: >-
a `Promise` that will resolve if the navigation was successful or
reject if it was not
type: Promise<void>
- name: registerFullScreenHandler(fullScreenChangeFunctionType)
uid: '@microsoft/teams-js.pages.registerFullScreenHandler'
package: '@microsoft/teams-js'
summary: >-
Registers a handler for changes from or to full-screen view for a tab.
Only one handler can be registered at a time. A subsequent registration
replaces an existing registration.
On hosts where there is no support for making an app full screen, the
handler registered
with this function will never be called.
remarks: ''
isDeprecated: false
syntax:
content: >-
function registerFullScreenHandler(handler:
fullScreenChangeFunctionType)
parameters:
- id: handler
type: >-
<xref uid="@microsoft/teams-js.pages.fullScreenChangeFunctionType"
/>
description: >-
The handler to invoke when the user toggles full-screen view for a
tab.
- name: returnFocus(boolean)
uid: '@microsoft/teams-js.pages.returnFocus'
package: '@microsoft/teams-js'
summary: ''
remarks: ''
isDeprecated: true
customDeprecatedMessage: >-
Return focus to the host. Will move focus forward or backward based on
where the application container falls in
the F6/tab order in the host.
On mobile hosts or hosts where there is no keyboard interaction or UI
notion of "focus" this function has no
effect and will be a no-op when called.
syntax:
content: 'function returnFocus(navigateForward?: boolean)'
parameters:
- id: navigateForward
type: boolean
description: Determines the direction to focus in host.
- name: returnFocus(ReturnFocusType)
uid: '@microsoft/teams-js.pages.returnFocus_1'
package: '@microsoft/teams-js'
summary: >-
Return focus to the host. Will attempt to send focus to the appropriate
part of the host (as specified by returnFocusType) based on where the
application container falls in
the F6/tab order in the host.
On mobile hosts or hosts where there is no keyboard interaction or UI
notion of "focus" this function has no
effect and will be a no-op when called.
remarks: ''
isDeprecated: false
syntax:
content: 'function returnFocus(returnFocusType: ReturnFocusType)'
parameters:
- id: returnFocusType
type: <xref uid="@microsoft/teams-js.pages.ReturnFocusType" />
description: Determines the type of focus to return to in the host.
- name: setCurrentFrame(FrameInfo)
uid: '@microsoft/teams-js.pages.setCurrentFrame'
package: '@microsoft/teams-js'
summary: Sets/Updates the current frame with new information
remarks: ''
isDeprecated: false
syntax:
content: 'function setCurrentFrame(frameInfo: FrameInfo)'
parameters:
- id: frameInfo
type: <xref uid="@microsoft/teams-js.FrameInfo" />
description: >-
Frame information containing the URL used in the iframe on reload
and the URL for when the
user clicks 'Go To Website'
- name: shareDeepLink(ShareDeepLinkParameters)
uid: '@microsoft/teams-js.pages.shareDeepLink'
package: '@microsoft/teams-js'
summary: >-
Shares a deep link that a user can use to navigate back to a specific
state in this page.
Please note that this method does not yet work on mobile hosts.
remarks: ''
isDeprecated: false
syntax:
content: 'function shareDeepLink(deepLinkParameters: ShareDeepLinkParameters)'
parameters:
- id: deepLinkParameters
type: <xref uid="@microsoft/teams-js.ShareDeepLinkParameters" />
description: ID and label for the link and fallback URL.