alexaClientSDK::capabilityAgents::toggleController::ToggleControllerAttributeBuilder Class Reference

#include <ToggleControllerAttributeBuilder.h>

Inheritance diagram for alexaClientSDK::capabilityAgents::toggleController::ToggleControllerAttributeBuilder:

Collaboration diagram for alexaClientSDK::capabilityAgents::toggleController::ToggleControllerAttributeBuilder:

Public Member Functions
virtual	~ToggleControllerAttributeBuilder ()=default
ToggleControllerAttributeBuilderInterface Functions
ToggleControllerAttributeBuilder &	withCapabilityResources (const avsCommon::avs::CapabilityResources &capabilityResources) override
ToggleControllerAttributeBuilder &	withSemantics (const avsCommon::avs::capabilitySemantics::CapabilitySemantics &semantics) override
avsCommon::utils::Optional< avsCommon::sdkInterfaces::toggleController::ToggleControllerAttributes >	build () override
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::toggleController::ToggleControllerAttributeBuilderInterface
virtual	~ToggleControllerAttributeBuilderInterface ()=default

Static Public Member Functions
static std::unique_ptr< ToggleControllerAttributeBuilder >	create ()

Detailed Description

This class implements ToggleControllerAttributeBuilderInterface to build ToggleControllerAttributes.

Constructor & Destructor Documentation

~ToggleControllerAttributeBuilder()

virtual alexaClientSDK::capabilityAgents::toggleController::ToggleControllerAttributeBuilder::~ToggleControllerAttributeBuilder ( )

virtualdefault

Destructor.

Member Function Documentation

build()

avsCommon::utils::Optional<avsCommon::sdkInterfaces::toggleController::ToggleControllerAttributes> alexaClientSDK::capabilityAgents::toggleController::ToggleControllerAttributeBuilder::build ( )

overridevirtual

Builds a ToggleControllerAttributes with the configured properties.

Returns

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

Implements alexaClientSDK::avsCommon::sdkInterfaces::toggleController::ToggleControllerAttributeBuilderInterface.

create()

static std::unique_ptr<ToggleControllerAttributeBuilder> alexaClientSDK::capabilityAgents::toggleController::ToggleControllerAttributeBuilder::create ( )

static

Create an instance of ToggleControllerAttributeBuilder.

Returns

Returns a new instance of ToggleControllerAttributeBuilder.

withCapabilityResources()

ToggleControllerAttributeBuilder& alexaClientSDK::capabilityAgents::toggleController::ToggleControllerAttributeBuilder::withCapabilityResources ( const avsCommon::avs::CapabilityResources &  capabilityResources )

overridevirtual

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.

Implements alexaClientSDK::avsCommon::sdkInterfaces::toggleController::ToggleControllerAttributeBuilderInterface.

withSemantics()

ToggleControllerAttributeBuilder& alexaClientSDK::capabilityAgents::toggleController::ToggleControllerAttributeBuilder::withSemantics ( const avsCommon::avs::capabilitySemantics::CapabilitySemantics &  semantics )

overridevirtual

Configures the builder to use the specified semantics definition.

See also

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

Parameters

semantics

The CapabilitySemantics representing the semantics definition.

Returns

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

Implements alexaClientSDK::avsCommon::sdkInterfaces::toggleController::ToggleControllerAttributeBuilderInterface.

---

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

• /workplace/avs-device-sdk/CapabilityAgents/ToggleController/include/ToggleController/ToggleControllerAttributeBuilder.h