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::AuthorizationManagerInterface Class Referenceabstract

#include <AuthorizationManagerInterface.h>

Inheritance diagram for alexaClientSDK::acsdkAuthorizationInterfaces::AuthorizationManagerInterface:
Inheritance graph

Public Member Functions

virtual ~AuthorizationManagerInterface ()=default
 Destructor. More...
virtual void reportStateChange (const avsCommon::sdkInterfaces::AuthObserverInterface::FullState &state, const std::string &authId, const std::string &userId)=0
virtual void add (const std::shared_ptr< acsdkAuthorizationInterfaces::AuthorizationAdapterInterface > &adapter)=0

Detailed Description

This non-application facing interfaces manages between multiple authorization mechanisms and ensures that the AVS SDK utilizes a single authorization mode.

Constructor & Destructor Documentation

◆ ~AuthorizationManagerInterface()

virtual alexaClientSDK::acsdkAuthorizationInterfaces::AuthorizationManagerInterface::~AuthorizationManagerInterface ( )


Member Function Documentation

◆ add()

virtual void alexaClientSDK::acsdkAuthorizationInterfaces::AuthorizationManagerInterface::add ( const std::shared_ptr< acsdkAuthorizationInterfaces::AuthorizationAdapterInterface > &  adapter)
pure virtual

Add an adapter with the AuthorizationManagerInterface. This must be called before reportStateChange.

adapterThe authorization adapter.

◆ reportStateChange()

virtual void alexaClientSDK::acsdkAuthorizationInterfaces::AuthorizationManagerInterface::reportStateChange ( const avsCommon::sdkInterfaces::AuthObserverInterface::FullState state,
const std::string &  authId,
const std::string &  userId 
pure virtual

Reports the state change. This should be called in accordance with state transitions documented in AuthObserverInterface::State. UserId may not initially be available in the AUTHORIZING state. The values obtained in REFRESHED will be carried forward for future callbacks for validation purposes.

stateThe state.
authIdThe unique auth id.
userIdThe user id associated with this.

Implemented in alexaClientSDK::acsdkAuthorization::AuthorizationManager.

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

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