#include <MessageRequestObserverInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::MessageRequestObserverInterface:

[legend]

Public Types
enum	Status { Status::PENDING, Status::SUCCESS, Status::SUCCESS_ACCEPTED, Status::SUCCESS_NO_CONTENT, Status::NOT_CONNECTED, Status::NOT_SYNCHRONIZED, Status::TIMEDOUT, Status::PROTOCOL_ERROR, Status::INTERNAL_ERROR, Status::SERVER_INTERNAL_ERROR_V2, Status::REFUSED, Status::CANCELED, Status::THROTTLED, Status::INVALID_AUTH, Status::BAD_REQUEST, Status::SERVER_OTHER_ERROR }

Public Member Functions
virtual	~MessageRequestObserverInterface ()=default

virtual void	onResponseStatusReceived (MessageRequestObserverInterface::Status status)

virtual void	onSendCompleted (MessageRequestObserverInterface::Status status)=0

virtual void	onExceptionReceived (const std::string &exceptionMessage)=0

Detailed Description

An interface class which allows a derived class to observe a MessageRequest implementation.

Member Enumeration Documentation

◆ Status

enum alexaClientSDK::avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status

strong

This enum expresses the various end-states that a send request could arrive at.

Enumerator
PENDING	The message has not yet been processed for sending.
SUCCESS	The message was successfully sent.
SUCCESS_ACCEPTED	The message was accepted by the server.
SUCCESS_NO_CONTENT	The message was successfully sent but the HTTPReponse had no content.
NOT_CONNECTED	The send failed because AVS was not connected.
NOT_SYNCHRONIZED	The send failed because AVS is not synchronized.
TIMEDOUT	The send failed because of timeout waiting for AVS response.
PROTOCOL_ERROR	The send failed due to an underlying protocol error.
INTERNAL_ERROR	The send failed due to an internal error within ACL.
SERVER_INTERNAL_ERROR_V2	The send failed due to an internal error on the server which sends code 500.
REFUSED	The send failed due to server refusing the request.
CANCELED	The send failed due to server canceling it before the transmission completed.
THROTTLED	The send failed due to excessive load on the server.
INVALID_AUTH	The access credentials provided to ACL were invalid.
BAD_REQUEST	The send failed due to invalid request sent by the user.
SERVER_OTHER_ERROR	The send failed due to unknown server error.

Constructor & Destructor Documentation

◆ ~MessageRequestObserverInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::MessageRequestObserverInterface::~MessageRequestObserverInterface ( )

virtualdefault

Member Function Documentation

◆ onExceptionReceived()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::MessageRequestObserverInterface::onExceptionReceived ( const std::string & exceptionMessage )

pure virtual

Implemented in alexaClientSDK::capabilityAgents::aip::AudioInputProcessor, alexaClientSDK::capabilityAgents::alexa::AlexaInterfaceMessageSender, alexaClientSDK::capabilityAgents::system::SoftwareInfoSendRequest, alexaClientSDK::settings::SettingEventRequestObserver, and alexaClientSDK::avsCommon::utils::observer::test::TestMessageRequestObserver.

◆ onResponseStatusReceived()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::MessageRequestObserverInterface::onResponseStatusReceived ( MessageRequestObserverInterface::Status status )

inlinevirtual

Called when the Response code is received.

Parameters

status The status of the response that was received.

Reimplemented in alexaClientSDK::capabilityAgents::aip::AudioInputProcessor.

◆ onSendCompleted()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::MessageRequestObserverInterface::onSendCompleted ( MessageRequestObserverInterface::Status status )