![]() |
Alexa Auto SDK
2.3.1
|
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 () |
|
strong |
Specifies the state of the authorization flow
| 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 |
|
strong |
Specifies the reason for the state change
| Enumerator | |
|---|---|
| SUCCESS | The CBL state changed successfully |
| ERROR | Error occured 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 |
|
pure virtual |
Notifies the platform implementation of an authorization flow state change
|
pure virtual |
Notifies the platform implementation to clear the refresh token
|
pure virtual |
Notifies the platform implemnentation to set the refresh token
|
pure virtual |
Returns the refresh token stored by the platform implementation, otherwise return an empty string
|
pure virtual |
Notifies the platform implementation to set the user profile requestUserProfile must be enabled in configuration
| void aace::cbl::CBL::start | ( | ) |
Notifies the Engine to begin the authorization process
| void aace::cbl::CBL::cancel | ( | ) |
Notifies the Engine to cancel the authorization process
| void aace::cbl::CBL::reset | ( | ) |
Notifies the Engine to reset the authorization state
Alexa Auto SDK 2.3.1 - Copyright 2017-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0