AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::toggleController::ToggleControllerAttributeBuilderInterface Class Referenceabstract

#include <ToggleControllerAttributeBuilderInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::toggleController::ToggleControllerAttributeBuilderInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~ToggleControllerAttributeBuilderInterface ()=default
 
virtual ToggleControllerAttributeBuilderInterfacewithCapabilityResources (const avsCommon::avs::CapabilityResources &capabilityResources)=0
 
virtual ToggleControllerAttributeBuilderInterfacewithSemantics (const avsCommon::avs::capabilitySemantics::CapabilitySemantics &semantics)=0
 
virtual utils::Optional< ToggleControllerAttributesbuild ()=0
 

Detailed Description

Interface for a toggle controller attribute builder.

The builder is responsible for building a ToggleControllerAttributes object.

Note
The following attributes are mandatory and the build will fail if they are missing:
  • At least one capability friendly name

Constructor & Destructor Documentation

◆ ~ToggleControllerAttributeBuilderInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::toggleController::ToggleControllerAttributeBuilderInterface::~ToggleControllerAttributeBuilderInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ build()

virtual utils::Optional<ToggleControllerAttributes> alexaClientSDK::avsCommon::sdkInterfaces::toggleController::ToggleControllerAttributeBuilderInterface::build ( )
pure virtual

Builds a ToggleControllerAttributes with the configured properties.

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

Implemented in alexaClientSDK::capabilityAgents::toggleController::ToggleControllerAttributeBuilder.

◆ withCapabilityResources()

virtual ToggleControllerAttributeBuilderInterface& alexaClientSDK::avsCommon::sdkInterfaces::toggleController::ToggleControllerAttributeBuilderInterface::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
capabilityResourcesThe capability resources represented using CapabilityResources.
Returns
This builder which can be used to nest configuration function calls.

Implemented in alexaClientSDK::capabilityAgents::toggleController::ToggleControllerAttributeBuilder.

◆ withSemantics()

virtual ToggleControllerAttributeBuilderInterface& alexaClientSDK::avsCommon::sdkInterfaces::toggleController::ToggleControllerAttributeBuilderInterface::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-togglecontroller.html
Parameters
semanticsThe CapabilitySemantics representing the semantics definition.
Returns
This builder, which can be used to nest configuration function calls.

Implemented in alexaClientSDK::capabilityAgents::toggleController::ToggleControllerAttributeBuilder.


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

AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0