alexaClientSDK::capabilityAgents::system::LocaleHandler Class Reference

#include <LocaleHandler.h>

Inheritance diagram for alexaClientSDK::capabilityAgents::system::LocaleHandler:

Collaboration diagram for alexaClientSDK::capabilityAgents::system::LocaleHandler:

Public Member Functions
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::unique_ptr< LocaleHandler >	create (std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionSender, std::shared_ptr< settings::LocalesSetting > localeSetting)
static settings::SettingEventMetadata	getLocaleEventsMetadata ()

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 SetLocale directive.

Member Function Documentation

cancelDirective()

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

override

create()

static std::unique_ptr<LocaleHandler> alexaClientSDK::capabilityAgents::system::LocaleHandler::create ( std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface >  exceptionSender, std::shared_ptr< settings::LocalesSetting >  localeSetting  )

static

Create an instance of LocaleHandler.

Parameters

exceptionSender	The interface that sends exceptions.
localeSetting	The container that implements the locale.

Returns

A new instance of LocaleHandler if the creation succeeds; nullptr otherwise.

getConfiguration()

avsCommon::avs::DirectiveHandlerConfiguration alexaClientSDK::capabilityAgents::system::LocaleHandler::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.

getLocaleEventsMetadata()

static settings::SettingEventMetadata alexaClientSDK::capabilityAgents::system::LocaleHandler::getLocaleEventsMetadata ( )

static

Get the locale events metadata.

Returns

The locale events metadata.

handleDirective()

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

override

handleDirectiveImmediately()

void alexaClientSDK::capabilityAgents::system::LocaleHandler::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::LocaleHandler::preHandleDirective ( std::shared_ptr< avsCommon::avs::CapabilityAgent::DirectiveInfo >  info )

override

---

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

• /workplace/avs-device-sdk/CapabilityAgents/System/include/System/LocaleHandler.h