alexaClientSDK::acsdkCommunicationInterfaces::CommunicationPropertyValidatorInterface< T > Class Template Reference

#include <CommunicationPropertyValidatorInterface.h>

Inheritance diagram for alexaClientSDK::acsdkCommunicationInterfaces::CommunicationPropertyValidatorInterface< T >:

Public Member Functions
virtual	~CommunicationPropertyValidatorInterface ()=default
virtual bool	validateWriteRequest (const std::string &propertyName, T newValue)=0

Detailed Description

template<typename T>
class alexaClientSDK::acsdkCommunicationInterfaces::CommunicationPropertyValidatorInterface< T >

The CommunicationPropertyValidatorInterface is used to validate the new value that is being written to a property. This allows the component that registered the property to have some control over what is written into their property by external components.

Constructor & Destructor Documentation

~CommunicationPropertyValidatorInterface()

template<typename T>

virtual alexaClientSDK::acsdkCommunicationInterfaces::CommunicationPropertyValidatorInterface< T >::~CommunicationPropertyValidatorInterface ( )

virtualdefault

default destructor

Member Function Documentation

validateWriteRequest()

template<typename T>

virtual bool alexaClientSDK::acsdkCommunicationInterfaces::CommunicationPropertyValidatorInterface< T >::validateWriteRequest ( const std::string &  propertyName, T  newValue  )

pure virtual

Called when we want to write to a property. Used to validate before we write the newValue

Parameters

propertyName	The name of the property
newValue	The new value of the property

Returns

true if alright to write value, false otherwise.

Implemented in alexaClientSDK::acsdkCommunication::AlwaysTrueCommunicationValidator< T >, and alexaClientSDK::acsdkCommunication::test::FalseValidator.

---

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

• /workplace/avs-device-sdk/shared/acsdkCommunicationInterfaces/include/acsdkCommunicationInterfaces/CommunicationPropertyValidatorInterface.h