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

Namespaces

 test
 

Classes

class  AlexaEventProcessedNotifier
 
class  AlexaInterfaceCapabilityAgent
 
class  AlexaInterfaceMessageSender
 
class  AlexaInterfaceMessageSenderInternalInterface
 

Typedefs

using DefaultEndpointAnnotation = avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation
 

Variables

static const std::string ALEXA_INTERFACE_TYPE = "AlexaInterface"
 AlexaInterface interface type. More...
 
static const std::string ALEXA_INTERFACE_NAME = "Alexa"
 AlexaInterface interface name. More...
 
static const std::string ALEXA_INTERFACE_VERSION = "3"
 AlexaInterface interface version. More...
 
static const std::string TAG {"AlexaInterfaceCapabilityAgent"}
 String to identify log entries originating from this file. More...
 
static const std::string NAMESPACE = ALEXA_INTERFACE_NAME
 This string holds the namespace for the AlexaInterface directives. More...
 
static const std::string EVENT_PROCESSED_DIRECTIVE_NAME = "EventProcessed"
 The Alexa.EventProcessed directive name. More...
 
static const std::string REPORT_STATE_DIRECTIVE_NAME = "ReportState"
 The Alexa.ReportState directive name. More...
 
static const std::string TAG {"AlexaInterfaceMessageSender"}
 String to identify log entries originating from this file. More...
 
static const std::string EVENT_NAME_STATE_REPORT_STRING = "StateReport"
 Name of response events. More...
 
static const std::string EVENT_NAME_RESPONSE_STRING = "Response"
 Name of response events. More...
 
static const std::string EVENT_NAME_ERROR_RESPONSE_STRING = "ErrorResponse"
 Name of error response events. More...
 
static const std::string EVENT_NAME_DEFERRED_RESPONSE_STRING = "DeferredResponse"
 Name of error response events. More...
 
static const std::string EVENT_NAME_CHANGE_REPORT_STRING = "ChangeReport"
 Name of error response events. More...
 
static const std::string ESTIMATED_DEFERRAL_KEY_STRING = "estimatedDeferralInSeconds"
 The estimated deferral key. More...
 
static const std::string CAUSE_KEY_STRING = "cause"
 The cause key. More...
 
static const std::string CHANGE_KEY_STRING = "change"
 The change key. More...
 
static const std::string MESSAGE_KEY_STRING = "message"
 The message key in the event. More...
 
static const std::string PROPERTIES_KEY_STRING = "properties"
 The properties key. More...
 
static const std::string TIME_OF_SAMPLE_KEY_STRING = "timeOfSample"
 The timeOfSample key. More...
 
static const std::string TYPE_KEY_STRING = "type"
 The type key. More...
 
static const std::string UNCERTAINTY_IN_MILLISECONDS_KEY_STRING = "uncertaintyInMilliseconds"
 The type key. More...
 
static const std::string VALUE_KEY_STRING = "value"
 The value key. More...
 
static const std::map< AlexaInterfaceMessageSender::ErrorResponseType, std::string > errorTypeMap
 Map of AlexaInterfaceMessageSender::ErrorResponseTypes to their string representations. More...
 
static const std::map< AlexaStateChangeCauseType, std::string > causeTypeMap
 Map of AlexaStateChangeCauseType to their string representations. More...
 

Typedef Documentation

◆ DefaultEndpointAnnotation

Variable Documentation

◆ ALEXA_INTERFACE_NAME

const std::string alexaClientSDK::capabilityAgents::alexa::ALEXA_INTERFACE_NAME = "Alexa"
static

AlexaInterface interface name.

◆ ALEXA_INTERFACE_TYPE

const std::string alexaClientSDK::capabilityAgents::alexa::ALEXA_INTERFACE_TYPE = "AlexaInterface"
static

AlexaInterface interface type.

◆ ALEXA_INTERFACE_VERSION

const std::string alexaClientSDK::capabilityAgents::alexa::ALEXA_INTERFACE_VERSION = "3"
static

AlexaInterface interface version.

◆ CAUSE_KEY_STRING

const std::string alexaClientSDK::capabilityAgents::alexa::CAUSE_KEY_STRING = "cause"
static

The cause key.

◆ causeTypeMap

