DeviceSettingsManager.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_DEVICESETTINGSMANAGER_H_
#define ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_DEVICESETTINGSMANAGER_H_

#include <cstdint>
#include <set>
#include <string>
#include <vector>

#include "Settings/SettingInterface.h"
#include "Settings/SettingsManager.h"
#include "Settings/SpeechConfirmationSettingType.h"
#include "Settings/WakeWordConfirmationSettingType.h"
#include "Settings/Types/AlarmVolumeRampTypes.h"
#include "Settings/Types/NetworkInfo.h"

namespace alexaClientSDK {
namespace settings {

using Locale = std::string;

using DeviceLocales = std::vector<Locale>;

using WakeWord = std::string;

using WakeWords = std::set<WakeWord>;

using DoNotDisturbSetting = SettingInterface<bool>;

using AlarmVolumeRampSetting = SettingInterface<types::AlarmVolumeRampTypes>;

using WakeWordConfirmationSetting = SettingInterface<WakeWordConfirmationSettingType>;

using SpeechConfirmationSetting = SettingInterface<SpeechConfirmationSettingType>;

using TimeZoneSetting = SettingInterface<std::string>;

using WakeWordsSetting = SettingInterface<WakeWords>;

using LocalesSetting = SettingInterface<DeviceLocales>;

using NetworkInfoSetting = SettingInterface<types::NetworkInfo>;

enum DeviceSettingsIndex {
    DO_NOT_DISTURB,
    ALARM_VOLUME_RAMP,
    WAKEWORD_CONFIRMATION,
    SPEECH_CONFIRMATION,
    TIMEZONE,
    WAKE_WORDS,
    LOCALE,
    NETWORK_INFO
};

using DeviceSettingsManager = SettingsManager<
    DoNotDisturbSetting,
    AlarmVolumeRampSetting,
    WakeWordConfirmationSetting,
    SpeechConfirmationSetting,
    TimeZoneSetting,
    WakeWordsSetting,
    LocalesSetting,
    NetworkInfoSetting>;

using DeviceSettingManagerSettingConfigurations = std::tuple<
    SettingConfiguration<DoNotDisturbSetting>,
    SettingConfiguration<AlarmVolumeRampSetting>,
    SettingConfiguration<WakeWordConfirmationSetting>,
    SettingConfiguration<SpeechConfirmationSetting>,
    SettingConfiguration<TimeZoneSetting>,
    SettingConfiguration<WakeWordsSetting>,
    SettingConfiguration<LocalesSetting>,
    SettingConfiguration<NetworkInfoSetting>>;

}  // namespace settings
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_DEVICESETTINGSMANAGER_H_