alexaClientSDK::avsCommon::sdkInterfaces::AuthObserverInterface Class Reference

#include <AuthObserverInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::AuthObserverInterface:

Classes
struct	FullState
	An aggregated structure to simplify working with State and Error. More...

Public Types
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...

Public Member Functions
virtual	~AuthObserverInterface ()=default
virtual void	onAuthStateChange (State newState, Error error)=0

Detailed Description

This interface is used to observe changes to the state of authorization.

Member Enumeration Documentation

Error

enum alexaClientSDK::avsCommon::sdkInterfaces::AuthObserverInterface::Error

strong

The enum Error encodes possible errors which may occur when changing state.

Enumerator
SUCCESS	Success.
UNKNOWN_ERROR	An unknown body containing no error field has been encountered.
AUTHORIZATION_FAILED	The client authorization failed.
UNAUTHORIZED_CLIENT	The client is not authorized to use authorization codes.
SERVER_ERROR	The server encountered a runtime error.
INVALID_REQUEST	The request is missing a required parameter, has an invalid value, or is otherwise improperly formed.
INVALID_VALUE	One of the values in the request was invalid.
AUTHORIZATION_EXPIRED	The authorization code is invalid, expired, revoked, or was issued to a different client.
UNSUPPORTED_GRANT_TYPE	The client specified the wrong token type.
INVALID_CODE_PAIR	Invalid code pair provided in Code-based linking token request.
AUTHORIZATION_PENDING	Waiting for user to authorize the specified code pair.
SLOW_DOWN	Client should slow down in the rate of requests polling for an access token.
INTERNAL_ERROR	Internal error in client code.
INVALID_CBL_CLIENT_ID	Client ID not valid for use with code based linking.

State

enum alexaClientSDK::avsCommon::sdkInterfaces::AuthObserverInterface::State

strong

The enum State describes the state of authorization.

Enumerator
UNINITIALIZED	Authorization not yet acquired.
REFRESHED	Authorization has been refreshed.
EXPIRED	Authorization has expired.
UNRECOVERABLE_ERROR	Authorization failed in a manner that cannot be corrected by retry.
AUTHORIZING	Currently in the process of authorizing, such as requesting or refreshing a token.

Constructor & Destructor Documentation

~AuthObserverInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::AuthObserverInterface::~AuthObserverInterface ( )

virtualdefault

Virtual destructor to assure proper cleanup of derived types.

Member Function Documentation

onAuthStateChange()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::AuthObserverInterface::onAuthStateChange ( State  newState, Error  error  )

pure virtual

Notification that an authorization state has changed.

Note

Implementations of this method must not call AuthDelegate methods because the AuthDelegate may be in a 'locked' state at the time this call is made.

Parameters

newState	The new state of the authorization token.
error	The error associated to the state change.

Implemented in alexaClientSDK::acl::HTTP2Transport, alexaClientSDK::sampleApplications::common::UIManager, and alexaClientSDK::sampleApplications::ipcServerSampleApp::ConnectionObserver.

---

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

• /workplace/avs-device-sdk/AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/AuthObserverInterface.h