AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::settings::SettingEventRequestObserver Class Reference

#include <SettingEventRequestObserver.h>

Inheritance diagram for alexaClientSDK::settings::SettingEventRequestObserver:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::settings::SettingEventRequestObserver:
Collaboration graph
[legend]

Public Member Functions

 ~SettingEventRequestObserver ()=default
 
std::shared_future< avsCommon::sdkInterfaces::MessageRequestObserverInterface::StatusgetResponseFuture ()
 
MessageRequestObserverInterface Functions
void onSendCompleted (avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status status) override
 
void onExceptionReceived (const std::string &exceptionMessage) override
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::MessageRequestObserverInterface
virtual ~MessageRequestObserverInterface ()=default
 
virtual void onResponseStatusReceived (MessageRequestObserverInterface::Status status)
 

Additional Inherited Members

- Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::MessageRequestObserverInterface
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
}
 

Detailed Description

An implementation of MessageRequestObserverInterface for each setting event request to AVS.

Constructor & Destructor Documentation

◆ ~SettingEventRequestObserver()

alexaClientSDK::settings::SettingEventRequestObserver::~SettingEventRequestObserver ( )
default

Destructor.

Member Function Documentation

◆ getResponseFuture()

std::shared_future< avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status > alexaClientSDK::settings::SettingEventRequestObserver::getResponseFuture ( )

Retrieves the future that will be set with a MessageRequestObserverInterface::Status after a response is received or an error is encountered while sending event for a setting to AVS.

Returns
The future for the status of the event message request.

◆ onExceptionReceived()

void alexaClientSDK::settings::SettingEventRequestObserver::onExceptionReceived ( const std::string &  exceptionMessage)
overridevirtual

◆ onSendCompleted()

void alexaClientSDK::settings::SettingEventRequestObserver::onSendCompleted ( avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status  status)
overridevirtual

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

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