AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
DeviceSettingStorageInterface.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_STORAGE_DEVICESETTINGSTORAGEINTERFACE_H_
17 #define ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_STORAGE_DEVICESETTINGSTORAGEINTERFACE_H_
18 
19 #include <string>
20 #include <tuple>
21 #include <vector>
22 
23 #include "Settings/SettingStatus.h"
24 
25 namespace alexaClientSDK {
26 namespace settings {
27 namespace storage {
28 
37 public:
43  using SettingStatusAndValue = std::pair<SettingStatus, std::string>;
44 
48  virtual ~DeviceSettingStorageInterface() = default;
49 
56  virtual bool open() = 0;
57 
61  virtual void close() = 0;
62 
71  virtual bool storeSetting(const std::string& key, const std::string& value, SettingStatus status) = 0;
72 
79  virtual bool storeSettings(const std::vector<std::tuple<std::string, std::string, SettingStatus>>& data) = 0;
80 
88  virtual SettingStatusAndValue loadSetting(const std::string& key) = 0;
89 
96  virtual bool deleteSetting(const std::string& key) = 0;
97 
105  virtual bool updateSettingStatus(const std::string& key, SettingStatus status) = 0;
106 };
107 
108 } // namespace storage
109 } // namespace settings
110 } // namespace alexaClientSDK
111 
112 #endif // ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_STORAGE_DEVICESETTINGSTORAGEINTERFACE_H_
virtual bool storeSettings(const std::vector< std::tuple< std::string, std::string, SettingStatus >> &data)=0
virtual SettingStatusAndValue loadSetting(const std::string &key)=0
virtual bool storeSetting(const std::string &key, const std::string &value, SettingStatus status)=0
Definition: DeviceSettingStorageInterface.h:36
std::pair< SettingStatus, std::string > SettingStatusAndValue
Definition: DeviceSettingStorageInterface.h:43
SettingStatus
Definition: SettingStatus.h:25
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
virtual bool updateSettingStatus(const std::string &key, SettingStatus status)=0
static const std::string key
The database key to be used by the protocol given the METADATA object.
Definition: SharedAVSSettingProtocolTest.cpp:58

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