AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Classes | Functions | Variables
alexaClientSDK::capabilityAgents::toggleController Namespace Reference

Namespaces

 test
 

Classes

class  ToggleControllerAttributeBuilder
 
class  ToggleControllerCapabilityAgent
 

Functions

static bool isToggleControllerAttributeValid (const ToggleControllerAttributes &toggleControllerAttributes)
 

Variables

static const std::string TAG {"ToggleControllerAttributeBuilder"}
 String to identify log entries originating from this file. More...
 
static const std::string TAG {"ToggleControllerCapabilityAgent"}
 String to identify log entries originating from this file. More...
 
static const std::string NAMESPACE {"Alexa.ToggleController"}
 The namespace for this capability agent. More...
 
static const std::string INTERFACE_VERSION {"3"}
 The supported version. More...
 
static const std::string NAME_TURNON {"TurnOn"}
 The name for TurnOn directive. More...
 
static const std::string NAME_TURNOFF {"TurnOff"}
 The name for TurnOff directive. More...
 
static const std::string TOGGLESTATE_PROPERTY_NAME {"toggleState"}
 The name of toggleState property. More...
 
static const std::string TOGGLESTATE_ON {R"("ON")"}
 Json value for ON toggle state. More...
 
static const std::string TOGGLESTATE_OFF {R"("OFF")"}
 Json value for OFF toggle state. More...
 
static const std::string CAPABILITY_RESOURCES_KEY {"capabilityResources"}
 The capabilityResources key. More...
 
static const std::string CAPABILITY_SEMANTICS_KEY {"semantics"}
 The semantics key. More...
 

Function Documentation

◆ isToggleControllerAttributeValid()

static bool alexaClientSDK::capabilityAgents::toggleController::isToggleControllerAttributeValid ( const ToggleControllerAttributes toggleControllerAttributes)
static

Helper function to validate the toggle controller attributes.

Parameters
toggleControllerAttributesThe toggle controller attribute to be validated.
Returns
true if valid, otherwise false.

Variable Documentation

◆ CAPABILITY_RESOURCES_KEY

const std::string alexaClientSDK::capabilityAgents::toggleController::CAPABILITY_RESOURCES_KEY {"capabilityResources"}
static

The capabilityResources key.

◆ CAPABILITY_SEMANTICS_KEY

const std::string alexaClientSDK::capabilityAgents::toggleController::CAPABILITY_SEMANTICS_KEY {"semantics"}
static

The semantics key.

◆ INTERFACE_VERSION

const std::string alexaClientSDK::capabilityAgents::toggleController::INTERFACE_VERSION {"3"}
static

The supported version.

◆ NAME_TURNOFF

const std::string alexaClientSDK::capabilityAgents::toggleController::NAME_TURNOFF {"TurnOff"}
static

The name for TurnOff directive.

◆ NAME_TURNON

const std::string alexaClientSDK::capabilityAgents::toggleController::NAME_TURNON {"TurnOn"}
static

The name for TurnOn directive.

◆ NAMESPACE

const std::string alexaClientSDK::capabilityAgents::toggleController::NAMESPACE {"Alexa.ToggleController"}
static

The namespace for this capability agent.

◆ TAG [1/2]

const std::string alexaClientSDK::capabilityAgents::toggleController::TAG {"ToggleControllerAttributeBuilder"}
static

String to identify log entries originating from this file.

◆ TAG [2/2]

const std::string alexaClientSDK::capabilityAgents::toggleController::TAG {"ToggleControllerCapabilityAgent"}
static

String to identify log entries originating from this file.

◆ TOGGLESTATE_OFF

const std::string alexaClientSDK::capabilityAgents::toggleController::TOGGLESTATE_OFF {R"("OFF")"}
static

Json value for OFF toggle state.

◆ TOGGLESTATE_ON

const std::string alexaClientSDK::capabilityAgents::toggleController::TOGGLESTATE_ON {R"("ON")"}
static

Json value for ON toggle state.

◆ TOGGLESTATE_PROPERTY_NAME

const std::string alexaClientSDK::capabilityAgents::toggleController::TOGGLESTATE_PROPERTY_NAME {"toggleState"}
static

The name of toggleState property.

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