10Duke Scale C++ Client
Loading...
Searching...
No Matches
Public Member Functions | List of all members
tenduke::se::http::APIException Class Reference

#include <APIException.h>

Detailed Description

Base class for exceptions, which are mapped from HTTP-status-codes from 10Duke Scale backend.

Inheritance diagram for tenduke::se::http::APIException:
tenduke::http::HTTPResponseException tenduke::http::HTTPException tenduke::net::NetworkingException tenduke::TendukeException tenduke::se::http::ClientError tenduke::se::http::ServerError tenduke::se::http::BadRequest tenduke::se::http::Conflict tenduke::se::http::Forbidden tenduke::se::http::NotFound tenduke::se::http::TooManyRequests tenduke::se::http::Unauthorized

Public Member Functions

 APIException (const int code, std::string error, const std::string &description)
 Constructs new instance with HTTP status code, error code and description.
 
 APIException (const int code, const std::string &description)
 Constructs new instance with HTTP status code and description.
 
 APIException (const int code)
 Constructs new instance just with HTTP status code.
 
std::string getError () const
 Returns the error code.
 
std::string getDescription () const
 Returns the description.
 
- Public Member Functions inherited from tenduke::http::HTTPResponseException
 HTTPResponseException (int httpStatusCode, const std::string &message)
 Constructs new instance.
 
int getStatusCode () const
 Returns the HTTP status code.
 
- Public Member Functions inherited from tenduke::http::HTTPException
 HTTPException (const std::string &message)
 Constructs new instance.
 
- Public Member Functions inherited from tenduke::net::NetworkingException
 NetworkingException (const std::string &message)
 Constructs new instance.
 
- Public Member Functions inherited from tenduke::TendukeException
 TendukeException (const std::string &message)
 Constructs new instance.
 

Constructor & Destructor Documentation

◆ APIException() [1/3]

tenduke::se::http::APIException::APIException ( const int  code,
std::string  error,
const std::string &  description 
)
inline

Constructs new instance with HTTP status code, error code and description.

Parameters
code-
error-
description-

◆ APIException() [2/3]

tenduke::se::http::APIException::APIException ( const int  code,
const std::string &  description 
)
inline

Constructs new instance with HTTP status code and description.

Parameters
code-
description-

◆ APIException() [3/3]

tenduke::se::http::APIException::APIException ( const int  code)
inlineexplicit

Constructs new instance just with HTTP status code.

Parameters
code-

Member Function Documentation

◆ getDescription()

std::string tenduke::se::http::APIException::getDescription ( ) const
inline

Returns the description.

Returns
-

◆ getError()

std::string tenduke::se::http::APIException::getError ( ) const
inline

Returns the error code.

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