#include <RevokeAuthorizationHandler.h>

Inheritance diagram for alexaClientSDK::capabilityAgents::system::RevokeAuthorizationHandler:

[legend]

Collaboration diagram for alexaClientSDK::capabilityAgents::system::RevokeAuthorizationHandler:

[legend]

Public Member Functions
bool	addObserver (std::shared_ptr< avsCommon::sdkInterfaces::RevokeAuthorizationObserverInterface > observer)

bool	removeObserver (std::shared_ptr< avsCommon::sdkInterfaces::RevokeAuthorizationObserverInterface > observer)

DirectiveHandlerInterface and CapabilityAgent Functions
avsCommon::avs::DirectiveHandlerConfiguration	getConfiguration () const override

void	handleDirectiveImmediately (std::shared_ptr< avsCommon::avs::AVSDirective > directive) override

void	preHandleDirective (std::shared_ptr< avsCommon::avs::CapabilityAgent::DirectiveInfo > info) override

void	handleDirective (std::shared_ptr< avsCommon::avs::CapabilityAgent::DirectiveInfo > info) override

void	cancelDirective (std::shared_ptr< avsCommon::avs::CapabilityAgent::DirectiveInfo > info) override

Public Member Functions inherited from alexaClientSDK::avsCommon::avs::CapabilityAgent
virtual	~CapabilityAgent ()=default

void	preHandleDirective (std::shared_ptr< AVSDirective > directive, std::unique_ptr< sdkInterfaces::DirectiveHandlerResultInterface > result) override final

bool	handleDirective (const std::string &messageId) override final

void	cancelDirective (const std::string &messageId) override final

void	onDeregistered () override

void	onFocusChanged (FocusState newFocus, MixingBehavior behavior) override

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface
virtual	~DirectiveHandlerInterface ()=default

virtual void	preHandleDirective (std::shared_ptr< avsCommon::avs::AVSDirective > directive, std::unique_ptr< DirectiveHandlerResultInterface > result)=0

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::ChannelObserverInterface
virtual	~ChannelObserverInterface ()=default

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::StateProviderInterface
virtual	~StateProviderInterface ()=default

virtual void	provideState (const avs::NamespaceAndName &stateProviderName, const ContextRequestToken stateRequestToken)

virtual void	provideState (const avs::CapabilityTag &stateProviderName, const ContextRequestToken stateRequestToken)

virtual bool	canStateBeRetrieved ()

virtual bool	hasReportableStateProperties ()

virtual bool	shouldQueryState ()

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::ContextRequesterInterface
virtual	~ContextRequesterInterface ()=default

virtual void	onContextAvailable (const std::string &jsonContext)

virtual void	onContextAvailable (const endpoints::EndpointIdentifier &endpointId, const avs::AVSContext &endpointContext, ContextRequestToken requestToken)

virtual void	onContextFailure (const ContextRequestError error)

virtual void	onContextFailure (const ContextRequestError error, ContextRequestToken token)

Static Public Member Functions
static std::shared_ptr< RevokeAuthorizationHandler >	create (std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionEncounteredSender)

Additional Inherited Members
Protected Member Functions inherited from alexaClientSDK::avsCommon::avs::CapabilityAgent
	CapabilityAgent (const std::string &nameSpace, std::shared_ptr< sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionEncounteredSender)

virtual std::shared_ptr< DirectiveInfo >	createDirectiveInfo (std::shared_ptr< AVSDirective > directive, std::unique_ptr< sdkInterfaces::DirectiveHandlerResultInterface > result)

virtual void	preHandleDirective (std::shared_ptr< DirectiveInfo > info)=0

virtual void	handleDirective (std::shared_ptr< DirectiveInfo > info)=0

virtual void	cancelDirective (std::shared_ptr< DirectiveInfo > info)=0

void	removeDirective (const std::string &messageId)

void	sendExceptionEncounteredAndReportFailed (std::shared_ptr< DirectiveInfo > info, const std::string &message, avsCommon::avs::ExceptionErrorType type=avsCommon::avs::ExceptionErrorType::INTERNAL_ERROR)

