alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsSerializerInterface Class Reference

#include <VisualCharacteristicsSerializerInterface.h>

Public Member Functions
virtual	~VisualCharacteristicsSerializerInterface ()=default
virtual bool	serializeInteractionModes (const std::vector< visualCharacteristicsInterfaces::InteractionMode > &interactionModes, std::string &serializedJson)=0
virtual bool	serializeWindowTemplate (const std::vector< visualCharacteristicsInterfaces::WindowTemplate > &windowTemplates, std::string &serializedJson)=0
virtual bool	serializeDisplayCharacteristics (const visualCharacteristicsInterfaces::DisplayCharacteristics &display, std::string &serializedJson)=0

Detailed Description

Interface contract for VisualCharacteristicsSerializer

Constructor & Destructor Documentation

~VisualCharacteristicsSerializerInterface()

virtual alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsSerializerInterface::~VisualCharacteristicsSerializerInterface ( )

virtualdefault

Destructor

Member Function Documentation

serializeDisplayCharacteristics()

virtual bool alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsSerializerInterface::serializeDisplayCharacteristics ( const visualCharacteristicsInterfaces::DisplayCharacteristics &  display, std::string &  serializedJson  )

pure virtual

Serialize display characteristics into reportable json format.

Parameters

display	Instance of DisplayCharacteristics to be serialized
serializedJson	[ out ] Serialized json payload

Returns

True if serialization successful, false otherwise.

serializeInteractionModes()

virtual bool alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsSerializerInterface::serializeInteractionModes ( const std::vector< visualCharacteristicsInterfaces::InteractionMode > &  interactionModes, std::string &  serializedJson  )

pure virtual

Serialize interaction modes into reportable json format.

Parameters

interactionModes	Collection of InteractionMode to be serialized
serializedJson	[ out ] Serialized json payload

Returns

True if serialization successful, false otherwise.

serializeWindowTemplate()

virtual bool alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsSerializerInterface::serializeWindowTemplate ( const std::vector< visualCharacteristicsInterfaces::WindowTemplate > &  windowTemplates, std::string &  serializedJson  )

pure virtual

Serialize window template into reportable json format.

Parameters

windowTemplates	Collection of WindowTemplate to be serialized
serializedJson	[ out ] Serialized json payload

Returns

True if serialization successful, false otherwise.

---

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

• /workplace/avs-device-sdk/capabilities/VisualCharacteristics/VisualCharacteristicsInterfaces/include/acsdk/VisualCharacteristicsInterfaces/VisualCharacteristicsSerializerInterface.h