AlexaClientSDK  1.20.1
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::MessageSenderInterface Class Referenceabstract

This specifies an interface to send a message. More...

#include <MessageSenderInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::MessageSenderInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~MessageSenderInterface ()=default
 Destructor. More...
 
virtual void sendMessage (std::shared_ptr< avs::MessageRequest > request)=0
 

Detailed Description

This specifies an interface to send a message.

Constructor & Destructor Documentation

◆ ~MessageSenderInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::MessageSenderInterface::~MessageSenderInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ sendMessage()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::MessageSenderInterface::sendMessage ( std::shared_ptr< avs::MessageRequest request)
pure virtual

Send a message. This function must operate asynchronously, internally storing the message to be sent when the connection is able to process it. The onSendCompleted callback method of the MessageRequest object is invoked as follows:

  • If the MessageSenderInterface object is not connected, the callback value is NOT_CONNECTED.
  • Otherwise, the object attempts to send the message, and once this has either succeeded or failed, the callback value is set appropriately.
Parameters
requestThe MessageRequest to send.

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

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