AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface Class Referenceabstract

#include <EndpointCapabilitiesRegistrarInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~EndpointCapabilitiesRegistrarInterface ()=default
 
virtual EndpointCapabilitiesRegistrarInterfacewithCapability (const avs::CapabilityConfiguration &configuration, std::shared_ptr< DirectiveHandlerInterface > directiveHandler)=0
 
virtual EndpointCapabilitiesRegistrarInterfacewithCapability (const std::shared_ptr< avsCommon::sdkInterfaces::CapabilityConfigurationInterface > &configurationInterface, std::shared_ptr< DirectiveHandlerInterface > directiveHandler)=0
 
virtual EndpointCapabilitiesRegistrarInterfacewithCapabilityConfiguration (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
configurationThe capability configuration.
directiveHandlerThe 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
configurationThe object used to retrieve the capability configurations.
directiveHandlerThe handler for the directives in the given namespace.
Deprecated:
CapabilityConfigurationInterface is deprecated.
Returns
This registrar which can be used to nest configuration function calls.

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

◆ 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
configurationInterfaceThe object used to retrieve the capability configurations.
Deprecated:
CapabilityConfigurationInterface is deprecated.
Returns
This registrar which can be used to nest configuration function calls.

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


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

AlexaClientSDK 1.25.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0