#include <LWAAuthorizationConfiguration.h>

Public Member Functions
std::string	getClientId () const

std::string	getProductId () const

std::string	getDeviceSerialNumber () const

std::chrono::seconds	getRequestTimeout () const

std::chrono::seconds	getAccessTokenRefreshHeadStart () const

std::string	getLocale () const

std::string	getRequestCodePairUrl () const

std::string	getRequestTokenUrl () const

std::string	getRefreshTokenUrl () const

std::string	getScopeData () const

std::string	getCustomerProfileUrl () const

Static Public Member Functions
static std::unique_ptr< LWAAuthorizationConfiguration >	create (const avsCommon::utils::configuration::ConfigurationNode &configuration, const std::shared_ptr< avsCommon::utils::DeviceInfo > &deviceInfo, const std::string &configRootKey="")

Detailed Description

Class encapsulating configuration parameters for LWAAuthorizationAdapter.

Member Function Documentation

◆ create()

static std::unique_ptr<LWAAuthorizationConfiguration> alexaClientSDK::acsdkAuthorization::lwa::LWAAuthorizationConfiguration::create	(	const avsCommon::utils::configuration::ConfigurationNode &	configuration,
		const std::shared_ptr< avsCommon::utils::DeviceInfo > &	deviceInfo,
		const std::string &	configRootKey = `""`
	)

static

Create an instance.

Parameters

configuration	The ConfigurationNode containing the configuration parameters for the new instance.
deviceInfo	The deviceInfo instance.
configRootKey	The config root to use.

Returns: the LWAAuthorizationConfiguration instance if successful, else a nullptr.

◆ getAccessTokenRefreshHeadStart()

std::chrono::seconds alexaClientSDK::acsdkAuthorization::lwa::LWAAuthorizationConfiguration::getAccessTokenRefreshHeadStart ( ) const

Get the duration before access token expiration to start refreshing the token.

Returns: The duration before access token expiration to start refreshing the token.

◆ getClientId()

std::string alexaClientSDK::acsdkAuthorization::lwa::LWAAuthorizationConfiguration::getClientId ( ) const

Get the client ID.

Returns: The client ID.

◆ getCustomerProfileUrl()

std::string alexaClientSDK::acsdkAuthorization::lwa::LWAAuthorizationConfiguration::getCustomerProfileUrl ( ) const

Get the URL to use when getting the user profile.

Returns: The URL to use when getting the user profile.

◆ getDeviceSerialNumber()

std::string alexaClientSDK::acsdkAuthorization::lwa::LWAAuthorizationConfiguration::getDeviceSerialNumber ( ) const

Get the device serial number.

Returns: The device serial number.

◆ getLocale()

std::string alexaClientSDK::acsdkAuthorization::lwa::LWAAuthorizationConfiguration::getLocale ( ) const

Get the locale to use when prompting the user to authenticate the client to access AVS.

Returns: The locale to use when prompting the user to authenticate the client to access AVS.

◆ getProductId()

std::string alexaClientSDK::acsdkAuthorization::lwa::LWAAuthorizationConfiguration::getProductId ( ) const

Get the product ID.

Returns: The product ID.

◆ getRefreshTokenUrl()

std::string alexaClientSDK::acsdkAuthorization::lwa::LWAAuthorizationConfiguration::getRefreshTokenUrl ( ) const

Get the URL to use when refreshing an access token.

Returns: The URL to use when refreshing an access token.

◆ getRequestCodePairUrl()

std::string alexaClientSDK::acsdkAuthorization::lwa::LWAAuthorizationConfiguration::getRequestCodePairUrl ( ) const

Get the URL to use when requesting a code pair from LWA.

Returns: The URL to use when requesting a code pair from LWA.

◆ getRequestTimeout()

std::chrono::seconds alexaClientSDK::acsdkAuthorization::lwa::LWAAuthorizationConfiguration::getRequestTimeout ( ) const

Get the request timeout.

Returns: The request timeout.

◆ getRequestTokenUrl()

std::string alexaClientSDK::acsdkAuthorization::lwa::LWAAuthorizationConfiguration::getRequestTokenUrl ( ) const

Get the URL to use when requesting an initial access token from LWA.

Returns: The URL to use when requesting an initial access token from LWA.

◆ getScopeData()

std::string alexaClientSDK::acsdkAuthorization::lwa::LWAAuthorizationConfiguration::getScopeData ( ) const

Get (as text) the 'scope_data' JSON object to send to LWA when requesting a code pair.

Returns: The 'scope_data' JSON object to send to LWA when requesting a code pair.

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

/workplace/avs-device-sdk/core/Authorization/acsdkAuthorization/include/acsdkAuthorization/LWA/LWAAuthorizationConfiguration.h

Public Member Functions

Static Public Member Functions