AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::acsdkAuthorizationInterfaces::AuthorizationAuthorityInterface Class Referenceabstract

#include <AuthorizationAuthorityInterface.h>

Inheritance diagram for alexaClientSDK::acsdkAuthorizationInterfaces::AuthorizationAuthorityInterface:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::acsdkAuthorizationInterfaces::AuthorizationAuthorityInterface:
Collaboration graph
[legend]

Public Member Functions

virtual ~AuthorizationAuthorityInterface ()=default
 Destructor. More...
 
virtual avsCommon::sdkInterfaces::AuthObserverInterface::State getState ()=0
 
virtual std::string getActiveAuthorization ()=0
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::AuthDelegateInterface
virtual ~AuthDelegateInterface ()=default
 
virtual void addAuthObserver (std::shared_ptr< avsCommon::sdkInterfaces::AuthObserverInterface > observer)=0
 
virtual void removeAuthObserver (std::shared_ptr< avsCommon::sdkInterfaces::AuthObserverInterface > observer)=0
 
virtual std::string getAuthToken ()=0
 
virtual void onAuthFailure (const std::string &token)=0
 
- Public Member Functions inherited from alexaClientSDK::registrationManager::RegistrationManagerInterface
virtual ~RegistrationManagerInterface ()=default
 
virtual void logout ()=0
 

Detailed Description

This interface is a centralized object that acts as the source of truth for authorization state in the AVS SDK. This acts as:

-Source of truth of the current active authorization method -Source of truth of the access token (by obtaining from the active authorization method) -Source of truth of the current authorization state of the AVS SDK -Controller of logout across the SDK including deauthorization and clearing of user data.

Constructor & Destructor Documentation

◆ ~AuthorizationAuthorityInterface()

virtual alexaClientSDK::acsdkAuthorizationInterfaces::AuthorizationAuthorityInterface::~AuthorizationAuthorityInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getActiveAuthorization()

virtual std::string alexaClientSDK::acsdkAuthorizationInterfaces::AuthorizationAuthorityInterface::getActiveAuthorization ( )
pure virtual

Returns the string identifying the current active AuthorizationInterface. An active adapter can be in the process of obtaining authorization tokens.

Returns
The active authorization.

Implemented in alexaClientSDK::acsdkAuthorization::AuthorizationManager.

◆ getState()

virtual avsCommon::sdkInterfaces::AuthObserverInterface::State alexaClientSDK::acsdkAuthorizationInterfaces::AuthorizationAuthorityInterface::getState ( )
pure virtual

Returns the current authorization state.

Returns
The current authorization state.

Implemented in alexaClientSDK::acsdkAuthorization::AuthorizationManager.


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

AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0