alexaClientSDK::capabilityAgents::alexa::AlexaInterfaceMessageSenderInternalInterface Class Reference

#include <AlexaInterfaceMessageSenderInternalInterface.h>

Inheritance diagram for alexaClientSDK::capabilityAgents::alexa::AlexaInterfaceMessageSenderInternalInterface:

Collaboration diagram for alexaClientSDK::capabilityAgents::alexa::AlexaInterfaceMessageSenderInternalInterface:

Public Member Functions
virtual	~AlexaInterfaceMessageSenderInternalInterface ()=default
virtual bool	sendStateReportEvent (const std::string &instance, const std::string &correlationToken, const avsCommon::avs::AVSMessageEndpoint &endpoint)=0
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface
virtual	~AlexaInterfaceMessageSenderInterface ()=default
virtual bool	sendResponseEvent (const std::string &instance, const std::string &correlationToken, const avsCommon::avs::AVSMessageEndpoint &endpoint, const std::string &jsonPayload="{}")=0
virtual bool	sendResponseEvent (const std::string &instance, const std::string &correlationToken, const avsCommon::avs::AVSMessageEndpoint &endpoint, const std::string &responseNamespace, const std::string &responseName, const std::string &jsonPayload="{}")=0
virtual bool	sendErrorResponseEvent (const std::string &instance, const std::string &correlationToken, const avsCommon::avs::AVSMessageEndpoint &endpoint, const ErrorResponseType errorType, const std::string &errorMessage="")=0
virtual bool	sendErrorResponseEvent (const std::string &instance, const std::string &correlationToken, const avsCommon::avs::AVSMessageEndpoint &endpoint, const std::string &responseNamespace, const std::string &jsonPayload="{}")=0
virtual bool	sendDeferredResponseEvent (const std::string &instance, const std::string &correlationToken, const int estimatedDeferralInSeconds=0)=0

Additional Inherited Members
Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface
enum	ErrorResponseType {   ErrorResponseType::ALREADY_IN_OPERATION, ErrorResponseType::BRIDGE_UNREACHABLE, ErrorResponseType::ENDPOINT_BUSY, ErrorResponseType::ENDPOINT_LOW_POWER,   ErrorResponseType::ENDPOINT_UNREACHABLE, ErrorResponseType::EXPIRED_AUTHORIZATION_CREDENTIAL, ErrorResponseType::FIRMWARE_OUT_OF_DATE, ErrorResponseType::HARDWARE_MALFUNCTION,   ErrorResponseType::INSUFFICIENT_PERMISSIONS, ErrorResponseType::INTERNAL_ERROR, ErrorResponseType::INVALID_AUTHORIZATION_CREDENTIAL, ErrorResponseType::INVALID_DIRECTIVE,   ErrorResponseType::INVALID_VALUE, ErrorResponseType::NO_SUCH_ENDPOINT, ErrorResponseType::NOT_CALIBRATED, ErrorResponseType::NOT_SUPPORTED_IN_CURRENT_MODE,   ErrorResponseType::NOT_IN_OPERATION, ErrorResponseType::POWER_LEVEL_NOT_SUPPORTED, ErrorResponseType::RATE_LIMIT_EXCEEDED, ErrorResponseType::TEMPERATURE_VALUE_OUT_OF_RANGE,   ErrorResponseType::VALUE_OUT_OF_RANGE }
enum	AlexaVideoErrorResponseType {   AlexaVideoErrorResponseType::ACTION_NOT_PERMITTED_FOR_CONTENT, AlexaVideoErrorResponseType::CONFIRMATION_REQUIRED, AlexaVideoErrorResponseType::CONTENT_NOT_RECORDABLE, AlexaVideoErrorResponseType::NOT_SUBSCRIBED,   AlexaVideoErrorResponseType::RECORDING_EXISTS, AlexaVideoErrorResponseType::STORAGE_FULL, AlexaVideoErrorResponseType::TITLE_DISAMBIGUATION_REQUIRED, AlexaVideoErrorResponseType::TUNER_OCCUPIED,   AlexaVideoErrorResponseType::NONE }
Static Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface
static std::string	alexaVideoErrorResponseToString (AlexaVideoErrorResponseType responseType)
static ErrorResponseType	alexaResponseTypeToErrorType (const avsCommon::avs::AlexaResponseType responseType)

Detailed Description

Specialization of AlexaInterfaceMessageSenderInterface to allow sending of internal AlexaInterface messages.

Constructor & Destructor Documentation

~AlexaInterfaceMessageSenderInternalInterface()

virtual alexaClientSDK::capabilityAgents::alexa::AlexaInterfaceMessageSenderInternalInterface::~AlexaInterfaceMessageSenderInternalInterface ( )

virtualdefault

Destructor.

Member Function Documentation

sendStateReportEvent()

virtual bool alexaClientSDK::capabilityAgents::alexa::AlexaInterfaceMessageSenderInternalInterface::sendStateReportEvent ( const std::string &  instance, const std::string &  correlationToken, const avsCommon::avs::AVSMessageEndpoint &  endpoint  )

pure virtual

Send an Alexa.StateReport event. Since these events require context, the event will be enqueued and this method will return immediately. The event will be sent once context has been received from ContextManager.

Parameters

instance	The instance ID of the responding capability.
correlationToken	The correlation token from the directive to which we are responding.
endpoint	The AVSMessageEndpoint to identify the endpoint related to this event.

Returns

true if the event was successfuly enqueued, false on failure.

Implemented in alexaClientSDK::capabilityAgents::alexa::AlexaInterfaceMessageSender.

---

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

• /workplace/avs-device-sdk/CapabilityAgents/Alexa/include/Alexa/AlexaInterfaceMessageSenderInternalInterface.h