-
Notifications
You must be signed in to change notification settings - Fork 255
/
com.microsoft.aad.adal.AuthenticationException.yml
188 lines (173 loc) · 10.5 KB
/
com.microsoft.aad.adal.AuthenticationException.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
### YamlMime:JavaType
constructors:
- fullName: com.microsoft.aad.adal.AuthenticationException.AuthenticationException()
name: AuthenticationException()
nameWithType: AuthenticationException.AuthenticationException()
summary: <p>Default constructor for <xref uid="com.microsoft.aad.adal.AuthenticationException" data-throw-if-not-resolved="false" data-raw-source="AuthenticationException"></xref>. </p>
syntax: public AuthenticationException()
uid: com.microsoft.aad.adal.AuthenticationException.AuthenticationException()
- fullName: com.microsoft.aad.adal.AuthenticationException.AuthenticationException(ADALError code)
name: AuthenticationException(ADALError code)
nameWithType: AuthenticationException.AuthenticationException(ADALError code)
parameters:
- description: >-
<p>
<xref uid="com.microsoft.aad.adal.ADALError" data-throw-if-not-resolved="false" data-raw-source="ADALError"></xref>
</p>
name: code
type: <xref href="com.microsoft.aad.adal.ADALError?alt=com.microsoft.aad.adal.ADALError&text=ADALError" data-throw-if-not-resolved="False"/>
summary: >-
<p>Constructs a new AuthenticationException with error code.</p>
<p></p>
syntax: public AuthenticationException(ADALError code)
uid: com.microsoft.aad.adal.AuthenticationException.AuthenticationException(ADALError)
- fullName: com.microsoft.aad.adal.AuthenticationException.AuthenticationException(ADALError code, String details)
name: AuthenticationException(ADALError code, String details)
nameWithType: AuthenticationException.AuthenticationException(ADALError code, String details)
parameters:
- description: <p>Resource file related error code. Message will be derived from resource with using app context </p>
name: code
type: <xref href="com.microsoft.aad.adal.ADALError?alt=com.microsoft.aad.adal.ADALError&text=ADALError" data-throw-if-not-resolved="False"/>
- description: <p>Details related to the error such as query string, request info </p>
name: details
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
syntax: public AuthenticationException(ADALError code, String details)
uid: com.microsoft.aad.adal.AuthenticationException.AuthenticationException(ADALError,String)
- fullName: com.microsoft.aad.adal.AuthenticationException.AuthenticationException(ADALError code, String details, HttpWebResponse response)
name: AuthenticationException(ADALError code, String details, HttpWebResponse response)
nameWithType: AuthenticationException.AuthenticationException(ADALError code, String details, HttpWebResponse response)
parameters:
- description: <p>Resource file related error code. Message will be derived from resource using app context </p>
name: code
type: <xref href="com.microsoft.aad.adal.ADALError?alt=com.microsoft.aad.adal.ADALError&text=ADALError" data-throw-if-not-resolved="False"/>
- description: <p>Details related to the error such as query string, request info. </p>
name: details
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
- description: <p>HTTP web response </p>
name: response
type: <xref href="HttpWebResponse?alt=HttpWebResponse&text=HttpWebResponse" data-throw-if-not-resolved="False"/>
syntax: public AuthenticationException(ADALError code, String details, HttpWebResponse response)
uid: com.microsoft.aad.adal.AuthenticationException.AuthenticationException(ADALError,String,HttpWebResponse)
- fullName: com.microsoft.aad.adal.AuthenticationException.AuthenticationException(ADALError code, String details, HttpWebResponse response, Throwable throwable)
name: AuthenticationException(ADALError code, String details, HttpWebResponse response, Throwable throwable)
nameWithType: AuthenticationException.AuthenticationException(ADALError code, String details, HttpWebResponse response, Throwable throwable)
parameters:
- description: <p>Resource file related error code. Message will be derived from resource using app context </p>
name: code
type: <xref href="com.microsoft.aad.adal.ADALError?alt=com.microsoft.aad.adal.ADALError&text=ADALError" data-throw-if-not-resolved="False"/>
- description: <p>Details related to the error such as query string, request info. </p>
name: details
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
- description: <p>HTTP web response </p>
name: response
type: <xref href="HttpWebResponse?alt=HttpWebResponse&text=HttpWebResponse" data-throw-if-not-resolved="False"/>
- description: >-
<p>
<xref uid="" data-throw-if-not-resolved="false" data-raw-source="Throwable"></xref>
</p>
name: throwable
type: <xref href="Throwable?alt=Throwable&text=Throwable" data-throw-if-not-resolved="False"/>
syntax: public AuthenticationException(ADALError code, String details, HttpWebResponse response, Throwable throwable)
uid: com.microsoft.aad.adal.AuthenticationException.AuthenticationException(ADALError,String,HttpWebResponse,Throwable)
- fullName: com.microsoft.aad.adal.AuthenticationException.AuthenticationException(ADALError code, String details, Throwable throwable)
name: AuthenticationException(ADALError code, String details, Throwable throwable)
nameWithType: AuthenticationException.AuthenticationException(ADALError code, String details, Throwable throwable)
parameters:
- description: <p>Resource file related error code. Message will be derived from resource with using app context </p>
name: code
type: <xref href="com.microsoft.aad.adal.ADALError?alt=com.microsoft.aad.adal.ADALError&text=ADALError" data-throw-if-not-resolved="False"/>
- description: <p>Details related to the error such as query string, request info </p>
name: details
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
- description: >-
<p>
<xref uid="" data-throw-if-not-resolved="false" data-raw-source="Throwable"></xref>
</p>
name: throwable
type: <xref href="Throwable?alt=Throwable&text=Throwable" data-throw-if-not-resolved="False"/>
syntax: public AuthenticationException(ADALError code, String details, Throwable throwable)
uid: com.microsoft.aad.adal.AuthenticationException.AuthenticationException(ADALError,String,Throwable)
inheritances:
- <xref href="java.lang.Object" data-throw-if-not-resolved="False"/>
- <xref href="Exception" data-throw-if-not-resolved="False"/>
methods:
- fullName: com.microsoft.aad.adal.AuthenticationException.getCode()
name: getCode()
nameWithType: AuthenticationException.getCode()
returns:
description: >-
<p>
<xref uid="com.microsoft.aad.adal.ADALError" data-throw-if-not-resolved="false" data-raw-source="ADALError"></xref> code </p>
type: <xref href="com.microsoft.aad.adal.ADALError?alt=com.microsoft.aad.adal.ADALError&text=ADALError" data-throw-if-not-resolved="False"/>
summary: >-
<p>Gets <xref uid="com.microsoft.aad.adal.ADALError" data-throw-if-not-resolved="false" data-raw-source="ADALError"></xref> code.</p>
<p></p>
syntax: public ADALError getCode()
uid: com.microsoft.aad.adal.AuthenticationException.getCode()
- fullName: com.microsoft.aad.adal.AuthenticationException.getHttpResponseBody()
name: getHttpResponseBody()
nameWithType: AuthenticationException.getHttpResponseBody()
returns:
description: <p>response body map, null if not initialized. </p>
type: <xref href="HashMap%3CString%2C+String%3E?alt=HashMap%3CString%2C+String%3E&text=HashMap%3CString%2C+String%3E" data-throw-if-not-resolved="False"/>
summary: >-
<p>Gets the response body that may be returned by the service.</p>
<p></p>
syntax: public HashMap<String, String> getHttpResponseBody()
uid: com.microsoft.aad.adal.AuthenticationException.getHttpResponseBody()
- fullName: com.microsoft.aad.adal.AuthenticationException.getHttpResponseHeaders()
name: getHttpResponseHeaders()
nameWithType: AuthenticationException.getHttpResponseHeaders()
returns:
description: <p>The response headers for the network call, null if not initialized. </p>
type: <xref href="HashMap%3CString%2C+List%3CString%3E%3E?alt=HashMap%3CString%2C+List%3CString%3E%3E&text=HashMap%3CString%2C+List%3CString%3E%3E" data-throw-if-not-resolved="False"/>
summary: >-
<p>Get the response headers that indicated an error.</p>
<p></p>
syntax: public HashMap<String, List<String>> getHttpResponseHeaders()
uid: com.microsoft.aad.adal.AuthenticationException.getHttpResponseHeaders()
- fullName: com.microsoft.aad.adal.AuthenticationException.getLocalizedMessage(Context context)
name: getLocalizedMessage(Context context)
nameWithType: AuthenticationException.getLocalizedMessage(Context context)
parameters:
- description: >-
<p>
<xref uid="" data-throw-if-not-resolved="false" data-raw-source="Context"></xref>
</p>
name: context
type: <xref href="Context?alt=Context&text=Context" data-throw-if-not-resolved="False"/>
returns:
description: <p>Error message </p>
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
summary: >-
<p>Gets localized <xref uid="com.microsoft.aad.adal.ADALError" data-throw-if-not-resolved="false" data-raw-source="ADALError"></xref> code if provided by context.</p>
<p></p>
syntax: public String getLocalizedMessage(Context context)
uid: com.microsoft.aad.adal.AuthenticationException.getLocalizedMessage(Context)
- fullName: com.microsoft.aad.adal.AuthenticationException.getMessage()
name: getMessage()
nameWithType: AuthenticationException.getMessage()
returns:
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
syntax: public String getMessage()
uid: com.microsoft.aad.adal.AuthenticationException.getMessage()
- fullName: com.microsoft.aad.adal.AuthenticationException.getServiceStatusCode()
name: getServiceStatusCode()
nameWithType: AuthenticationException.getServiceStatusCode()
returns:
description: <p>status code from http layer. Return -1 if status code is not initialized. </p>
type: <xref href="int?alt=int&text=int" data-throw-if-not-resolved="False"/>
summary: >-
<p>Gets the status code returned from http layer.</p>
<p></p>
syntax: public int getServiceStatusCode()
uid: com.microsoft.aad.adal.AuthenticationException.getServiceStatusCode()
nameWithType: AuthenticationException
syntax: public class AuthenticationException
type: class
uid: com.microsoft.aad.adal.AuthenticationException
fullName: com.microsoft.aad.adal.AuthenticationException
name: AuthenticationException
package: com.microsoft.aad.adal
summary: <p>ADAL exception. </p>
metadata: {}