alexaClientSDK::sdkClient::FeatureClientBuilderInterface Class Reference

#include <FeatureClientBuilderInterface.h>

Inheritance diagram for alexaClientSDK::sdkClient::FeatureClientBuilderInterface:

Public Member Functions
virtual	~FeatureClientBuilderInterface ()=default
virtual std::string	name ()=0

Protected Member Functions
template<typename ComponentType >
ACSDK_INLINE_VISIBILITY void	addRequiredType ()

Detailed Description

Interface to be implemented by Feature Client Builders

Note

During construction of the feature client builder any required types must be requested by calling the addRequiredType<T> function exposed by the FeatureClientBuilderInterface.

MyFeature::MyFeature() {
    addRequiredType<RequiredType1>();
    addRequiredType<RequiredType2>();
}

Constructor & Destructor Documentation

~FeatureClientBuilderInterface()

virtual alexaClientSDK::sdkClient::FeatureClientBuilderInterface::~FeatureClientBuilderInterface ( )

virtualdefault

Virtual destructor

Member Function Documentation

addRequiredType()

template<typename ComponentType >

ACSDK_INLINE_VISIBILITY void alexaClientSDK::sdkClient::FeatureClientBuilderInterface::addRequiredType ( )

inlineprotected

Adds a type which is required for the construction of the client. Types added in this way are guaranteed to be available when construct is called. All required types should be registered in the constructor of the feature client.

Template Parameters

ComponentType

The type which is required

name()

virtual std::string alexaClientSDK::sdkClient::FeatureClientBuilderInterface::name ( )

pure virtual

Retrieve the name of the client, used to get friendly names in case of errors

Returns

string containing the friendly name of the client

Implemented in alexaClientSDK::defaultClient::DefaultClientBuilder, alexaClientSDK::featureClient::LiveViewControllerFeatureClientBuilder, alexaClientSDK::featureClient::AlexaPresentationFeatureClientBuilder, alexaClientSDK::featureClient::VisualCharacteristicsFeatureClientBuilder, alexaClientSDK::featureClient::PresentationOrchestratorFeatureClientBuilder, and alexaClientSDK::featureClient::VisualStateTrackerFeatureClientBuilder.

---

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

• /workplace/avs-device-sdk/shared/SDKClient/include/acsdk/SDKClient/FeatureClientBuilderInterface.h
• /workplace/avs-device-sdk/shared/SDKClient/include/acsdk/SDKClient/internal/FeatureClientBuilderInterface_impl.h