alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributeBuilderInterface Class Reference

#include <RangeControllerAttributeBuilderInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributeBuilderInterface:

Public Member Functions
virtual	~RangeControllerAttributeBuilderInterface ()=default
virtual RangeControllerAttributeBuilderInterface &	withCapabilityResources (const avsCommon::avs::CapabilityResources &capabilityResources)=0
virtual RangeControllerAttributeBuilderInterface &	withUnitOfMeasure (const avsCommon::avs::resources::AlexaUnitOfMeasure &unitOfMeasure)=0
virtual RangeControllerAttributeBuilderInterface &	addPreset (const std::pair< double, avsCommon::sdkInterfaces::rangeController::PresetResources > &preset)=0
virtual RangeControllerAttributeBuilderInterface &	withSemantics (const avsCommon::avs::capabilitySemantics::CapabilitySemantics &semantics)=0
virtual utils::Optional< RangeControllerAttributes >	build ()=0

Detailed Description

Interface for a range controller attribute builder.

The builder is responsible for building a RangeControllerAttributes object.

Note

The following attributes are mandatory and the build will fail if they are missing:

• At least one capability friendly name.
• If presets are available, then their should be preset resources with at least one friendly name for that preset.

Constructor & Destructor Documentation

~RangeControllerAttributeBuilderInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributeBuilderInterface::~RangeControllerAttributeBuilderInterface ( )

virtualdefault

Destructor.

Member Function Documentation

addPreset()

virtual RangeControllerAttributeBuilderInterface& alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributeBuilderInterface::addPreset ( const std::pair< double, avsCommon::sdkInterfaces::rangeController::PresetResources > &  preset )

pure virtual

Adds a preset with preset value and its friendly names defined using FriendlyNames.

Note

Calling this with the same preset value shall overwrite the previous value.

Parameters

preset

The value of a preset and its preset resources represeneted using PresetResources.

Returns

This builder which can be used to nest configuration function calls.

build()

virtual utils::Optional<RangeControllerAttributes> alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributeBuilderInterface::build ( )

pure virtual

Builds a RangeControllerAttributes with the configured properties.

Returns

A non optional RangeControllerAttributes if the build succeeds; otherwise, an empty RangeControllerAttributes object.

Implemented in alexaClientSDK::capabilityAgents::rangeController::RangeControllerAttributeBuilder.

withCapabilityResources()

virtual RangeControllerAttributeBuilderInterface& alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributeBuilderInterface::withCapabilityResources ( const avsCommon::avs::CapabilityResources &  capabilityResources )

pure virtual

Configures builder to use capability resources.

Note

This will overwrite capability resources if it was used previously.

Parameters

capabilityResources

The capability resources represented using CapabilityResources.

Returns

This builder which can be used to nest configuration function calls.

Implemented in alexaClientSDK::capabilityAgents::rangeController::RangeControllerAttributeBuilder.

withSemantics()

virtual RangeControllerAttributeBuilderInterface& alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributeBuilderInterface::withSemantics ( const avsCommon::avs::capabilitySemantics::CapabilitySemantics &  semantics )

pure virtual

Configures the builder to use the specified semantics definition.

See also

https://developer.amazon.com/en-US/docs/alexa/alexa-voice-service/alexa-rangecontroller.html

Parameters

semantics

The CapabilitySemantics representing the semantics definition.

Returns

This builder, which can be used to nest configuration function calls.

Implemented in alexaClientSDK::capabilityAgents::rangeController::RangeControllerAttributeBuilder.

withUnitOfMeasure()

virtual RangeControllerAttributeBuilderInterface& alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributeBuilderInterface::withUnitOfMeasure ( const avsCommon::avs::resources::AlexaUnitOfMeasure &  unitOfMeasure )

pure virtual

Configures builder to use a unit of measure used for instance of range controller.

Note

This will overwrite unitOfMeasure if it was used previously.

Parameters

unitOfMeasure

The unit of measure of range controller.

Returns

This builder which can be used to nest configuration function calls.

Implemented in alexaClientSDK::capabilityAgents::rangeController::RangeControllerAttributeBuilder.

---

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

• /workplace/avs-device-sdk/AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/RangeController/RangeControllerAttributeBuilderInterface.h