alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface Class Reference

#include <EndpointCapabilitiesRegistrarInterface.h>

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

Public Member Functions
virtual	~EndpointCapabilitiesRegistrarInterface ()=default
virtual EndpointCapabilitiesRegistrarInterface &	withCapability (const avs::CapabilityConfiguration &configuration, std::shared_ptr< DirectiveHandlerInterface > directiveHandler)=0
virtual EndpointCapabilitiesRegistrarInterface &	withCapability (const std::shared_ptr< avsCommon::sdkInterfaces::CapabilityConfigurationInterface > &configurationInterface, std::shared_ptr< DirectiveHandlerInterface > directiveHandler)=0
virtual EndpointCapabilitiesRegistrarInterface &	withCapabilityConfiguration (const std::shared_ptr< avsCommon::sdkInterfaces::CapabilityConfigurationInterface > &configurationInterface)=0

Detailed Description

Class to register capabilities with an endpoint being built.

Note

Capabilities cannot be added to an endpoint that has already been built.

Constructor & Destructor Documentation

~EndpointCapabilitiesRegistrarInterface()

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

virtualdefault

Destructor.

Member Function Documentation

withCapability() [1/2]

virtual EndpointCapabilitiesRegistrarInterface& alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface::withCapability ( const avs::CapabilityConfiguration &  configuration, std::shared_ptr< DirectiveHandlerInterface >  directiveHandler  )

pure virtual

Adds a capability.

Parameters

configuration	The capability configuration.
directiveHandler	The handler for the directives in the given namespace.

Returns

This registrar which can be used to nest configuration function calls.

Implemented in alexaClientSDK::endpoints::EndpointBuilder, and alexaClientSDK::endpoints::DefaultEndpointBuilder.

withCapability() [2/2]

virtual EndpointCapabilitiesRegistrarInterface& alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface::withCapability ( const std::shared_ptr< avsCommon::sdkInterfaces::CapabilityConfigurationInterface > &  configurationInterface, std::shared_ptr< DirectiveHandlerInterface >  directiveHandler  )

pure virtual

Adds a capability.

Parameters

configuration	The object used to retrieve the capability configurations.
directiveHandler	The handler for the directives in the given namespace.

Deprecated:

CapabilityConfigurationInterface is deprecated.

Returns

This registrar which can be used to nest configuration function calls.

withCapabilityConfiguration()

virtual EndpointCapabilitiesRegistrarInterface& alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface::withCapabilityConfiguration ( const std::shared_ptr< avsCommon::sdkInterfaces::CapabilityConfigurationInterface > &  configurationInterface )

pure virtual

Adds a capability configuration that doesn't have any associated DirectiveHandler.

Parameters

configurationInterface

The object used to retrieve the capability configurations.

Deprecated:

CapabilityConfigurationInterface is deprecated.

Returns

This registrar which can be used to nest configuration function calls.

---

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

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