-
Notifications
You must be signed in to change notification settings - Fork 6
/
StandardInteractionClient.yml
122 lines (122 loc) · 4.41 KB
/
StandardInteractionClient.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
### YamlMime:TSType
name: StandardInteractionClient
uid: '@azure/msal-browser.StandardInteractionClient'
package: '@azure/msal-browser'
summary: >-
Defines the class structure and helper functions used by the "standard",
non-brokered auth flows (popup, redirect, silent (RT), silent (iframe))
fullName: StandardInteractionClient
remarks: ''
isPreview: false
isDeprecated: false
type: class
constructors:
- name: >-
StandardInteractionClient(BrowserConfiguration, BrowserCacheManager,
ICrypto, Logger, EventHandler, INavigationClient, IPerformanceClient,
NativeMessageHandler, string)
uid: '@azure/msal-browser.StandardInteractionClient.constructor'
package: '@azure/msal-browser'
summary: ''
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
new StandardInteractionClient(config: BrowserConfiguration, storageImpl:
BrowserCacheManager, browserCrypto: ICrypto, logger: Logger,
eventHandler: EventHandler, navigationClient: INavigationClient,
performanceClient: IPerformanceClient, 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: nativeMessageHandler
type: <xref uid="@azure/msal-browser.NativeMessageHandler" />
description: ''
- id: correlationId
type: string
description: ''
inheritedMethods:
- name: acquireToken(RedirectRequest | PopupRequest | SsoSilentRequest)
uid: '@azure/msal-browser.StandardInteractionClient.acquireToken'
package: '@azure/msal-browser'
summary: ''
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function acquireToken(request: RedirectRequest | PopupRequest |
SsoSilentRequest): Promise<AuthenticationResult | void>
parameters:
- id: request
type: >-
<xref uid="@azure/msal-browser.RedirectRequest" /> | <xref
uid="@azure/msal-browser.PopupRequest" /> | <xref
uid="@azure/msal-browser.SsoSilentRequest" />
description: ''
return:
description: ''
type: Promise<AuthenticationResult | void>
inheritanceDescription: >-
<b>Inherited From</b>
[BaseInteractionClient.acquireToken](xref:@azure/msal-browser.BaseInteractionClient.acquireToken)
- name: getRedirectUri(string)
uid: '@azure/msal-browser.StandardInteractionClient.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)
- name: logout(EndSessionRequest)
uid: '@azure/msal-browser.StandardInteractionClient.logout'
package: '@azure/msal-browser'
summary: ''
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function logout(request: EndSessionRequest): Promise<void>'
parameters:
- id: request
type: <xref uid="@azure/msal-browser.EndSessionRequest" />
description: ''
return:
description: ''
type: Promise<void>
inheritanceDescription: >-
<b>Inherited From</b>
[BaseInteractionClient.logout](xref:@azure/msal-browser.BaseInteractionClient.logout)
extends: <xref uid="@azure/msal-browser.BaseInteractionClient" />