A response to your sign-in operation. More...
#include <SignInUserResult.h>
Inheritance diagram for olp::authentication::SignInUserResult:
Collaboration diagram for olp::authentication::SignInUserResult:
Public Member Functions | |
| ~SignInUserResult () override | |
| A default destructor. | |
| SignInUserResult () noexcept | |
| A default constructor. | |
| const std::string & | GetTermAcceptanceToken () const |
| Gets the terms acceptance token. More... | |
| const std::string & | GetTermsOfServiceUrl () const |
| Gets the URL of the terms of service. More... | |
| const std::string & | GetTermsOfServiceUrlJson () const |
| Gets the URL of the most recent JSON version of the terms of service. More... | |
| const std::string & | GetPrivatePolicyUrl () const |
| Gets the most recent privacy policy URL. More... | |
| const std::string & | GetPrivatePolicyUrlJson () const |
| Gets the URL of the most recent privacy policy JSON. More... | |
 Public Member Functions inherited from olp::authentication::SignInResult | |
| 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 | AuthenticationClientImpl |
Detailed Description
A response to your sign-in operation.
If the HTTP status of 412 (PRECONDITION_FAILED) or 201 (CREATED) is returned, the response returns terms of re-acceptance. Not to receive this response again, accept the latest terms for your country.
Member Function Documentation
◆ GetPrivatePolicyUrl()
| const std::string& olp::authentication::SignInUserResult::GetPrivatePolicyUrl | ( | ) | const |
Gets the most recent privacy policy URL.
- Returns
- The string that contains the URL of the most recent privacy policy appropriate for your country and language (filled in only when the HTTP status is 412 or 201).
◆ GetPrivatePolicyUrlJson()
| const std::string& olp::authentication::SignInUserResult::GetPrivatePolicyUrlJson | ( | ) | const |
Gets the URL of the most recent privacy policy JSON.
- Returns
- The string that contains the URL of the most recent JSON version of the privacy policy appropriate for your country and language (filled in only when the HTTP status is 412 or 201).
◆ GetTermAcceptanceToken()
| const std::string& olp::authentication::SignInUserResult::GetTermAcceptanceToken | ( | ) | const |
Gets the terms acceptance token.
- Returns
- The string that contains the token required for the terms acceptance API (filled in only when the HTTP status is 412 or 201).
◆ GetTermsOfServiceUrl()
| const std::string& olp::authentication::SignInUserResult::GetTermsOfServiceUrl | ( | ) | const |
Gets the URL of the terms of service.
- Returns
- The string that contains the URL of the most recent terms of service appropriate for your country and language (filled in only when the HTTP status is 412 or 201).
◆ GetTermsOfServiceUrlJson()
| const std::string& olp::authentication::SignInUserResult::GetTermsOfServiceUrlJson | ( | ) | const |
Gets the URL of the most recent JSON version of the terms of service.
- Returns
- The string that contains the URL of the most recent JSON version of the terms of service appropriate for your country and language (filled in only when the HTTP status is 412 or 201).
The documentation for this class was generated from the following file:
- olp-cpp-sdk-authentication/include/olp/authentication/SignInUserResult.h
