alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesBuilderInterface Class Reference

#include <EndpointCapabilitiesBuilderInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesBuilderInterface:

Classes
struct	Capability

Public Member Functions
virtual	~EndpointCapabilitiesBuilderInterface ()=default
virtual std::pair< std::list< Capability >, std::list< std::shared_ptr< avsCommon::utils::RequiresShutdown > > >	buildCapabilities (const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &endpointId, const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &contextManager, const std::shared_ptr< avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface > &responseSender, const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &exceptionSender)=0

Detailed Description

This class provides a mechanism through which Endpoint Capability Agents can be passed to the EndpointBuilder.

Note

The EndpointBuilder calls buildCapabilties() in withEndpointCapabilitiesBuilder() method with all required dependencies to build the capability agents.

The user must ensure thread safety of this class.

Constructor & Destructor Documentation

~EndpointCapabilitiesBuilderInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesBuilderInterface::~EndpointCapabilitiesBuilderInterface ( )

virtualdefault

Default Destructor.

Member Function Documentation

buildCapabilities()

virtual std::pair<std::list<Capability>, std::list<std::shared_ptr<avsCommon::utils::RequiresShutdown> > > alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesBuilderInterface::buildCapabilities ( const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &  endpointId, const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &  contextManager, const std::shared_ptr< avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface > &  responseSender, const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &  exceptionSender  )

pure virtual

The method builds controller capabilities and returns a pair of lists containing Capability and lists containing RequiresShutdown objects.

Parameters

endpointId	The endpoint ID
contextManager	The ContextManager pointer.
responseSender	The AlexaInterfaceMessageSender to send Alexa Interface messages.
exceptionSender	The ExceptionEncounteredSender to send exception messages to AVS.

Returns

A pair of lists of Capability and RequiresShutdown objects

---

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

• /workplace/avs-device-sdk/AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/Endpoints/EndpointCapabilitiesBuilderInterface.h