DeviceSettingsManagerBuilder.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 ACSDKDEVICESETTINGSMANAGER_DEVICESETTINGSMANAGERBUILDER_H_
#define ACSDKDEVICESETTINGSMANAGER_DEVICESETTINGSMANAGERBUILDER_H_

#include <cstdint>
#include <functional>
#include <memory>
#include <tuple>

#include <AVSCommon/SDKInterfaces/AVSConnectionManagerInterface.h>
#include <AVSCommon/SDKInterfaces/LocaleAssetsManagerInterface.h>
#include <AVSCommon/SDKInterfaces/MessageSenderInterface.h>
#include <AVSCommon/SDKInterfaces/SystemTimeZoneInterface.h>
#include <AVSCommon/Utils/Metrics/MetricRecorderInterface.h>
#include <acsdkDoNotDisturb/DoNotDisturbCapabilityAgent.h>
#include <RegistrationManager/CustomerDataManagerInterface.h>
#include <Settings/CloudControlledSettingProtocol.h>
#include <Settings/DeviceControlledSettingProtocol.h>
#include <Settings/DeviceSettingsManager.h>
#include <Settings/Setting.h>
#include <Settings/SettingEventMetadata.h>
#include <Settings/SettingEventSender.h>
#include <Settings/SettingsManagerBuilderBase.h>
#include <Settings/SharedAVSSettingProtocol.h>
#include <Settings/Storage/DeviceSettingStorageInterface.h>

namespace alexaClientSDK {
namespace acsdkDeviceSettingsManager {

class DeviceSettingsManagerBuilder : public settings::SettingsManagerBuilderBase<settings::DeviceSettingsManager> {
public:
    static std::shared_ptr<settings::DeviceSettingsManager> createDeviceSettingsManager(
        std::shared_ptr<settings::storage::DeviceSettingStorageInterface> settingStorage,
        std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> messageSender,
        std::shared_ptr<avsCommon::sdkInterfaces::AVSConnectionManagerInterface> connectionManager,
        std::shared_ptr<registrationManager::CustomerDataManagerInterface> dataManager,
        std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface> localeAssetsManager,
        std::shared_ptr<capabilityAgents::doNotDisturb::DoNotDisturbCapabilityAgent> doNotDisturbCapabilityAgent,
        const std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface>& metricRecorder,
        std::shared_ptr<avsCommon::sdkInterfaces::SystemTimeZoneInterface> systemTimezone = nullptr);

    DeviceSettingsManagerBuilder(
        std::shared_ptr<settings::storage::DeviceSettingStorageInterface> settingStorage,
        std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> messageSender,
        std::shared_ptr<avsCommon::sdkInterfaces::AVSConnectionManagerInterface> connectionManager,
        std::shared_ptr<registrationManager::CustomerDataManagerInterface> dataManager,
        const std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface>& metricRecorder);

    DeviceSettingsManagerBuilder& withDoNotDisturbSetting(
        const std::shared_ptr<capabilityAgents::doNotDisturb::DoNotDisturbCapabilityAgent>& dndCA);

    DeviceSettingsManagerBuilder& withAlarmVolumeRampSetting();

    DeviceSettingsManagerBuilder& withWakeWordConfirmationSetting();

    DeviceSettingsManagerBuilder& withSpeechConfirmationSetting();

    DeviceSettingsManagerBuilder& withTimeZoneSetting(
        std::shared_ptr<avsCommon::sdkInterfaces::SystemTimeZoneInterface> systemTimeZone = nullptr);

    DeviceSettingsManagerBuilder& withLocaleSetting(
        std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface> localeAssetsManager);

    DeviceSettingsManagerBuilder& withLocaleAndWakeWordsSettings(
        std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface> localeAssetsManager);

    DeviceSettingsManagerBuilder& withNetworkInfoSetting();

    template <size_t index>
    std::shared_ptr<SettingType<index>> getSetting() const;

    template <size_t index>
    settings::SettingConfiguration<SettingType<index>> getConfiguration() const;

    std::unique_ptr<settings::DeviceSettingsManager> build() override;

private:
    template <size_t index, class ProtocolT>
    DeviceSettingsManagerBuilder& withSynchronizedSetting(
        const settings::SettingEventMetadata& metadata,
        const ValueType<index>& defaultValue,
        std::function<bool(const ValueType<index>&)> applyFn = std::function<bool(const ValueType<index>&)>());

    std::shared_ptr<settings::storage::DeviceSettingStorageInterface> m_settingStorage;

    std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> m_messageSender;

    std::shared_ptr<avsCommon::sdkInterfaces::AVSConnectionManagerInterface> m_connectionManager;

    std::shared_ptr<registrationManager::CustomerDataManagerInterface> m_dataManager;

    std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> m_metricRecorder;

    bool m_foundError;
};

template <size_t index>
settings::SettingConfiguration<DeviceSettingsManagerBuilder::SettingType<index>> DeviceSettingsManagerBuilder::
    getConfiguration() const {
    return std::get<index>(m_settingConfigs);
}

template <size_t index>
std::shared_ptr<DeviceSettingsManagerBuilder::SettingType<index>> DeviceSettingsManagerBuilder::getSetting() const {
    return std::get<index>(m_settingConfigs).setting;
}

}  // namespace acsdkDeviceSettingsManager
}  // namespace alexaClientSDK

#endif  // ACSDKDEVICESETTINGSMANAGER_DEVICESETTINGSMANAGERBUILDER_H_