-
Notifications
You must be signed in to change notification settings - Fork 7
/
RedirectClient.yml
142 lines (138 loc) · 4.72 KB
/
RedirectClient.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
### YamlMime:TSType
name: RedirectClient
uid: '@azure/msal-browser.RedirectClient'
package: '@azure/msal-browser'
summary: ''
fullName: RedirectClient
remarks: ''
isPreview: false
isDeprecated: false
type: class
constructors:
- name: >-
RedirectClient(BrowserConfiguration, BrowserCacheManager, ICrypto, Logger,
EventHandler, INavigationClient, IPerformanceClient, BrowserCacheManager,
NativeMessageHandler, string)
uid: '@azure/msal-browser.RedirectClient.constructor'
package: '@azure/msal-browser'
summary: ''
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
new RedirectClient(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.RedirectClient.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(RedirectRequest)
uid: '@azure/msal-browser.RedirectClient.acquireToken'
package: '@azure/msal-browser'
summary: Redirects the page to the /authorize endpoint of the IDP
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function acquireToken(request: RedirectRequest): Promise<void>'
parameters:
- id: request
type: <xref uid="@azure/msal-browser.RedirectRequest" />
description: |+
return:
description: ''
type: Promise<void>
- name: handleRedirectPromise(string)
uid: '@azure/msal-browser.RedirectClient.handleRedirectPromise'
package: '@azure/msal-browser'
summary: |-
Checks if navigateToLoginRequestUrl is set, and:
- if true, performs logic to cache and navigate
- if false, handles hash string and parses response
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function handleRedirectPromise(hash?: string):
Promise<AuthenticationResult | null>
parameters:
- id: hash
type: string
description: |+
return:
description: ''
type: Promise<AuthenticationResult | null>
- name: logout(EndSessionRequest)
uid: '@azure/msal-browser.RedirectClient.logout'
package: '@azure/msal-browser'
summary: >-
Use to log out the current user, and redirect the user to the
postLogoutRedirectUri.
Default behaviour is to redirect the user to `window.location.href`.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function logout(logoutRequest?: EndSessionRequest): Promise<void>'
parameters:
- id: logoutRequest
type: <xref uid="@azure/msal-browser.EndSessionRequest" />
description: |+
return:
description: ''
type: Promise<void>
extends: <xref uid="@azure/msal-browser.StandardInteractionClient" />