An account information. More...

#include <UserAccountInfoResponse.h>

Public Member Functions
const std::string &	GetUserId () const
	Gets the HERE Account ID of the user. More...

void	SetUserId (std::string user_id)
	Sets the HERE Account ID of the user. More...

const std::string &	GetRealm () const
	Gets the realm in which the user account exists. More...

void	SetRealm (std::string realm)
	Sets the realm in which the user account exists. More...

const std::string &	GetFacebookId () const
	Gets the Facebook ID of the user. More...

void	SetFacebookId (std::string facebook_id)
	Sets the Facebook ID of the user. More...

const std::string &	GetFirstname () const
	Gets the first name of the user. More...

void	SetFirstname (std::string firstname)
	Sets the first name of the user. More...

const std::string &	GetLastname () const
	Gets the last name of the user. More...

void	SetLastname (std::string lastname)
	Sets the last name of the user. More...

const std::string &	GetEmail () const
	Gets the primary email address. More...

void	SetEmail (std::string email)
	Sets the primary email address. More...

const std::string &	GetRecoveryEmail () const
	Gets the recovery email address. More...

void	SetRecoveryEmail (std::string recovery_email)
	Sets the recovery email address. More...

const std::string &	GetDob () const
	Gets the day of birth in the day/month/year format. More...

void	SetDob (std::string dob)
	Sets the day of birth. More...

const std::string &	GetCountryCode () const
	Gets the code of the user's country in the ISO 3166-1 alpha-3 format. More...

void	SetCountryCode (std::string country_code)
	Sets the code of the user's country in the ISO 3166-1 alpha-3 format. More...

const std::string &	GetLanguage () const
	Gets the code of the user's language in the ISO 639-1 2 format. More...

void	SetLanguage (std::string language)
	Sets the code of the user's language in the ISO 639-1 2 format. More...

bool	GetEmailVerified () const
	Gets the verification of the primary email address. More...

void	SetEmailVerified (bool email_verified)
	Sets the verification of the primary email address. More...

const std::string &	GetPhoneNumber () const
	Gets the user's phone number. More...

void	SetPhoneNumber (std::string phone_number)
	Sets the user's phone number. More...

bool	GetPhoneNumberVerified () const
	Gets the verification of the phone number. More...

void	SetPhoneNumberVerified (bool phone_number_verified)
	Sets the verification of the phone number. More...

bool	GetMarketingEnabled () const
	Checks if the marketing is enabled. More...

void	SetMarketingEnabled (bool marketing_enabled)
	Sets the marketing if it is enabled. More...

time_t	GetCreatedTime () const
	Gets the timestamp (milliseconds since the Unix epoch) of when the account was created. More...

void	SetCreatedTime (time_t created_time)
	Sets the timestamp (milliseconds since the Unix epoch) of when the account was created. More...

time_t	GetUpdatedTime () const
	Gets the timestamp (milliseconds since the Unix epoch) of when the account was last updated. More...

void	SetUpdatedTime (time_t updated_time)
	Sets the timestamp (milliseconds since the Unix epoch) of when the account was last updated. More...

const std::string &	GetState () const
	Gets the current state of the account. More...

void	SetState (std::string state)
	Sets the current state of the account. More...

const std::string &	GetHrn () const
	Gets the HRN of the user. More...

void	SetHrn (std::string hrn)
	Sets the HRN of the user. More...

const std::string &	GetAccountType () const
	Gets the account type. More...

void	SetAccountType (std::string account_type)
	Sets the account type. More...

Detailed Description

An account information.

Member Function Documentation

◆ GetAccountType()

const std::string& olp::authentication::model::UserAccountInfoResponse::GetAccountType ( ) const

inline

Gets the account type.

Returns: The account type.

◆ GetCountryCode()

const std::string& olp::authentication::model::UserAccountInfoResponse::GetCountryCode ( ) const

inline

Gets the code of the user's country in the ISO 3166-1 alpha-3 format.

Returns: The country code.

◆ GetCreatedTime()

time_t olp::authentication::model::UserAccountInfoResponse::GetCreatedTime ( ) const

inline

Gets the timestamp (milliseconds since the Unix epoch) of when the account was created.

Returns: The epoch time when the account was created.

◆ GetDob()

const std::string& olp::authentication::model::UserAccountInfoResponse::GetDob ( ) const

inline

Gets the day of birth in the day/month/year format.

Returns: The day of birth.

◆ GetEmail()

