alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface Class Reference

#include <ExceptionEncounteredSenderInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface:

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

unparsedDirective	The unparsed JSON of the directive.
error	The type of error encountered.
errorDescription	Additional error details for logging and troubleshooting.

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

---

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

• /workplace/avs-device-sdk/AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/ExceptionEncounteredSenderInterface.h