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

Namespaces

 test
 

Classes

class  ModeControllerAttributeBuilder
 
class  ModeControllerCapabilityAgent
 

Functions

static bool isModeControllerAttributesValid (const ModeControllerAttributes &modeControllerAttributes, const ModeControllerInterface::ModeControllerConfiguration &modeControllerConfiguration)
 
static bool parseDirectivePayload (const std::string &payload, Document *document)
 

Variables

static const std::string TAG {"ModeControllerAttributeBuilder"}
 String to identify log entries originating from this file. More...
 
static const std::string TAG {"ModeControllerCapabilityAgent"}
 String to identify log entries originating from this file. More...
 
static const std::string NAMESPACE {"Alexa.ModeController"}
 The namespace for this capability agent. More...
 
static const std::string INTERFACE_VERSION {"3"}
 The supported version. More...
 
static const std::string NAME_SETMODE {"SetMode"}
 The name for SetMode directive. More...
 
static const std::string NAME_ADJUSTMODE {"AdjustMode"}
 The name for AdjustMode directive. More...
 
static const std::string MODEVALUE_PROPERTY_NAME {"mode"}
 The name of mode property. More...
 
static const std::string CAPABILITY_RESOURCES_KEY {"capabilityResources"}
 The capabilityResources key. More...
 
static const std::string CAPABILITY_CONFIGURATION_KEY {"configuration"}
 The configuration key. More...
 
static const std::string CAPABILITY_SEMANTICS_KEY {"semantics"}
 The semantics key. More...
 
static const char MODE_KEY [] = "mode"
 The key in the directive payload. More...
 
static const char MODE_DELTA_KEY [] = "modeDelta"
 The key in the directive payload. More...
 

Function Documentation

◆ isModeControllerAttributesValid()

static bool alexaClientSDK::capabilityAgents::modeController::isModeControllerAttributesValid ( const ModeControllerAttributes modeControllerAttributes,
const ModeControllerInterface::ModeControllerConfiguration modeControllerConfiguration 
)
static

Helper function to validate the mode controller attributes and configuration.

Parameters
modeControllerAttributesThe mode controller attribute to be validated.
modeControllerConfigurationThe mode controller configuration to be validated.
Returns
true if valid, otherwise false.

◆ parseDirectivePayload()

static bool alexaClientSDK::capabilityAgents::modeController::parseDirectivePayload ( const std::string &  payload,
Document *  document 
)
static

Parses a directive payload JSON and returns a parsed document object.

Parameters
payloadJSON string to parse.
[out]documentPointer to a parsed document.
Returns
true if parsing was successful, false otherwise.

Variable Documentation

◆ CAPABILITY_CONFIGURATION_KEY

const std::string alexaClientSDK::capabilityAgents::modeController::CAPABILITY_CONFIGURATION_KEY {"configuration"}
static

The configuration key.

◆ CAPABILITY_RESOURCES_KEY

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

The capabilityResources key.

◆ CAPABILITY_SEMANTICS_KEY

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

The semantics key.

◆ INTERFACE_VERSION

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

The supported version.

◆ MODE_DELTA_KEY

const char alexaClientSDK::capabilityAgents::modeController::MODE_DELTA_KEY[] = "modeDelta"
static

The key in the directive payload.

◆ MODE_KEY

const char alexaClientSDK::capabilityAgents::modeController::MODE_KEY[] = "mode"
static

The key in the directive payload.

◆ MODEVALUE_PROPERTY_NAME

const std::string alexaClientSDK::capabilityAgents::modeController::MODEVALUE_PROPERTY_NAME {"mode"}
static

The name of mode property.

◆ NAME_ADJUSTMODE

const std::string alexaClientSDK::capabilityAgents::modeController::NAME_ADJUSTMODE {"AdjustMode"}
static

The name for AdjustMode directive.

◆ NAME_SETMODE

const std::string alexaClientSDK::capabilityAgents::modeController::NAME_SETMODE {"SetMode"}
static

The name for SetMode directive.

◆ NAMESPACE

const std::string alexaClientSDK::capabilityAgents::modeController::NAMESPACE {"Alexa.ModeController"}
static

The namespace for this capability agent.

◆ TAG [1/2]

const std::string alexaClientSDK::capabilityAgents::modeController::TAG {"ModeControllerAttributeBuilder"}
static

String to identify log entries originating from this file.

◆ TAG [2/2]

const std::string alexaClientSDK::capabilityAgents::modeController::TAG {"ModeControllerCapabilityAgent"}
static

String to identify log entries originating from this file.

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