const std::string& olp::authentication::model::UserAccountInfoResponse::GetEmail ( ) const

inline

Gets the primary email address.

Returns: The primary email address.

◆ GetEmailVerified()

bool olp::authentication::model::UserAccountInfoResponse::GetEmailVerified ( ) const

inline

Gets the verification of the primary email address.

Note: The user is asked to verify their email on signup, but doing so is optional.

Returns: True if the primary email address was verified; false otherwise.

◆ GetFacebookId()

const std::string& olp::authentication::model::UserAccountInfoResponse::GetFacebookId ( ) const

inline

Gets the Facebook ID of the user.

Note: Not empty only if the account was created as a result of signing up with a Facebook token.

Returns: The Facebook ID of the user.

◆ GetFirstname()

const std::string& olp::authentication::model::UserAccountInfoResponse::GetFirstname ( ) const

inline

Gets the first name of the user.

Returns: The first name of the user.

◆ GetHrn()

const std::string& olp::authentication::model::UserAccountInfoResponse::GetHrn ( ) const

inline

Gets the HRN of the user.

Returns: The user HRN.

◆ GetLanguage()

const std::string& olp::authentication::model::UserAccountInfoResponse::GetLanguage ( ) const

inline

Gets the code of the user's language in the ISO 639-1 2 format.

Returns: The language code.

◆ GetLastname()

const std::string& olp::authentication::model::UserAccountInfoResponse::GetLastname ( ) const

inline

Gets the last name of the user.

Returns: The last name of the user.

◆ GetMarketingEnabled()

bool olp::authentication::model::UserAccountInfoResponse::GetMarketingEnabled ( ) const

inline

Checks if the marketing is enabled.

Returns: True if the marketing is enabled; false otherwise.

◆ GetPhoneNumber()

const std::string& olp::authentication::model::UserAccountInfoResponse::GetPhoneNumber ( ) const

inline

Gets the user's phone number.

Returns: The phone number.

◆ GetPhoneNumberVerified()

bool olp::authentication::model::UserAccountInfoResponse::GetPhoneNumberVerified ( ) const

inline

Gets the verification of the phone number.

Returns: True if the phone number was verified; false otherwise.

◆ GetRealm()

const std::string& olp::authentication::model::UserAccountInfoResponse::GetRealm ( ) const

inline

Gets the realm in which the user account exists.

Returns: The user realm.

◆ GetRecoveryEmail()

const std::string& olp::authentication::model::UserAccountInfoResponse::GetRecoveryEmail ( ) const

inline

Gets the recovery email address.

Returns: The recovery email address.

◆ GetState()

const std::string& olp::authentication::model::UserAccountInfoResponse::GetState ( ) const

inline

Gets the current state of the account.

Note: The list of the possible states of the account: 'deleted' - The account was permanently deleted. 'disabled' - The account was disabled by an administrator. 'locked' - The account was automatically locked due to suspicious activity and will be unlocked after some time. 'enabled' - The account is enabled, and the user can log in.

Returns: The current state of the account.

◆ GetUpdatedTime()

time_t olp::authentication::model::UserAccountInfoResponse::GetUpdatedTime ( ) const

inline

Gets the timestamp (milliseconds since the Unix epoch) of when the account was last updated.

Note: The time is updated when the following user properties are changed: email, recoveryEmail, dob, countryCode, firstname, lastname, language, phoneNumber.

Returns: The epoch time when the account was updated.

◆ GetUserId()

const std::string& olp::authentication::model::UserAccountInfoResponse::GetUserId ( ) const

inline

Gets the HERE Account ID of the user.

Returns: The HERE Account ID of the user.

◆ SetAccountType()

void olp::authentication::model::UserAccountInfoResponse::SetAccountType ( std::string account_type )

inline

Sets the account type.

Parameters

account_type The account type.

◆ SetCountryCode()

void olp::authentication::model::UserAccountInfoResponse::SetCountryCode ( std::string country_code )

inline

Sets the code of the user's country in the ISO 3166-1 alpha-3 format.

Parameters

country_code The country code.

◆ SetCreatedTime()

void olp::authentication::model::UserAccountInfoResponse::SetCreatedTime ( time_t created_time )

inline

Sets the timestamp (milliseconds since the Unix epoch) of when the account was created.

Parameters

created_time The epoch time when the account was created.

◆ SetDob()

void olp::authentication::model::UserAccountInfoResponse::SetDob ( std::string dob )

inline

Sets the day of birth.

Parameters

