AlexaClientSDK  1.20.1
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface Class Referenceabstract

#include <ExceptionEncounteredSenderInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~ExceptionEncounteredSenderInterface ()=default
 
virtual void sendExceptionEncountered (const std::string &unparsedDirective, avs::ExceptionErrorType error, const std::string &errorDescription)=0
 

Detailed Description

This specifies the interface to send an ExceptionEncountered event to AVS.

Constructor & Destructor Documentation

◆ ~ExceptionEncounteredSenderInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface::~ExceptionEncounteredSenderInterface ( )
virtualdefault

Virtual destructor to ensure proper cleanup by derived types.

Member Function Documentation

◆ sendExceptionEncountered()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface::sendExceptionEncountered ( const std::string &  unparsedDirective,
avs::ExceptionErrorType  error,
const std::string &  errorDescription 
)
pure virtual

Send a System::ExceptionEncountered message to AVS.

Note
The implementation of this method MUST return quickly. Failure to do so blocks the processing of subsequent AVSDirectives.
Parameters
unparsedDirectiveThe unparsed JSON of the directive.
errorThe type of error encountered.
errorDescriptionAdditional error details for logging and troubleshooting.

Implemented in alexaClientSDK::capabilityAgents::mrm::test::WaitableExceptionEncounteredSender, alexaClientSDK::avsCommon::avs::ExceptionEncounteredSender, and alexaClientSDK::integration::test::TestExceptionEncounteredSender.


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

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