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

Namespaces

 test
 

Classes

class  InteractionModelCapabilityAgent
 
class  InteractionModelNotifier
 

Typedefs

using InteractionModelComponent = acsdkManufactory::Component< std::shared_ptr< acsdkInteractionModelInterfaces::InteractionModelNotifierInterface >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::DirectiveSequencerInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > >, acsdkManufactory::Import< acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface > >>
 

Functions

InteractionModelComponent getComponent ()
 
static std::shared_ptr< CapabilityConfigurationgetInteractionModelCapabilityConfiguration ()
 

Variables

static const std::string TAG {"InteractionModel"}
 String to identify log entries originating from this file. More...
 
static const std::string NAMESPACE = "InteractionModel"
 The namespace for this capability agent. More...
 
static const NamespaceAndName NEW_DIALOG_REQUEST {NAMESPACE, "NewDialogRequest"}
 The NewDialogRequest directive signature. More...
 
static const NamespaceAndName REQUEST_PROCESS_STARTED {NAMESPACE, "RequestProcessingStarted"}
 The RequestProcessingStarted (RPS) directive signature. More...
 
static const NamespaceAndName REQUEST_PROCESS_COMPLETED {NAMESPACE, "RequestProcessingCompleted"}
 The RequestProcessingCompleted (RPC) directive signature. More...
 
static const std::string INTERACTION_MODEL_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"
 
static const std::string INTERACTION_MODEL_CAPABILITY_INTERFACE_NAME = "InteractionModel"
 Interaction Model interface name. More...
 
static const std::string INTERACTION_MODEL_CAPABILITY_INTERFACE_VERSION = "1.2"
 Interaction Model interface version. More...
 
static const std::string PAYLOAD_KEY_DIALOG_REQUEST_ID = "dialogRequestId"
 NewDialogRequestID payload key. More...
 

Typedef Documentation

◆ InteractionModelComponent

Manufactory Component definition for the InteractionModelNotifierInterface.

Function Documentation

◆ getComponent()

InteractionModelComponent alexaClientSDK::acsdkInteractionModel::getComponent ( )

Get the Manufactory component for the acsdkInteractionModel Notifier, Capability Agent, and related.

Returns
The Manufactory component for acsdkInteractionModel.

◆ getInteractionModelCapabilityConfiguration()

static std::shared_ptr<CapabilityConfiguration> alexaClientSDK::acsdkInteractionModel::getInteractionModelCapabilityConfiguration ( )
static

Creates the Interaction Model capability configuration.

Returns
The Interaction Model capability configuration.

Variable Documentation

◆ INTERACTION_MODEL_CAPABILITY_INTERFACE_NAME

const std::string alexaClientSDK::acsdkInteractionModel::INTERACTION_MODEL_CAPABILITY_INTERFACE_NAME = "InteractionModel"
static

Interaction Model interface name.

◆ INTERACTION_MODEL_CAPABILITY_INTERFACE_TYPE

const std::string alexaClientSDK::acsdkInteractionModel::INTERACTION_MODEL_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"
static

Interaction Model capability constants Interaction Model interface type

◆ INTERACTION_MODEL_CAPABILITY_INTERFACE_VERSION

const std::string alexaClientSDK::acsdkInteractionModel::INTERACTION_MODEL_CAPABILITY_INTERFACE_VERSION = "1.2"
static

Interaction Model interface version.

◆ NAMESPACE

const std::string alexaClientSDK::acsdkInteractionModel::NAMESPACE = "InteractionModel"
static

The namespace for this capability agent.

◆ NEW_DIALOG_REQUEST

const NamespaceAndName alexaClientSDK::acsdkInteractionModel::NEW_DIALOG_REQUEST {NAMESPACE, "NewDialogRequest"}
static

The NewDialogRequest directive signature.

◆ PAYLOAD_KEY_DIALOG_REQUEST_ID

const std::string alexaClientSDK::acsdkInteractionModel::PAYLOAD_KEY_DIALOG_REQUEST_ID = "dialogRequestId"
static

NewDialogRequestID payload key.

◆ REQUEST_PROCESS_COMPLETED

const NamespaceAndName alexaClientSDK::acsdkInteractionModel::REQUEST_PROCESS_COMPLETED {NAMESPACE, "RequestProcessingCompleted"}
static

The RequestProcessingCompleted (RPC) directive signature.

◆ REQUEST_PROCESS_STARTED

const NamespaceAndName alexaClientSDK::acsdkInteractionModel::REQUEST_PROCESS_STARTED {NAMESPACE, "RequestProcessingStarted"}
static

The RequestProcessingStarted (RPS) directive signature.

◆ TAG

const std::string alexaClientSDK::acsdkInteractionModel::TAG {"InteractionModel"}
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