const std::pair< std::string, std::string >	buildJsonEventString (const std::string &eventName, const std::string &dialogRequestIdString="", const std::string &payload="{}", const std::string &context="") const

Protected Attributes inherited from alexaClientSDK::avsCommon::avs::CapabilityAgent
const std::string	m_namespace
	The namespace of the capability agent. More...

std::shared_ptr< sdkInterfaces::ExceptionEncounteredSenderInterface >	m_exceptionEncounteredSender
	Object to use to send exceptionEncountered messages. More...

Detailed Description

This class implements a CapabilityAgent that handles the RevokeAuthorization directive.

Member Function Documentation

◆ addObserver()

bool alexaClientSDK::capabilityAgents::system::RevokeAuthorizationHandler::addObserver ( std::shared_ptr< avsCommon::sdkInterfaces::RevokeAuthorizationObserverInterface > observer )

Adds an observer to be notified when the System.RevokeAuthorization Directive has been received.

Parameters

observer The observer to be notified when the System.RevokeAuthorization Directive has been received.

Returns: true if the observer was added, false if invalid observer or already an existing observer.

◆ cancelDirective()

void alexaClientSDK::capabilityAgents::system::RevokeAuthorizationHandler::cancelDirective ( std::shared_ptr< avsCommon::avs::CapabilityAgent::DirectiveInfo > info )

override

◆ create()

static std::shared_ptr<RevokeAuthorizationHandler> alexaClientSDK::capabilityAgents::system::RevokeAuthorizationHandler::create ( std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionEncounteredSender )

static

Create an instance of RevokeAuthorizationHandler.

Parameters

exceptionEncounteredSender The interface that sends exceptions.

Returns: nullptr if the inputs are not defined, else a new instance of RevokeAuthorizationHandler.

◆ getConfiguration()

avsCommon::avs::DirectiveHandlerConfiguration alexaClientSDK::capabilityAgents::system::RevokeAuthorizationHandler::getConfiguration ( ) const

overridevirtual

Returns the configuration of the directive handler.

The configuration consists of multiple directive routing rules and their respective blocking policy. The directives will be matched from the most specific rule (with all fields defined) to the least specific rule (which only matches the directive endpointId).

Returns: The avs::DirectiveHandlerConfiguration of the handler.

Implements alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface.

◆ handleDirective()

void alexaClientSDK::capabilityAgents::system::RevokeAuthorizationHandler::handleDirective ( std::shared_ptr< avsCommon::avs::CapabilityAgent::DirectiveInfo > info )

override

◆ handleDirectiveImmediately()

void alexaClientSDK::capabilityAgents::system::RevokeAuthorizationHandler::handleDirectiveImmediately ( std::shared_ptr< avsCommon::avs::AVSDirective > directive )

overridevirtual

Handle the action specified AVSDirective. Once this has been called the DirectiveHandler should not expect to receive further calls regarding this directive.

Note: The implementation of this method MUST be thread-safe.; The implementation of this method MUST return quickly. Failure to do so blocks the processing of subsequent AVSDirectives.; If this operation fails, an ExceptionEncountered message should be sent to AVS.

Parameters

directive The directive to handle.

Implements alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface.

◆ preHandleDirective()

void alexaClientSDK::capabilityAgents::system::RevokeAuthorizationHandler::preHandleDirective ( std::shared_ptr< avsCommon::avs::CapabilityAgent::DirectiveInfo > info )

override

◆ removeObserver()

bool alexaClientSDK::capabilityAgents::system::RevokeAuthorizationHandler::removeObserver ( std::shared_ptr< avsCommon::sdkInterfaces::RevokeAuthorizationObserverInterface > observer )

Removes an observer from the collection of observers which will be notified when the System.RevokeAuthorization Directive has been received.

Parameters

observer The observer that should no longer be notified when the System.RevokeAuthorization Directive has been sent.

Returns: true if the observer was removed, false if invalid observer or wasn't a registered observer.

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

/workplace/avs-device-sdk/CapabilityAgents/System/include/System/RevokeAuthorizationHandler.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addObserver()

◆ cancelDirective()

◆ create()

◆ getConfiguration()

◆ handleDirective()

◆ handleDirectiveImmediately()

◆ preHandleDirective()

◆ removeObserver()