const std::map<AlexaStateChangeCauseType, std::string> alexaClientSDK::capabilityAgents::alexa::causeTypeMap
static
Initial value:
= {
{AlexaStateChangeCauseType::ALEXA_INTERACTION, "ALEXA_INTERACTION"},
{AlexaStateChangeCauseType::APP_INTERACTION, "APP_INTERACTION"},
{AlexaStateChangeCauseType::PHYSICAL_INTERACTION, "PHYSICAL_INTERACTION"},
{AlexaStateChangeCauseType::PERIODIC_POLL, "PERIODIC_POLL"},
{AlexaStateChangeCauseType::RULE_TRIGGER, "RULE_TRIGGER"},
{AlexaStateChangeCauseType::VOICE_INTERACTION, "VOICE_INTERACTION"}}

Map of AlexaStateChangeCauseType to their string representations.

◆ CHANGE_KEY_STRING

const std::string alexaClientSDK::capabilityAgents::alexa::CHANGE_KEY_STRING = "change"
static

The change key.

◆ errorTypeMap

const std::map<AlexaInterfaceMessageSender::ErrorResponseType, std::string> alexaClientSDK::capabilityAgents::alexa::errorTypeMap
static
Initial value:
= {
{AlexaInterfaceMessageSender::ErrorResponseType::ALREADY_IN_OPERATION, "ALREADY_IN_OPERATION"},
{AlexaInterfaceMessageSender::ErrorResponseType::BRIDGE_UNREACHABLE, "BRIDGE_UNREACHABLE"},
{AlexaInterfaceMessageSender::ErrorResponseType::ENDPOINT_BUSY, "ENDPOINT_BUSY"},
{AlexaInterfaceMessageSender::ErrorResponseType::ENDPOINT_LOW_POWER, "ENDPOINT_LOW_POWER"},
{AlexaInterfaceMessageSender::ErrorResponseType::ENDPOINT_UNREACHABLE, "ENDPOINT_UNREACHABLE"},
{AlexaInterfaceMessageSender::ErrorResponseType::EXPIRED_AUTHORIZATION_CREDENTIAL,
"EXPIRED_AUTHORIZATION_CREDENTIAL"},
{AlexaInterfaceMessageSender::ErrorResponseType::FIRMWARE_OUT_OF_DATE, "FIRMWARE_OUT_OF_DATE"},
{AlexaInterfaceMessageSender::ErrorResponseType::HARDWARE_MALFUNCTION, "HARDWARE_MALFUNCTION"},
{AlexaInterfaceMessageSender::ErrorResponseType::INSUFFICIENT_PERMISSIONS, "INSUFFICIENT_PERMISSIONS"},
{AlexaInterfaceMessageSender::ErrorResponseType::INTERNAL_ERROR, "INTERNAL_ERROR"},
{AlexaInterfaceMessageSender::ErrorResponseType::INVALID_AUTHORIZATION_CREDENTIAL,
"INVALID_AUTHORIZATION_CREDENTIAL"},
{AlexaInterfaceMessageSender::ErrorResponseType::INVALID_DIRECTIVE, "INVALID_DIRECTIVE"},
{AlexaInterfaceMessageSender::ErrorResponseType::INVALID_VALUE, "INVALID_VALUE"},
{AlexaInterfaceMessageSender::ErrorResponseType::NO_SUCH_ENDPOINT, "NO_SUCH_ENDPOINT"},
{AlexaInterfaceMessageSender::ErrorResponseType::NOT_CALIBRATED, "NOT_CALIBRATED"},
{AlexaInterfaceMessageSender::ErrorResponseType::NOT_SUPPORTED_IN_CURRENT_MODE, "NOT_SUPPORTED_IN_CURRENT_MODE"},
{AlexaInterfaceMessageSender::ErrorResponseType::NOT_IN_OPERATION, "NOT_IN_OPERATION"},
{AlexaInterfaceMessageSender::ErrorResponseType::POWER_LEVEL_NOT_SUPPORTED, "POWER_LEVEL_NOT_SUPPORTED"},
{AlexaInterfaceMessageSender::ErrorResponseType::RATE_LIMIT_EXCEEDED, "RATE_LIMIT_EXCEEDED"},
{AlexaInterfaceMessageSender::ErrorResponseType::TEMPERATURE_VALUE_OUT_OF_RANGE, "TEMPERATURE_VALUE_OUT_OF_RANGE"},
{AlexaInterfaceMessageSender::ErrorResponseType::VALUE_OUT_OF_RANGE, "VALUE_OUT_OF_RANGE"}}

