aace::cbl::CBL Class Reference

Public Types
enum	CBLState {   CBLState::STARTING,   CBLState::REQUESTING_CODE_PAIR,   CBLState::CODE_PAIR_RECEIVED,   CBLState::REFRESHING_TOKEN,   CBLState::REQUESTING_TOKEN,   CBLState::STOPPING }
enum	CBLStateChangedReason {   CBLStateChangedReason::SUCCESS,   CBLStateChangedReason::ERROR,   CBLStateChangedReason::TIMEOUT,   CBLStateChangedReason::CODE_PAIR_EXPIRED,   CBLStateChangedReason::AUTHORIZATION_EXPIRED,   CBLStateChangedReason::NONE }

Public Member Functions
virtual void	cblStateChanged (CBLState state, CBLStateChangedReason reason, const std::string &url, const std::string &code)=0
virtual void	clearRefreshToken ()=0
virtual void	setRefreshToken (const std::string &refreshToken)=0
virtual std::string	getRefreshToken ()=0
virtual void	setUserProfile (const std::string &name, const std::string &email)=0
void	start ()
void	cancel ()
void	reset ()

Detailed Description

CBL should be extended to perform CBL authentication

Deprecated:

This platform interface is deprecated. Use the Alexa Auto Services Bridge (AASB) message broker to publish and subscribe to AASB messages instead.

See also

aace::core::MessageBroker

Member Enumeration Documentation

CBLState

enum aace::cbl::CBL::CBLState

strong

Specifies the state of the authorization flow

Deprecated:

This enum is being deprecated as this platform interface is being deprecated.

Enumerator
STARTING	CBL process is starting
REQUESTING_CODE_PAIR	Initiating the process to request a code pair
CODE_PAIR_RECEIVED	Code pair is received and is waiting on user to authenticate
REFRESHING_TOKEN	Refreshing token stage has begun
REQUESTING_TOKEN	Requesting for authorization token
STOPPING	CBL process is ending

CBLStateChangedReason

enum aace::cbl::CBL::CBLStateChangedReason

strong

Specifies the reason for the state change

Deprecated:

This enum is being deprecated as this platform interface is being deprecated.

Enumerator
SUCCESS	The CBL state changed successfully
ERROR	Error occurred in the CBL process
TIMEOUT	Request timed out
CODE_PAIR_EXPIRED	Code pair has expired and user will need to initiate the authentication process again
AUTHORIZATION_EXPIRED	The refresh token is invalid, revoked, or was issued to a different client.
NONE	No reason specified

Member Function Documentation

cblStateChanged()

virtual void aace::cbl::CBL::cblStateChanged ( CBLState  state, CBLStateChangedReason  reason, const std::string &  url, const std::string &  code  )

pure virtual

Notifies the platform implementation of an authorization flow state change

Deprecated:

This method is being deprecated as this platform interface is being deprecated.

clearRefreshToken()

virtual void aace::cbl::CBL::clearRefreshToken ( )

pure virtual

Notifies the platform implementation to clear the refresh token

Deprecated:

This method is being deprecated as this platform interface is being deprecated.

setRefreshToken()

virtual void aace::cbl::CBL::setRefreshToken ( const std::string &  refreshToken )

pure virtual

Notifies the platform implementation to set the refresh token

Deprecated:

This method is being deprecated as this platform interface is being deprecated.

getRefreshToken()

virtual std::string aace::cbl::CBL::getRefreshToken ( )

pure virtual

Returns the refresh token stored by the platform implementation, otherwise return an empty string

Deprecated:

This method is being deprecated as this platform interface is being deprecated.

setUserProfile()

virtual void aace::cbl::CBL::setUserProfile ( const std::string &  name, const std::string &  email  )

pure virtual

Notifies the platform implementation to set the user profile requestUserProfile must be enabled in configuration

Deprecated:

This method is being deprecated as this platform interface is being deprecated.

start()

void aace::cbl::CBL::start

(

)

Notifies the Engine to begin the authorization process

Deprecated:

This method is being deprecated as this platform interface is being deprecated.

cancel()

void aace::cbl::CBL::cancel

(

)

Notifies the Engine to cancel the authorization process

Deprecated:

This method is being deprecated as this platform interface is being deprecated.

reset()

void aace::cbl::CBL::reset

(

)

Notifies the Engine to reset the authorization state

Deprecated:

This method is being deprecated as this platform interface is being deprecated.

Note: Starting with Auto SDK 3.1, this API ensures that all the persisted user-related data is removed. You no longer have to restart the Engine before starting the next user login process.