alexaClientSDK::avsGatewayManager::AuthRefreshedObserver Class Reference

#include <AuthRefreshedObserver.h>

Inheritance diagram for alexaClientSDK::avsGatewayManager::AuthRefreshedObserver:

Collaboration diagram for alexaClientSDK::avsGatewayManager::AuthRefreshedObserver:

Public Member Functions
void	onAuthStateChange (State newState, Error error) override
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::AuthObserverInterface
virtual	~AuthObserverInterface ()=default
virtual void	onAuthStateChange (State newState, Error error)=0

Static Public Member Functions
static std::shared_ptr< AuthRefreshedObserver >	create (std::function< void()> callback)

Additional Inherited Members
Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::AuthObserverInterface
enum	State {   State::UNINITIALIZED, State::REFRESHED, State::EXPIRED, State::UNRECOVERABLE_ERROR,   State::AUTHORIZING }
	The enum State describes the state of authorization. More...
enum	Error {   Error::SUCCESS, Error::UNKNOWN_ERROR, Error::AUTHORIZATION_FAILED, Error::UNAUTHORIZED_CLIENT,   Error::SERVER_ERROR, Error::INVALID_REQUEST, Error::INVALID_VALUE, Error::AUTHORIZATION_EXPIRED,   Error::UNSUPPORTED_GRANT_TYPE, Error::INVALID_CODE_PAIR, Error::AUTHORIZATION_PENDING, Error::SLOW_DOWN,   Error::INTERNAL_ERROR, Error::INVALID_CBL_CLIENT_ID }
	The enum Error encodes possible errors which may occur when changing state. More...

Detailed Description

Observe Authorization status to call the callback function once the status is refreshed.

Member Function Documentation

create()

static std::shared_ptr<AuthRefreshedObserver> alexaClientSDK::avsGatewayManager::AuthRefreshedObserver::create ( std::function< void()>  callback )

static

Creates a new instance of AuthRefreshedObserver.

Parameters

callback

callback function to be called once authorization is refreshed

Returns

a new instance of the AuthRefreshedObserver.

onAuthStateChange()

void alexaClientSDK::avsGatewayManager::AuthRefreshedObserver::onAuthStateChange ( State  newState, Error  error  )

override

Method called with the new Authorization state

Parameters

newState	new state
error	Not necessarily an error, but a description of the result of the operation which can also be success.

---

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

• /workplace/avs-device-sdk/AVSGatewayManager/include/AVSGatewayManager/AuthRefreshedObserver.h