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

Namespaces

 aplEventPayload
 
 test
 

Classes

class  APLCapabilityAgentInterface
 
class  APLCapabilityAgentObserverInterface
 
class  APLDocumentObserverInterface
 
class  APLDocumentSessionInterface
 
class  APLRuntimeInterface
 
struct  AutoInitializedExtension
 
struct  GrantedExtension
 
struct  PresentationOptions
 
struct  PresentationSession
 
struct  VideoSettings
 
class  VisualStateProviderInterface
 

Typedefs

using APLCapabilityAgentNotifierInterface = notifierInterfaces::NotifierInterface< APLCapabilityAgentObserverInterface >
 
using PresentationToken = std::string
 Alias for the token used by APL directives. More...
 

Enumerations

enum  APLCommandExecutionEvent { APLCommandExecutionEvent::RESOLVED, APLCommandExecutionEvent::TERMINATED, APLCommandExecutionEvent::FAILED }
 Enumeration of APL Command Execution Events that can be reported to the APL capability agent. More...
 
enum  APLTimeoutType { APLTimeoutType::SHORT, APLTimeoutType::TRANSIENT, APLTimeoutType::LONG }
 

Functions

std::string commandExecutionEventToString (const APLCommandExecutionEvent event)
 
APLCommandExecutionEvent stringToCommandExecutionEvent (const std::string &eventStr)
 
static alexaClientSDK::avsCommon::utils::Optional< APLTimeoutTypeconvertToTimeoutType (const std::string &timeoutTypeStr)
 

Typedef Documentation

◆ APLCapabilityAgentNotifierInterface

Interface for registering to observe APL directives.

◆ PresentationToken

Alias for the token used by APL directives.

Enumeration Type Documentation

◆ APLCommandExecutionEvent

Enumeration of APL Command Execution Events that can be reported to the APL capability agent.

Enumerator
RESOLVED 

command sequence was resolved.

TERMINATED 

command sequence was terminated.

FAILED 

failed to parse/handle the command sequence.

◆ APLTimeoutType

Strongly-typed timeoutType as defined in the API specification https://developer.amazon.com/en-US/docs/alexa/alexa-voice-service/presentation-apl.html#renderdocument

Enumerator
SHORT 
TRANSIENT 
LONG 

Function Documentation

◆ commandExecutionEventToString()

std::string alexaClientSDK::aplCapabilityCommonInterfaces::commandExecutionEventToString ( const APLCommandExecutionEvent  event)
inline

This is a function to convert the AplCommandExecutionEvent to a string.

◆ convertToTimeoutType()

static alexaClientSDK::avsCommon::utils::Optional<APLTimeoutType> alexaClientSDK::aplCapabilityCommonInterfaces::convertToTimeoutType ( const std::string &  timeoutTypeStr)
inlinestatic

◆ stringToCommandExecutionEvent()

APLCommandExecutionEvent alexaClientSDK::aplCapabilityCommonInterfaces::stringToCommandExecutionEvent ( const std::string &  eventStr)
inline

This is a function to convert a string to a AplCommandExecutionEvent.

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