AlexaClientSDK  1.20.1
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Public Attributes | List of all members
alexaClientSDK::avsCommon::avs::CapabilityAgent::DirectiveInfo Class Reference

#include <CapabilityAgent.h>

Public Member Functions

 DirectiveInfo (std::shared_ptr< AVSDirective > directiveIn, std::unique_ptr< sdkInterfaces::DirectiveHandlerResultInterface > resultIn)
 
virtual ~DirectiveInfo ()=default
 

Public Attributes

std::shared_ptr< AVSDirectivedirective
 AVSDirective that is passed during preHandle. More...
 
std::shared_ptr< sdkInterfaces::DirectiveHandlerResultInterfaceresult
 DirectiveHandlerResultInterface. More...
 
std::atomic< bool > isCancelled
 Flag to indicate whether the directive is cancelled. More...
 

Detailed Description

CapabilityAgent maintains a map from messageId to instances of DirectiveInfo so that CapabilityAgents can track the processing of an AVSDirective.

Constructor & Destructor Documentation

◆ DirectiveInfo()

alexaClientSDK::avsCommon::avs::CapabilityAgent::DirectiveInfo::DirectiveInfo ( std::shared_ptr< AVSDirective directiveIn,
std::unique_ptr< sdkInterfaces::DirectiveHandlerResultInterface resultIn 
)

Constructor.

Parameters
directiveInThe AVSDirective with which to populate this DirectiveInfo.
resultInThe DirectiveHandlerResultInterface instance with which to populate this DirectiveInfo.

◆ ~DirectiveInfo()

virtual alexaClientSDK::avsCommon::avs::CapabilityAgent::DirectiveInfo::~DirectiveInfo ( )
virtualdefault

Destructor.

Member Data Documentation

◆ directive

std::shared_ptr<AVSDirective> alexaClientSDK::avsCommon::avs::CapabilityAgent::DirectiveInfo::directive

AVSDirective that is passed during preHandle.

◆ isCancelled

std::atomic<bool> alexaClientSDK::avsCommon::avs::CapabilityAgent::DirectiveInfo::isCancelled

Flag to indicate whether the directive is cancelled.

◆ result

std::shared_ptr<sdkInterfaces::DirectiveHandlerResultInterface> alexaClientSDK::avsCommon::avs::CapabilityAgent::DirectiveInfo::result

DirectiveHandlerResultInterface.


The documentation for this class was generated from the following files:

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