alexaClientSDK::acsdkSampleApplicationCBLAuthRequester::SampleApplicationCBLAuthRequester Class Reference

#include <SampleApplicationCBLAuthRequester.h>

Inheritance diagram for alexaClientSDK::acsdkSampleApplicationCBLAuthRequester::SampleApplicationCBLAuthRequester:

Collaboration diagram for alexaClientSDK::acsdkSampleApplicationCBLAuthRequester::SampleApplicationCBLAuthRequester:

Public Member Functions
void	setUIAuthNotifier (std::shared_ptr< acsdkSampleApplicationInterfaces::UIAuthNotifierInterface > uiAuthNotifier)
CBLAuthorizationObserverInterface methods
void	onRequestAuthorization (const std::string &url, const std::string &code) override
void	onCheckingForAuthorization () override
void	onCustomerProfileAvailable (const acsdkAuthorizationInterfaces::lwa::CBLAuthorizationObserverInterface::CustomerProfile &customerProfile) override
Public Member Functions inherited from alexaClientSDK::acsdkAuthorizationInterfaces::lwa::CBLAuthorizationObserverInterface
virtual	~CBLAuthorizationObserverInterface ()=default
	Destructor. More...

Static Public Member Functions
static std::shared_ptr< acsdkAuthorizationInterfaces::lwa::CBLAuthorizationObserverInterface >	createCBLAuthorizationObserverInterface (const std::shared_ptr< acsdkSampleApplicationInterfaces::UIManagerInterface > &uiManager)

Detailed Description

Implementation of CBLAuthRequesterInterface.

Member Function Documentation

createCBLAuthorizationObserverInterface()

static std::shared_ptr<acsdkAuthorizationInterfaces::lwa::CBLAuthorizationObserverInterface> alexaClientSDK::acsdkSampleApplicationCBLAuthRequester::SampleApplicationCBLAuthRequester::createCBLAuthorizationObserverInterface ( const std::shared_ptr< acsdkSampleApplicationInterfaces::UIManagerInterface > &  uiManager )

static

Create a new instance of CBLAuthorizationObserverInterface.

Parameters

uiManager

The instance of UIManagerInterface to use to message the user.

Returns

A new instance of CBLAuthorizationObserverInterface.

onCheckingForAuthorization()

void alexaClientSDK::acsdkSampleApplicationCBLAuthRequester::SampleApplicationCBLAuthRequester::onCheckingForAuthorization ( )

overridevirtual

Legacy API for notifying the application when token requests are being made.

This notification can be noisy, a preferred alternative is for applications to observe AuthObserverInterface::State::AUTHORIZING via AuthObserverInterface::onAuthStateChange.

Implements alexaClientSDK::acsdkAuthorizationInterfaces::lwa::CBLAuthorizationObserverInterface.

onCustomerProfileAvailable()

void alexaClientSDK::acsdkSampleApplicationCBLAuthRequester::SampleApplicationCBLAuthRequester::onCustomerProfileAvailable ( const acsdkAuthorizationInterfaces::lwa::CBLAuthorizationObserverInterface::CustomerProfile &  customerProfile )

overridevirtual

A callback if CustomerProfile is available.

Parameters

customerProfile

The customerProfile that's returned.

Implements alexaClientSDK::acsdkAuthorizationInterfaces::lwa::CBLAuthorizationObserverInterface.

onRequestAuthorization()

void alexaClientSDK::acsdkSampleApplicationCBLAuthRequester::SampleApplicationCBLAuthRequester::onRequestAuthorization ( const std::string &  url, const std::string &  code  )

overridevirtual

A callback that requests the observer to display the following information to the user as part of the CBL process.

Parameters

url	The url to be displayed.
code	The CBL code.

Implements alexaClientSDK::acsdkAuthorizationInterfaces::lwa::CBLAuthorizationObserverInterface.

setUIAuthNotifier()

void alexaClientSDK::acsdkSampleApplicationCBLAuthRequester::SampleApplicationCBLAuthRequester::setUIAuthNotifier

(

std::shared_ptr< acsdkSampleApplicationInterfaces::UIAuthNotifierInterface >

uiAuthNotifier

)

Set a notifier that bridges Authorization state from authorization requester to the user interface.

Parameters

uiAuthNotifier

An instance of UIAuthNotifierInterface.

---

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

• /workplace/avs-device-sdk/applications/acsdkSampleApplicationCBLAuthRequester/include/acsdkSampleApplicationCBLAuthRequester/SampleApplicationCBLAuthRequester.h