Alexa Auto SDK  4.3
Public Types | List of all members
aace::alexa::AuthProviderEngineInterface Class Referenceabstract

Public Types

enum  AuthState {
  AuthState::UNINITIALIZED,
  AuthState::REFRESHED,
  AuthState::EXPIRED,
  AuthState::UNRECOVERABLE_ERROR
}
 
enum  AuthError {
  AuthError::NO_ERROR,
  AuthError::UNKNOWN_ERROR,
  AuthError::AUTHORIZATION_FAILED,
  AuthError::UNAUTHORIZED_CLIENT,
  AuthError::SERVER_ERROR,
  AuthError::INVALID_REQUEST,
  AuthError::INVALID_VALUE,
  AuthError::AUTHORIZATION_EXPIRED,
  AuthError::UNSUPPORTED_GRANT_TYPE,
  AuthError::INVALID_CODE_PAIR,
  AuthError::AUTHORIZATION_PENDING,
  AuthError::SLOW_DOWN,
  AuthError::INTERNAL_ERROR,
  AuthError::INVALID_CBL_CLIENT_ID
}
 

Detailed Description

AuthProviderEngineInterface

Member Enumeration Documentation

◆ AuthState

Describes the state of client authorization with AVS

Enumerator
UNINITIALIZED 

Authorization has not yet been acquired.

REFRESHED 

Authorization has been refreshed.

EXPIRED 

Authorization has expired.

UNRECOVERABLE_ERROR 

Authorization has failed in a manner that cannot be corrected by retrying.

◆ AuthError

Describes an error during an attempt to authorize with AVS

Enumerator
NO_ERROR 

No error encountered

UNKNOWN_ERROR 

An error was encountered, but no error description can be determined.

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 malformed.

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.


Alexa Auto SDK 4.3 - Copyright 2017-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0