alexaClientSDK::avsCommon::sdkInterfaces::modeController::ModeControllerAttributes Struct Reference

#include <ModeControllerAttributes.h>

Collaboration diagram for alexaClientSDK::avsCommon::sdkInterfaces::modeController::ModeControllerAttributes:

Public Member Functions
	ModeControllerAttributes ()
	ModeControllerAttributes (const avsCommon::avs::CapabilityResources &capabilityResources, const std::unordered_map< std::string, ModeResources > &modes, bool ordered)
	ModeControllerAttributes (const avsCommon::avs::CapabilityResources &capabilityResources, const std::unordered_map< std::string, ModeResources > &modes, bool ordered, avsCommon::utils::Optional< avsCommon::avs::capabilitySemantics::CapabilitySemantics > semantics)

Public Attributes
const avsCommon::avs::CapabilityResources	capabilityResources
	A capability resource CapabilityResources. More...
const std::unordered_map< std::string, ModeResources >	modes
	A map of controller supported modes string and their mode resource using ModeResources. More...
const bool	ordered
	If true indicates that the modes in modes are ordered. More...
avsCommon::utils::Optional< avsCommon::avs::capabilitySemantics::CapabilitySemantics >	semantics
	A semantics definition as an Optional CapabilitySemantics. More...

Detailed Description

Struct to hold the Mode Controller attributes required for Capability Agent discovery.

See also

https://developer.amazon.com/docs/alexa/alexa-voice-service/alexa-modecontroller.html#capability-assertion

Constructor & Destructor Documentation

ModeControllerAttributes() [1/3]

alexaClientSDK::avsCommon::sdkInterfaces::modeController::ModeControllerAttributes::ModeControllerAttributes ( )

inline

Default constructor.

Note

Avoid using this method. This was added only to enable the to use Optional::value().

ModeControllerAttributes() [2/3]

alexaClientSDK::avsCommon::sdkInterfaces::modeController::ModeControllerAttributes::ModeControllerAttributes ( const avsCommon::avs::CapabilityResources &  capabilityResources, const std::unordered_map< std::string, ModeResources > &  modes, bool  ordered  )

inline

Constructor to build the ModeControllerAttributes using provided values.

Parameters

capabilityResources	The capability resources.
modes	A map of controller modes and mode resources.
ordered	A boolean indicating the ordering of modes.

ModeControllerAttributes() [3/3]

alexaClientSDK::avsCommon::sdkInterfaces::modeController::ModeControllerAttributes::ModeControllerAttributes ( const avsCommon::avs::CapabilityResources &  capabilityResources, const std::unordered_map< std::string, ModeResources > &  modes, bool  ordered, avsCommon::utils::Optional< avsCommon::avs::capabilitySemantics::CapabilitySemantics >  semantics  )

inline

Constructor to build the ModeControllerAttributes using provided values.

Parameters

capabilityResources	The capability resources.
modes	A map of controller modes and mode resources.
ordered	A boolean indicating the ordering of modes.
semantics	The optional semantics definition.

Member Data Documentation

capabilityResources

const avsCommon::avs::CapabilityResources alexaClientSDK::avsCommon::sdkInterfaces::modeController::ModeControllerAttributes::capabilityResources

A capability resource CapabilityResources.

modes

const std::unordered_map<std::string, ModeResources> alexaClientSDK::avsCommon::sdkInterfaces::modeController::ModeControllerAttributes::modes

A map of controller supported modes string and their mode resource using ModeResources.

ordered

const bool alexaClientSDK::avsCommon::sdkInterfaces::modeController::ModeControllerAttributes::ordered

If true indicates that the modes in modes are ordered.

semantics

avsCommon::utils::Optional<avsCommon::avs::capabilitySemantics::CapabilitySemantics> alexaClientSDK::avsCommon::sdkInterfaces::modeController::ModeControllerAttributes::semantics

A semantics definition as an Optional CapabilitySemantics.

---

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

• /workplace/avs-device-sdk/AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/ModeController/ModeControllerAttributes.h