alexaClientSDK::acsdkAuthorizationInterfaces::lwa::CBLAuthorizationObserverInterface Class Reference

An observer interface used for callbacks when authorizing using CBL in LWAAuthorizationAdapterInterface. More...

#include <CBLAuthorizationObserverInterface.h>

Inheritance diagram for alexaClientSDK::acsdkAuthorizationInterfaces::lwa::CBLAuthorizationObserverInterface:

Classes
struct	CustomerProfile
	An optional struct that may return additional information. More...

Public Member Functions
virtual	~CBLAuthorizationObserverInterface ()=default
	Destructor. More...
virtual void	onRequestAuthorization (const std::string &url, const std::string &code)=0
virtual void	onCheckingForAuthorization ()=0
virtual void	onCustomerProfileAvailable (const CustomerProfile &customerProfile)=0

Detailed Description

An observer interface used for callbacks when authorizing using CBL in LWAAuthorizationAdapterInterface.

Constructor & Destructor Documentation

~CBLAuthorizationObserverInterface()

virtual alexaClientSDK::acsdkAuthorizationInterfaces::lwa::CBLAuthorizationObserverInterface::~CBLAuthorizationObserverInterface ( )

virtualdefault

Destructor.

Member Function Documentation

onCheckingForAuthorization()

virtual void alexaClientSDK::acsdkAuthorizationInterfaces::lwa::CBLAuthorizationObserverInterface::onCheckingForAuthorization ( )

pure virtual

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.

Implemented in alexaClientSDK::acsdkSampleApplicationCBLAuthRequester::SampleApplicationCBLAuthRequester.

onCustomerProfileAvailable()

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

pure virtual

A callback if CustomerProfile is available.

Parameters

customerProfile

The customerProfile that's returned.

Implemented in alexaClientSDK::acsdkSampleApplicationCBLAuthRequester::SampleApplicationCBLAuthRequester.

onRequestAuthorization()

virtual void alexaClientSDK::acsdkAuthorizationInterfaces::lwa::CBLAuthorizationObserverInterface::onRequestAuthorization ( const std::string &  url, const std::string &  code  )

pure virtual

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.

Implemented in alexaClientSDK::acsdkSampleApplicationCBLAuthRequester::SampleApplicationCBLAuthRequester.

---

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

• /workplace/avs-device-sdk/core/Authorization/acsdkAuthorizationInterfaces/include/acsdkAuthorizationInterfaces/LWA/CBLAuthorizationObserverInterface.h