-
Notifications
You must be signed in to change notification settings - Fork 6
/
PopupClient.yml
269 lines (264 loc) · 8.58 KB
/
PopupClient.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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
### YamlMime:TSType
name: PopupClient
uid: '@azure/msal-browser.PopupClient'
package: '@azure/msal-browser'
summary: ''
fullName: PopupClient
remarks: ''
isPreview: false
isDeprecated: false
type: class
constructors:
- name: >-
PopupClient(BrowserConfiguration, BrowserCacheManager, ICrypto, Logger,
EventHandler, INavigationClient, IPerformanceClient, BrowserCacheManager,
NativeMessageHandler, string)
uid: '@azure/msal-browser.PopupClient.constructor'
package: '@azure/msal-browser'
summary: ''
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
new PopupClient(config: BrowserConfiguration, storageImpl:
BrowserCacheManager, browserCrypto: ICrypto, logger: Logger,
eventHandler: EventHandler, navigationClient: INavigationClient,
performanceClient: IPerformanceClient, nativeStorageImpl:
BrowserCacheManager, nativeMessageHandler?: NativeMessageHandler,
correlationId?: string)
parameters:
- id: config
type: <xref uid="@azure/msal-browser.BrowserConfiguration" />
description: ''
- id: storageImpl
type: <xref uid="@azure/msal-browser.BrowserCacheManager" />
description: ''
- id: browserCrypto
type: ICrypto
description: ''
- id: logger
type: Logger
description: ''
- id: eventHandler
type: <xref uid="@azure/msal-browser.EventHandler" />
description: ''
- id: navigationClient
type: <xref uid="@azure/msal-browser.INavigationClient" />
description: ''
- id: performanceClient
type: IPerformanceClient
description: ''
- id: nativeStorageImpl
type: <xref uid="@azure/msal-browser.BrowserCacheManager" />
description: ''
- id: nativeMessageHandler
type: <xref uid="@azure/msal-browser.NativeMessageHandler" />
description: ''
- id: correlationId
type: string
description: ''
inheritedMethods:
- name: getRedirectUri(string)
uid: '@azure/msal-browser.PopupClient.getRedirectUri'
package: '@azure/msal-browser'
summary: Use to get the redirect uri configured in MSAL or null.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function getRedirectUri(requestRedirectUri?: string): string'
parameters:
- id: requestRedirectUri
type: string
description: ''
return:
description: Redirect URL
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[BaseInteractionClient.getRedirectUri](xref:@azure/msal-browser.BaseInteractionClient.getRedirectUri)
methods:
- name: acquireToken(PopupRequest)
uid: '@azure/msal-browser.PopupClient.acquireToken'
package: '@azure/msal-browser'
summary: >-
Acquires tokens by opening a popup window to the /authorize endpoint of
the authority
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function acquireToken(request: PopupRequest):
Promise<AuthenticationResult>
parameters:
- id: request
type: <xref uid="@azure/msal-browser.PopupRequest" />
description: |+
return:
description: ''
type: Promise<AuthenticationResult>
- name: cleanPopup(Window)
uid: '@azure/msal-browser.PopupClient.cleanPopup'
package: '@azure/msal-browser'
summary: 'Closes popup, removes any state vars created during popup calls.'
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function cleanPopup(popupWindow?: Window)'
parameters:
- id: popupWindow
type: Window
description: |+
- name: generateLogoutPopupName(CommonEndSessionRequest)
uid: '@azure/msal-browser.PopupClient.generateLogoutPopupName'
package: '@azure/msal-browser'
summary: >-
Generates the name for the popup based on the client id and request for
logouts
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function generateLogoutPopupName(request: CommonEndSessionRequest):
string
parameters:
- id: request
type: CommonEndSessionRequest
description: |+
return:
description: ''
type: string
- name: 'generatePopupName(Array<string>, string)'
uid: '@azure/msal-browser.PopupClient.generatePopupName'
package: '@azure/msal-browser'
summary: Generates the name for the popup based on the client id and request
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function generatePopupName(scopes: Array<string>, authority: string):
string
parameters:
- id: scopes
type: Array<string>
description: ''
- id: authority
type: string
description: ''
return:
description: ''
type: string
- name: 'initiateAuthRequest(string, PopupParams)'
uid: '@azure/msal-browser.PopupClient.initiateAuthRequest'
package: '@azure/msal-browser'
summary: Opens a popup window with given request Url.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function initiateAuthRequest(requestUrl: string, params: PopupParams):
Window
parameters:
- id: requestUrl
type: string
description: |+
- id: params
type: <xref uid="@azure/msal-browser.PopupParams" />
description: ''
return:
description: ''
type: Window
- name: logout(EndSessionPopupRequest)
uid: '@azure/msal-browser.PopupClient.logout'
package: '@azure/msal-browser'
summary: >-
Clears local cache for the current user then opens a popup window
prompting the user to sign-out of the server
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function logout(logoutRequest?: EndSessionPopupRequest): Promise<void>'
parameters:
- id: logoutRequest
type: <xref uid="@azure/msal-browser.EndSessionPopupRequest" />
description: |+
return:
description: ''
type: Promise<void>
- name: monitorPopupForHash(Window)
uid: '@azure/msal-browser.PopupClient.monitorPopupForHash'
package: '@azure/msal-browser'
summary: Monitors a window until it loads a url with the same origin.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function monitorPopupForHash(popupWindow: Window): Promise<string>'
parameters:
- id: popupWindow
type: Window
description: window that is being monitored
return:
description: ''
type: Promise<string>
- name: 'openSizedPopup(string, string, PopupWindowAttributes)'
uid: '@azure/msal-browser.PopupClient.openSizedPopup'
package: '@azure/msal-browser'
summary: Helper function to set popup window dimensions and position
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function openSizedPopup(urlNavigate: string, popupName: string,
popupWindowAttributes: PopupWindowAttributes): Window | null
parameters:
- id: urlNavigate
type: string
description: ''
- id: popupName
type: string
description: ''
- id: popupWindowAttributes
type: <xref uid="@azure/msal-browser.PopupWindowAttributes" />
description: ''
return:
description: ''
type: Window | null
- name: unloadWindow(Event)
uid: '@azure/msal-browser.PopupClient.unloadWindow'
package: '@azure/msal-browser'
summary: Event callback to unload main window.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function unloadWindow(e: Event)'
parameters:
- id: e
type: Event
description: ''
- name: waitForLogoutPopup(Window)
uid: '@azure/msal-browser.PopupClient.waitForLogoutPopup'
package: '@azure/msal-browser'
summary: Waits for user interaction in logout popup window
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function waitForLogoutPopup(popupWindow: Window): Promise<void>'
parameters:
- id: popupWindow
type: Window
description: ''
return:
description: ''
type: Promise<void>
extends: <xref uid="@azure/msal-browser.StandardInteractionClient" />