Authlete
AuthleteApiException Class Reference

Exception that IAuthleteApi methods may throw. More...

Inheritance diagram for AuthleteApiException:

Public Member Functions

 AuthleteApiException (string message, Exception cause, HttpRequestMessage request)
 Constructor without information about an HTTP response. More...
 
 AuthleteApiException (string message, Exception cause, HttpRequestMessage request, HttpStatusCode statusCode, string reasonPhrase, HttpResponseHeaders headers)
 Constructor with some data of an HTTP response. More...
 
 AuthleteApiException (string message, HttpRequestMessage request, HttpStatusCode statusCode, string reasonPhrase, HttpResponseHeaders headers, string body)
 Constructor with some data of an HTTP response. More...
 

Properties

HttpRequestMessage Request [get]
 The HTTP request to the Authlete API. More...
 
HttpStatusCode StatusCode [get]
 The HTTP status code of the response from the Authlete API. This property will return null if an error occurred before the response was properly processed. More...
 
string ReasonPhrase [get]
 The reason phrase of the response from the Authlete API. This property will return null if an error occurred before the response was properly processed. More...
 
HttpResponseHeaders ResponseHeaders [get]
 The HTTP headers of the response from the Authlete API. This property will return null if an error occurred before the response was properly processed. More...
 
string ResponseBody [get]
 The content of the response from the Authlete API. This property will return null if the response did not have any content or if an error occurred before the response was properly processed. More...
 

Detailed Description

Exception that IAuthleteApi methods may throw.

Constructor & Destructor Documentation

◆ AuthleteApiException() [1/3]

AuthleteApiException ( string  message,
Exception  cause,
HttpRequestMessage  request 
)
inline

Constructor without information about an HTTP response.

Parameters
messageAn error message.
Parameters
causeThe cause of this exception.
Parameters
requestThe request to the API that triggered this exception.

◆ AuthleteApiException() [2/3]

AuthleteApiException ( string  message,
Exception  cause,
HttpRequestMessage  request,
HttpStatusCode  statusCode,
string  reasonPhrase,
HttpResponseHeaders  headers 
)
inline

Constructor with some data of an HTTP response.

Parameters
messageAn error message.
Parameters
causeThe cause of this exception.
Parameters
requestThe request to the API that triggered this exception.
Parameters
statusCodeThe HTTP status code of the response from the API.
Parameters
reasonPhraseThe reason phrase of the response from the API.
Parameters
headersThe HTTP headers of the response from the API.

◆ AuthleteApiException() [3/3]

AuthleteApiException ( string  message,
HttpRequestMessage  request,
HttpStatusCode  statusCode,
string  reasonPhrase,
HttpResponseHeaders  headers,
string  body 
)
inline

Constructor with some data of an HTTP response.

Parameters
messageAn error message.
Parameters
requestThe request to the API that triggered this exception.
Parameters
statusCodeThe HTTP status code of the response from the API.
Parameters
reasonPhraseThe reason phrase of the response from the API.
Parameters
headersThe HTTP headers of the response from the API.
Parameters
bodyThe entity body of the response from the API.

Property Documentation

◆ ReasonPhrase

string ReasonPhrase
get

The reason phrase of the response from the Authlete API. This property will return null if an error occurred before the response was properly processed.

◆ Request

HttpRequestMessage Request
get

The HTTP request to the Authlete API.

◆ ResponseBody

string ResponseBody
get

The content of the response from the Authlete API. This property will return null if the response did not have any content or if an error occurred before the response was properly processed.

◆ ResponseHeaders

HttpResponseHeaders ResponseHeaders
get

The HTTP headers of the response from the Authlete API. This property will return null if an error occurred before the response was properly processed.

◆ StatusCode

HttpStatusCode StatusCode
get

The HTTP status code of the response from the Authlete API. This property will return null if an error occurred before the response was properly processed.


The documentation for this class was generated from the following file: