alexaClientSDK::featureClient::VisualCharacteristicsFeatureClientBuilder Class Reference

#include <VisualCharacteristicsFeatureClientBuilder.h>

Inheritance diagram for alexaClientSDK::featureClient::VisualCharacteristicsFeatureClientBuilder:

Collaboration diagram for alexaClientSDK::featureClient::VisualCharacteristicsFeatureClientBuilder:

Public Member Functions
std::shared_ptr< VisualCharacteristicsFeatureClient >	construct (const std::shared_ptr< sdkClient::SDKClientRegistry > &sdkClientRegistry)
std::string	name () override
Public Member Functions inherited from alexaClientSDK::sdkClient::FeatureClientBuilderInterface
virtual	~FeatureClientBuilderInterface ()=default

Static Public Member Functions
static std::unique_ptr< VisualCharacteristicsFeatureClientBuilder >	create ()

Additional Inherited Members
Protected Member Functions inherited from alexaClientSDK::sdkClient::FeatureClientBuilderInterface
template<typename ComponentType >
ACSDK_INLINE_VISIBILITY void	addRequiredType ()

Detailed Description

The VisualCharacteristicsFeatureClientBuilder builder class is responsible for creating an instance of the VisualCharacteristicsFeatureClient and is intended to be used with the SDKClientBuilder and SDKClientRegistry. It constructs the VisualCharacteristics and VisualCharacteristicsSerializer components which are intended for use in reporting the visual characteristics for a device.

It requires the ExceptionEncounteredSenderInterface, EndpointBuilderInterface and ContextManagerInterface components from the SDKClientRegistry which can be provided by DefaultClient. If the PresentationOrchestratorStateTrackerInterface provided by the VisualStateTrackerFeatureClient is available then the VisualCharacteristics component will be registered as an observer.

Member Function Documentation

construct()

std::shared_ptr<VisualCharacteristicsFeatureClient> alexaClientSDK::featureClient::VisualCharacteristicsFeatureClientBuilder::construct

(

const std::shared_ptr< sdkClient::SDKClientRegistry > &

sdkClientRegistry

)

Construct an instance of the VisualCharacteristicsFeatureClient

Parameters

sdkClientRegistry

The SDKClientClientRegistry object used for registering components

Returns

An instance of the VisualCharacteristicsFeatureClient, or nullptr if construction failed

create()

static std::unique_ptr<VisualCharacteristicsFeatureClientBuilder> alexaClientSDK::featureClient::VisualCharacteristicsFeatureClientBuilder::create ( )

static

Create an instance of the VisualCharacteristicsFeatureClientBuilder, this can be passed to the SDKClientBuilder

Returns

The newly instantiated VisualCharacteristicsFeatureClientBuilder object, or nullptr if creation failed

name()

std::string alexaClientSDK::featureClient::VisualCharacteristicsFeatureClientBuilder::name ( )

overridevirtual

FeatureClientBuilderInterface functions

Implements alexaClientSDK::sdkClient::FeatureClientBuilderInterface.

---

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

• /workplace/avs-device-sdk/applications/FeatureClients/VisualCharacteristicsFeatureClient/include/acsdk/VisualCharacteristicsFeatureClient/VisualCharacteristicsFeatureClientBuilder.h