alexaClientSDK::avsCommon::avs::ExceptionEncounteredSender Class Reference

#include <ExceptionEncounteredSender.h>

Inheritance diagram for alexaClientSDK::avsCommon::avs::ExceptionEncounteredSender:

Collaboration diagram for alexaClientSDK::avsCommon::avs::ExceptionEncounteredSender:

Public Member Functions
void	sendExceptionEncountered (const std::string &unparsedDirective, avs::ExceptionErrorType error, const std::string &errorDescription) override
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface
virtual	~ExceptionEncounteredSenderInterface ()=default

Static Public Member Functions
static std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface >	createExceptionEncounteredSenderInterface (const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &messageSender)
static std::unique_ptr< ExceptionEncounteredSender >	create (std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > messageSender)

Detailed Description

Class creates an ExceptionEncountered event and sends to AVS using MessageSenderInterface.

Member Function Documentation

create()

static std::unique_ptr<ExceptionEncounteredSender> alexaClientSDK::avsCommon::avs::ExceptionEncounteredSender::create ( std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface >  messageSender )

static

Creates a new ExceptionEncounteredSender instance.

Deprecated:

Use createExceptionEncounteredSenderInterface instead.

Parameters

messageSender

The object to use for sending events.

Returns

A std::unique_ptr to the new ExceptionEncounteredSender instance.

createExceptionEncounteredSenderInterface()

static std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> alexaClientSDK::avsCommon::avs::ExceptionEncounteredSender::createExceptionEncounteredSenderInterface ( const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &  messageSender )

static

Creates a new ExceptionEncounteredSenderInterface instance.

Parameters

messageSender

The object to use for sending events.

Returns

A std::shared_ptr to the new ExceptionEncounteredSenderInterface instance.

sendExceptionEncountered()

void alexaClientSDK::avsCommon::avs::ExceptionEncounteredSender::sendExceptionEncountered ( const std::string &  unparsedDirective, avs::ExceptionErrorType  error, const std::string &  errorDescription  )

overridevirtual

This function asks the ExceptionEncounteredSender to send a ExceptionEncountered event to AVS when the client is unable to execute a directive.

Parameters

unparsedDirective	The directive which the client was unable to execute, must be sent to AVS
error	The ExceptionErrorType to be sent to AVS
errorDescription	The error details to be sent for logging and troubleshooting.

Implements alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface.

---

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

• /workplace/avs-device-sdk/AVSCommon/AVS/include/AVSCommon/AVS/ExceptionEncounteredSender.h