-
Notifications
You must be signed in to change notification settings - Fork 7
/
RedirectHandler.yml
130 lines (130 loc) · 4.18 KB
/
RedirectHandler.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
### YamlMime:TSType
name: RedirectHandler
uid: '@azure/msal-browser.RedirectHandler'
package: '@azure/msal-browser'
summary: ''
fullName: RedirectHandler
remarks: ''
isPreview: false
isDeprecated: false
type: class
constructors:
- name: >-
RedirectHandler(AuthorizationCodeClient, BrowserCacheManager,
CommonAuthorizationCodeRequest, Logger, ICrypto)
uid: '@azure/msal-browser.RedirectHandler.constructor'
package: '@azure/msal-browser'
summary: ''
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
new RedirectHandler(authCodeModule: AuthorizationCodeClient,
storageImpl: BrowserCacheManager, authCodeRequest:
CommonAuthorizationCodeRequest, logger: Logger, browserCrypto: ICrypto)
parameters:
- id: authCodeModule
type: AuthorizationCodeClient
description: ''
- id: storageImpl
type: <xref uid="@azure/msal-browser.BrowserCacheManager" />
description: ''
- id: authCodeRequest
type: CommonAuthorizationCodeRequest
description: ''
- id: logger
type: Logger
description: ''
- id: browserCrypto
type: ICrypto
description: ''
inheritedMethods:
- name: >-
handleCodeResponseFromServer(AuthorizationCodePayload, string, Authority,
INetworkModule, boolean)
uid: '@azure/msal-browser.RedirectHandler.handleCodeResponseFromServer'
package: '@azure/msal-browser'
summary: Process auth code response from AAD
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function handleCodeResponseFromServer(authCodeResponse:
AuthorizationCodePayload, state: string, authority: Authority,
networkModule: INetworkModule, validateNonce?: boolean):
Promise<AuthenticationResult>
parameters:
- id: authCodeResponse
type: AuthorizationCodePayload
description: ''
- id: state
type: string
description: ''
- id: authority
type: Authority
description: ''
- id: networkModule
type: INetworkModule
description: ''
- id: validateNonce
type: boolean
description: ''
return:
description: ''
type: Promise<AuthenticationResult>
inheritanceDescription: >-
<b>Inherited From</b>
[InteractionHandler.handleCodeResponseFromServer](xref:@azure/msal-browser.InteractionHandler.handleCodeResponseFromServer)
methods:
- name: 'handleCodeResponseFromHash(string, string, Authority, INetworkModule)'
uid: '@azure/msal-browser.RedirectHandler.handleCodeResponseFromHash'
package: '@azure/msal-browser'
summary: Handle authorization code response in the window.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function handleCodeResponseFromHash(locationHash: string, state: string,
authority: Authority, networkModule: INetworkModule):
Promise<AuthenticationResult>
parameters:
- id: locationHash
type: string
description: ''
- id: state
type: string
description: ''
- id: authority
type: Authority
description: ''
- id: networkModule
type: INetworkModule
description: ''
return:
description: ''
type: Promise<AuthenticationResult>
- name: 'initiateAuthRequest(string, RedirectParams)'
uid: '@azure/msal-browser.RedirectHandler.initiateAuthRequest'
package: '@azure/msal-browser'
summary: Redirects window to given URL.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function initiateAuthRequest(requestUrl: string, params:
RedirectParams): Promise<void>
parameters:
- id: requestUrl
type: string
description: ''
- id: params
type: <xref uid="@azure/msal-browser.RedirectParams" />
description: ''
return:
description: ''
type: Promise<void>
extends: <xref uid="@azure/msal-browser.InteractionHandler" />