AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
SettingEventSenderInterface.h
Go to the documentation of this file.
1 /*
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  * http://aws.amazon.com/apache2.0/
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15 
16 #ifndef ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_SETTINGEVENTSENDERINTERFACE_H_
17 #define ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_SETTINGEVENTSENDERINTERFACE_H_
18 
19 #include <future>
20 #include <string>
21 
22 namespace alexaClientSDK {
23 namespace settings {
24 
25 /*
26  * A utility class used to send events to AVS in the goal of synchronizing the value of an associated @c
27  * SettingInterface value.
28  */
30 public:
34  virtual ~SettingEventSenderInterface() = default;
35 
59  virtual std::shared_future<bool> sendChangedEvent(const std::string& value) = 0;
60 
85  virtual std::shared_future<bool> sendReportEvent(const std::string& value) = 0;
86 
109  virtual std::shared_future<bool> sendStateReportEvent(const std::string& payload) = 0;
110 
114  virtual void cancel() = 0;
115 };
116 
117 } // namespace settings
118 } // namespace alexaClientSDK
119 
120 #endif // ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_SETTINGEVENTSENDERINTERFACE_H_
::std::string string
Definition: gtest-port.h:1097
virtual std::shared_future< bool > sendChangedEvent(const std::string &value)=0
virtual std::shared_future< bool > sendReportEvent(const std::string &value)=0
Definition: SettingEventSenderInterface.h:29
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
virtual std::shared_future< bool > sendStateReportEvent(const std::string &payload)=0

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