#include <VisualCharacteristicsFeatureClient.h>

Inheritance diagram for alexaClientSDK::featureClient::VisualCharacteristicsFeatureClient:

Collaboration diagram for alexaClientSDK::featureClient::VisualCharacteristicsFeatureClient:

Public Member Functions
std::shared_ptr< alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsInterface >	getVisualCharacteristics () const

std::shared_ptr< alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsSerializerInterface >	getVisualCharacteristicsSerializer () const

	~VisualCharacteristicsFeatureClient ()
	Destructor. More...


bool	configure (const std::shared_ptr< sdkClient::SDKClientRegistry > &sdkClientRegistry) override

void	doShutdown () override

Public Member Functions inherited from alexaClientSDK::sdkClient::FeatureClientInterface
	FeatureClientInterface (const std::string &name)

virtual bool	configure (const std::shared_ptr< SDKClientRegistry > &sdkClientRegistry)=0

virtual	~FeatureClientInterface ()=default
	Destructor. More...

Public Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
	RequiresShutdown (const std::string &name)

virtual	~RequiresShutdown ()
	Destructor. More...

const std::string &	name () const

void	shutdown ()

bool	isShutdown () const

Static Public Member Functions
static std::unique_ptr< VisualCharacteristicsFeatureClient >	create (const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &exceptionSender, const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ContextManagerInterface > &contextManager, const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface > &endpointBuilder, const std::shared_ptr< sdkClient::SDKClientRegistry > &sdkClientRegistry)

Additional Inherited Members

Detailed Description

The VisualCharacteristicsFeatureClient is a Feature Client that provides functionality to report the visual characteristics of a device through the use of the VisualCharacteristics and VisualCharacteristicsSerializer components. It is recommended that the VisualCharacteristicsFeatureClientBuilder is used in combination with the SDKClientBuilder to construct this Feature Client.

Constructor & Destructor Documentation

◆ ~VisualCharacteristicsFeatureClient()

alexaClientSDK::featureClient::VisualCharacteristicsFeatureClient::~VisualCharacteristicsFeatureClient ( )

Destructor.

Member Function Documentation

◆ configure()

bool alexaClientSDK::featureClient::VisualCharacteristicsFeatureClient::configure ( const std::shared_ptr< sdkClient::SDKClientRegistry > & sdkClientRegistry )

override

FeatureClientInterface functions

◆ create()

static std::unique_ptr<VisualCharacteristicsFeatureClient> alexaClientSDK::featureClient::VisualCharacteristicsFeatureClient::create	(	const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &	exceptionSender,
		const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ContextManagerInterface > &	contextManager,
		const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface > &	endpointBuilder,
		const std::shared_ptr< sdkClient::SDKClientRegistry > &	sdkClientRegistry
	)

static

Create an instance of the VisualCharacteristicsFeatureClient, users should prefer to use the VisualCharacteristicsFeatureClientBuilder to create and register an instance of this client with the SDKClient

Parameters

exceptionSender	Reference to the `ExceptionEncounteredSenderInterface`
contextManager	Reference to the `ContextManagerInterface`
endpointBuilder	Reference to the `EndpointBuilderInterface`

Returns: unique pointer to the created VisualCharacteristicsFeatureClient, or nullptr if creation failed

◆ doShutdown()

void alexaClientSDK::featureClient::VisualCharacteristicsFeatureClient::doShutdown ( )

overridevirtual

FeatureClientInterface functions

Implements alexaClientSDK::avsCommon::utils::RequiresShutdown.

◆ getVisualCharacteristics()

std::shared_ptr<alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsInterface> alexaClientSDK::featureClient::VisualCharacteristicsFeatureClient::getVisualCharacteristics ( ) const

Get a reference to VisualCharacteristicsInterface

Returns: shared_ptr to VisualCharacteristicsInterface

◆ getVisualCharacteristicsSerializer()

std::shared_ptr<alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsSerializerInterface> alexaClientSDK::featureClient::VisualCharacteristicsFeatureClient::getVisualCharacteristicsSerializer ( ) const

Get a reference to VisualCharacteristicsSerializerInterface

Returns: shared_ptr to VisualCharacteristicsSerializerInterface

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

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

Public Member Functions

Static Public Member Functions