The Apple sign-in properties. More...

#include <AppleSignInProperties.h>

Public Member Functions
const std::string &	GetAccessToken () const
	Gets the bearer in the authorization request header. More...

void	SetAccessToken (std::string access_token)
	Sets the bearer in the authorization request header. 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 &	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 alpha-2 format. More...

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

const std::string &	GetClientId () const
	Gets the application ID. More...

void	SetClientId (std::string client_id)
	Sets the application ID. More...

const std::string &	GetRealm () const
	Gets the platform realm to which the application ID (`client_id`) belongs. More...

void	SetRealm (std::string realm)
	Sets the platform realm to which the application ID (`client_id`) belongs. More...

Detailed Description

The Apple sign-in properties.

Member Function Documentation

◆ GetAccessToken()

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

inline

Gets the bearer in the authorization request header.

Note: This is the Apple 'id_token' received after authorization.

Returns: The access token.

◆ GetClientId()

const std::string& olp::authentication::AppleSignInProperties::GetClientId ( ) const

inline

Gets the application ID.

Returns: The application ID.

◆ GetCountryCode()

const std::string& olp::authentication::AppleSignInProperties::GetCountryCode ( ) const

inline

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

Returns: The country code.

◆ GetFirstname()

const std::string& olp::authentication::AppleSignInProperties::GetFirstname ( ) const

inline

Gets the first name of the user.

Returns: The first name of the user.

◆ GetLanguage()

const std::string& olp::authentication::AppleSignInProperties::GetLanguage ( ) const

inline

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

Returns: The language code.

◆ GetLastname()

const std::string& olp::authentication::AppleSignInProperties::GetLastname ( ) const

inline

Gets the last name of the user.

Returns: The last name of the user.

◆ GetRealm()

const std::string& olp::authentication::AppleSignInProperties::GetRealm ( ) const

inline

Gets the platform realm to which the application ID (client_id) belongs.

Returns: The client realm.

◆ SetAccessToken()

void olp::authentication::AppleSignInProperties::SetAccessToken ( std::string access_token )

inline

Sets the bearer in the authorization request header.

Note: This is the Apple 'id_token' received after authorization.

Parameters

access_token The access token.

◆ SetClientId()

void olp::authentication::AppleSignInProperties::SetClientId ( std::string client_id )

inline

Sets the application ID.

Parameters

client_id The application ID.

◆ SetCountryCode()

void olp::authentication::AppleSignInProperties::SetCountryCode ( std::string country_code )

inline

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

Required for the first-time sign-in; optional for the subsequent sign-ins.

Parameters

country_code The country code.

◆ SetFirstname()

void olp::authentication::AppleSignInProperties::SetFirstname ( std::string firstname )

inline

Sets the first name of the user.

Required for the first-time sign-in; optional for the subsequent sign-ins.

Parameters

firstname The first name of the user.

◆ SetLanguage()

void olp::authentication::AppleSignInProperties::SetLanguage ( std::string language )

inline

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

Required for the first-time sign-in; optional for the subsequent sign-ins.

Parameters

language The language code.

◆ SetLastname()

void olp::authentication::AppleSignInProperties::SetLastname ( std::string lastname )

inline

Sets the last name of the user.

Required for the first-time sign-in; optional for the subsequent sign-ins.

Parameters

lastname The last name of the user.

◆ SetRealm()

void olp::authentication::AppleSignInProperties::SetRealm ( std::string realm )

inline

Sets the platform realm to which the application ID (client_id) belongs.

Parameters

realm The client realm.

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

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetAccessToken()

◆ GetClientId()

◆ GetCountryCode()

◆ GetFirstname()

◆ GetLanguage()

◆ GetLastname()

◆ GetRealm()

◆ SetAccessToken()

◆ SetClientId()

◆ SetCountryCode()

◆ SetFirstname()

◆ SetLanguage()

◆ SetLastname()

◆ SetRealm()