dob	The day of birth.

◆ SetEmail()

void olp::authentication::model::UserAccountInfoResponse::SetEmail ( std::string email )

inline

Sets the primary email address.

Parameters

email The primary email address.

◆ SetEmailVerified()

void olp::authentication::model::UserAccountInfoResponse::SetEmailVerified ( bool email_verified )

inline

Sets the verification of the primary email address.

Parameters

email_verified True if the primary email address was verified; false otherwise.

◆ SetFacebookId()

void olp::authentication::model::UserAccountInfoResponse::SetFacebookId ( std::string facebook_id )

inline

Sets the Facebook ID of the user.

Parameters

facebook_id The Facebook ID of the user.

◆ SetFirstname()

void olp::authentication::model::UserAccountInfoResponse::SetFirstname ( std::string firstname )

inline

Sets the first name of the user.

Parameters

firstname The first name of the user.

◆ SetHrn()

void olp::authentication::model::UserAccountInfoResponse::SetHrn ( std::string hrn )

inline

Sets the HRN of the user.

Parameters

hrn	The user HRN.

◆ SetLanguage()

void olp::authentication::model::UserAccountInfoResponse::SetLanguage ( std::string language )

inline

Sets the code of the user's language in the ISO 639-1 2 format.

Parameters

language The language code.

◆ SetLastname()

void olp::authentication::model::UserAccountInfoResponse::SetLastname ( std::string lastname )

inline

Sets the last name of the user.

Parameters

lastname The last name of the user.

◆ SetMarketingEnabled()

void olp::authentication::model::UserAccountInfoResponse::SetMarketingEnabled ( bool marketing_enabled )

inline

Sets the marketing if it is enabled.

Parameters

marketing_enabled True if the marketing is enabled; false otherwise.

◆ SetPhoneNumber()

void olp::authentication::model::UserAccountInfoResponse::SetPhoneNumber ( std::string phone_number )

inline

Sets the user's phone number.

Parameters

phone_number The phone number.

◆ SetPhoneNumberVerified()

void olp::authentication::model::UserAccountInfoResponse::SetPhoneNumberVerified ( bool phone_number_verified )

inline

Sets the verification of the phone number.

Parameters

phone_number_verified True if the phone number was verified; false otherwise.

◆ SetRealm()

void olp::authentication::model::UserAccountInfoResponse::SetRealm ( std::string realm )

inline

Sets the realm in which the user account exists.

Parameters

realm The user realm.

◆ SetRecoveryEmail()

void olp::authentication::model::UserAccountInfoResponse::SetRecoveryEmail ( std::string recovery_email )

inline

Sets the recovery email address.

Parameters

recovery_email The recovery email address.

◆ SetState()

void olp::authentication::model::UserAccountInfoResponse::SetState ( std::string state )

inline

Sets the current state of the account.

Parameters

state The current state of the account.

◆ SetUpdatedTime()

void olp::authentication::model::UserAccountInfoResponse::SetUpdatedTime ( time_t updated_time )

inline

Sets the timestamp (milliseconds since the Unix epoch) of when the account was last updated.

Returns: The epoch time when the account was updated.

◆ SetUserId()

void olp::authentication::model::UserAccountInfoResponse::SetUserId ( std::string user_id )

inline

Sets the HERE Account ID of the user.

Parameters

user_id The HERE Account ID of the user.

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

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetAccountType()

◆ GetCountryCode()

◆ GetCreatedTime()

◆ GetDob()

◆ GetEmail()

◆ GetEmailVerified()

◆ GetFacebookId()

◆ GetFirstname()

◆ GetHrn()

◆ GetLanguage()

◆ GetLastname()

◆ GetMarketingEnabled()

◆ GetPhoneNumber()

◆ GetPhoneNumberVerified()

◆ GetRealm()

◆ GetRecoveryEmail()

◆ GetState()

◆ GetUpdatedTime()

◆ GetUserId()

◆ SetAccountType()

◆ SetCountryCode()

◆ SetCreatedTime()

◆ SetDob()

◆ SetEmail()

◆ SetEmailVerified()

◆ SetFacebookId()

◆ SetFirstname()

◆ SetHrn()

◆ SetLanguage()

◆ SetLastname()

◆ SetMarketingEnabled()

◆ SetPhoneNumber()

◆ SetPhoneNumberVerified()

◆ SetRealm()

◆ SetRecoveryEmail()

◆ SetState()

◆ SetUpdatedTime()

◆ SetUserId()