A response to the sign-up operation with your HERE Account user ID. More...

#include <SignUpResult.h>

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

	SignUpResult () 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...

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

Friends
class	AuthenticationClientImpl

Detailed Description

A response to the sign-up operation with your HERE Account user ID.

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

Member Function Documentation

◆ GetErrorFields()

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

Gets a list of all specific input field errors.

Returns: The list of input field errors.

◆ GetErrorResponse()

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

Gets an error description.

Returns: The error description of the failed request.

◆ GetStatus()

int olp::authentication::SignUpResult::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.

◆ GetUserIdentifier()

const std::string& olp::authentication::SignUpResult::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/SignUpResult.h