A response to a client or user sign-in operation. More...

#include <SignInResult.h>

Inheritance diagram for olp::authentication::SignInResult:

Public Member Functions
virtual	~SignInResult ()
	A default destructor.

	SignInResult () noexcept
	A default constructor.

int	GetStatus () const
	Gets an 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...

const std::string &	GetFullMessage () const
	Gets a full response message. More...

const std::string &	GetAccessToken () const
	Gets an access token. More...

const std::string &	GetTokenType () const
	Gets the access token type. More...

const std::string &	GetRefreshToken () const
	Gets a refresh token. More...

time_t	GetExpiryTime () const
	Gets the access token expiry time. More...

std::chrono::seconds	GetExpiresIn () const
	Gets the access token expiry time. More...

const std::string &	GetUserIdentifier () const
	Gets the HERE Account user identifier. More...

const std::string &	GetScope () const
	Gets the scope that is assigned to the access token. More...

Friends
class	SignInUserResult

class	AuthenticationClientImpl

class	TokenEndpointImpl

Detailed Description

A response to a client or user sign-in operation.

Member Function Documentation

◆ GetAccessToken()

const std::string& olp::authentication::SignInResult::GetAccessToken ( ) const

Gets an access token.

Returns: The string that contains the new HERE Account client or user access token that identifies the signed-in client or user.

◆ GetErrorFields()

const ErrorFields& olp::authentication::SignInResult::GetErrorFields ( ) const

Gets a list of all specific input field errors.

Returns: The list of input field errors.

◆ GetErrorResponse()

const ErrorResponse& olp::authentication::SignInResult::GetErrorResponse ( ) const

Gets an error description.

Returns: The error description of the failed request.

◆ GetExpiresIn()

std::chrono::seconds olp::authentication::SignInResult::GetExpiresIn ( ) const

Gets the access token expiry time.

Returns: The expiry time of the access token.

◆ GetExpiryTime()

time_t olp::authentication::SignInResult::GetExpiryTime ( ) const

Gets the access token expiry time.

Returns: The Epoch time when the token expires, or -1 if the token is invalid.

◆ GetFullMessage()

const std::string& olp::authentication::SignInResult::GetFullMessage ( ) const

Gets a full response message.

Returns: A string representation of a full json network response if it contains an error, an empty string otherwise.

◆ GetRefreshToken()

const std::string& olp::authentication::SignInResult::GetRefreshToken ( ) const

Gets a refresh token.

Returns: The string with the token that is used to get a new access token via the refresh API. The refresh token is always issued as a part of a response to a user sign-in operation.

◆ GetScope()

const std::string& olp::authentication::SignInResult::GetScope ( ) const

Gets the scope that is assigned to the access token.

Returns: The string that contains the scope assigned to the access token.

◆ GetStatus()

int olp::authentication::SignInResult::GetStatus ( ) const

Gets an 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.

◆ GetTokenType()

const std::string& olp::authentication::SignInResult::GetTokenType ( ) const

Gets the access token type.

Returns: The string containing the access token type (always a bearer token).

◆ GetUserIdentifier()

const std::string& olp::authentication::SignInResult::GetUserIdentifier ( ) const

Gets the HERE Account user identifier.

Returns: The string that contains the HERE Account user ID.

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

olp-cpp-sdk-authentication/include/olp/authentication/SignInResult.h

Public Member Functions

Friends