DeviceSettingStorageInterface.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_STORAGE_DEVICESETTINGSTORAGEINTERFACE_H_
#define ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_STORAGE_DEVICESETTINGSTORAGEINTERFACE_H_

#include <string>
#include <tuple>
#include <vector>

#include "Settings/SettingStatus.h"

namespace alexaClientSDK {
namespace settings {
namespace storage {

class DeviceSettingStorageInterface {
public:
    using SettingStatusAndValue = std::pair<SettingStatus, std::string>;

    virtual ~DeviceSettingStorageInterface() = default;

    virtual bool open() = 0;

    virtual void close() = 0;

    virtual bool storeSetting(const std::string& key, const std::string& value, SettingStatus status) = 0;

    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 deleteSetting(const std::string& key) = 0;

    virtual bool updateSettingStatus(const std::string& key, SettingStatus status) = 0;
};

}  // namespace storage
}  // namespace settings
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_STORAGE_DEVICESETTINGSTORAGEINTERFACE_H_