AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::capabilityAgents::alexa::AlexaInterfaceMessageSenderInternalInterface Class Referenceabstract

#include <AlexaInterfaceMessageSenderInternalInterface.h>

Inheritance diagram for alexaClientSDK::capabilityAgents::alexa::AlexaInterfaceMessageSenderInternalInterface:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::capabilityAgents::alexa::AlexaInterfaceMessageSenderInternalInterface:
Collaboration graph
[legend]

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
}
 The type of error when calling sendErrorResponseEvent(). More...
 
- Static Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface
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
instanceThe instance ID of the responding capability.
correlationTokenThe correlation token from the directive to which we are responding.
endpointThe 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:

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