Map of AlexaInterfaceMessageSender::ErrorResponseTypes to their string representations.

◆ ESTIMATED_DEFERRAL_KEY_STRING

const std::string alexaClientSDK::capabilityAgents::alexa::ESTIMATED_DEFERRAL_KEY_STRING = "estimatedDeferralInSeconds"
static

The estimated deferral key.

◆ EVENT_NAME_CHANGE_REPORT_STRING

const std::string alexaClientSDK::capabilityAgents::alexa::EVENT_NAME_CHANGE_REPORT_STRING = "ChangeReport"
static

Name of error response events.

◆ EVENT_NAME_DEFERRED_RESPONSE_STRING

const std::string alexaClientSDK::capabilityAgents::alexa::EVENT_NAME_DEFERRED_RESPONSE_STRING = "DeferredResponse"
static

Name of error response events.

◆ EVENT_NAME_ERROR_RESPONSE_STRING

const std::string alexaClientSDK::capabilityAgents::alexa::EVENT_NAME_ERROR_RESPONSE_STRING = "ErrorResponse"
static

Name of error response events.

◆ EVENT_NAME_RESPONSE_STRING

const std::string alexaClientSDK::capabilityAgents::alexa::EVENT_NAME_RESPONSE_STRING = "Response"
static

Name of response events.

◆ EVENT_NAME_STATE_REPORT_STRING

const std::string alexaClientSDK::capabilityAgents::alexa::EVENT_NAME_STATE_REPORT_STRING = "StateReport"
static

Name of response events.

◆ EVENT_PROCESSED_DIRECTIVE_NAME

const std::string alexaClientSDK::capabilityAgents::alexa::EVENT_PROCESSED_DIRECTIVE_NAME = "EventProcessed"
static

The Alexa.EventProcessed directive name.

◆ MESSAGE_KEY_STRING

const std::string alexaClientSDK::capabilityAgents::alexa::MESSAGE_KEY_STRING = "message"
static

The message key in the event.

◆ NAMESPACE

const std::string alexaClientSDK::capabilityAgents::alexa::NAMESPACE = ALEXA_INTERFACE_NAME
static

This string holds the namespace for the AlexaInterface directives.

◆ PROPERTIES_KEY_STRING

const std::string alexaClientSDK::capabilityAgents::alexa::PROPERTIES_KEY_STRING = "properties"
static

The properties key.

◆ REPORT_STATE_DIRECTIVE_NAME

const std::string alexaClientSDK::capabilityAgents::alexa::REPORT_STATE_DIRECTIVE_NAME = "ReportState"
static

The Alexa.ReportState directive name.

◆ TAG [1/2]

const std::string alexaClientSDK::capabilityAgents::alexa::TAG {"AlexaInterfaceCapabilityAgent"}
static

String to identify log entries originating from this file.

◆ TAG [2/2]

const std::string alexaClientSDK::capabilityAgents::alexa::TAG {"AlexaInterfaceMessageSender"}
static

String to identify log entries originating from this file.

◆ TIME_OF_SAMPLE_KEY_STRING

const std::string alexaClientSDK::capabilityAgents::alexa::TIME_OF_SAMPLE_KEY_STRING = "timeOfSample"
static

The timeOfSample key.

◆ TYPE_KEY_STRING

const std::string alexaClientSDK::capabilityAgents::alexa::TYPE_KEY_STRING = "type"
static

The type key.

◆ UNCERTAINTY_IN_MILLISECONDS_KEY_STRING

const std::string alexaClientSDK::capabilityAgents::alexa::UNCERTAINTY_IN_MILLISECONDS_KEY_STRING = "uncertaintyInMilliseconds"
static

The type key.

◆ VALUE_KEY_STRING

const std::string alexaClientSDK::capabilityAgents::alexa::VALUE_KEY_STRING = "value"
static

The value key.

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