olp::authentication::SignOutResult Class Reference

A response to your sign-out operation. More...

#include <SignOutResult.h>

Public Member Functions
virtual	~SignOutResult ()
	A default destructor.
	SignOutResult () noexcept
	A default constructor.
int	GetStatus () const
	Gets the HTTP status code. More...
const ErrorResponse &	GetErrorResponse () const
	Gets an error description. More...
const ErrorFields &	GetErrorFields () const
	Gets a list of all specific input field errors. More...

Friends
class	AuthenticationClientImpl

Detailed Description

A response to your sign-out operation.

Contains the following results of your sign-out request: status ( GetStatus ) and, in case of an unsuccessful sign-out operation, the error description ( GetErrorResponse ) and input field errors ( GetErrorFields ).

Member Function Documentation

GetErrorFields()

const ErrorFields& olp::authentication::SignOutResult::GetErrorFields

(

)

const

Gets a list of all specific input field errors.

Returns

The list of input field errors.

GetErrorResponse()

const ErrorResponse& olp::authentication::SignOutResult::GetErrorResponse

(

)

const

Gets an error description.

Returns

The error description of the failed request.

GetStatus()

int olp::authentication::SignOutResult::GetStatus

(

)

const

Gets the HTTP status code.

Returns

The status code of the HTTP response if a positive value is returned. A negative value indicates a possible networking error. If you get the negative value, retry the request.

---

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

• olp-cpp-sdk-authentication/include/olp/authentication/SignOutResult.h