AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Typedefs | Functions | Variables
alexaClientSDK::acsdkDeviceSettingsManager Namespace Reference

Classes

class  DeviceSettingsManagerBuilder
 

Typedefs

using DeviceSettingsManagerComponent = acsdkManufactory::Component< std::shared_ptr< settings::DeviceSettingsManager >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::AVSConnectionManagerInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::LocaleAssetsManagerInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::SystemTimeZoneInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > >, acsdkManufactory::Import< std::shared_ptr< capabilityAgents::doNotDisturb::DoNotDisturbCapabilityAgent > >, acsdkManufactory::Import< std::shared_ptr< registrationManager::CustomerDataManagerInterface > >, acsdkManufactory::Import< std::shared_ptr< settings::storage::DeviceSettingStorageInterface > >>
 

Functions

DeviceSettingsManagerComponent getComponent ()
 
template<typename PointerT >
static bool checkPointer (const std::shared_ptr< PointerT > &pointer, const std::string &variableName)
 
template<size_t index>
bool addSetting (const DeviceSettingsManagerBuilder &builder, DeviceSettingsManager &manager)
 
template<>
bool addSetting< 0 > (const DeviceSettingsManagerBuilder &builder, DeviceSettingsManager &manager)
 

Variables

static const std::string DEFAULT_TIMEZONE = "Etc/GMT"
 The default timezone setting. More...
 
static const std::string SETTINGS_CONFIGURATION_ROOT_KEY = "deviceSettings"
 The key in our config file to find the root of settings for this database. More...
 
static const std::string DEFAULT_TIMEZONE_CONFIGURATION_KEY = "defaultTimezone"
 The key to find the default timezone configuration. More...
 
static const SettingEventMetadata NETWORK_INFO_METADATA
 Network info setting events metadata. More...
 

Typedef Documentation

◆ DeviceSettingsManagerComponent

Definition of a Manufactory Component for the default DeviceSettingsManagerBuilder.

Function Documentation

◆ addSetting()

template<size_t index>
bool alexaClientSDK::acsdkDeviceSettingsManager::addSetting ( const DeviceSettingsManagerBuilder builder,
DeviceSettingsManager manager 
)

◆ addSetting< 0 >()

◆ checkPointer()

template<typename PointerT >
static bool alexaClientSDK::acsdkDeviceSettingsManager::checkPointer ( const std::shared_ptr< PointerT > &  pointer,
const std::string &  variableName 
)
inlinestatic

◆ getComponent()

DeviceSettingsManagerComponent alexaClientSDK::acsdkDeviceSettingsManager::getComponent ( )

Creates an manufactory component that exports DeviceSettingsManager.

Returns
A component.

Variable Documentation

◆ DEFAULT_TIMEZONE

const std::string alexaClientSDK::acsdkDeviceSettingsManager::DEFAULT_TIMEZONE = "Etc/GMT"
static

The default timezone setting.

◆ DEFAULT_TIMEZONE_CONFIGURATION_KEY

const std::string alexaClientSDK::acsdkDeviceSettingsManager::DEFAULT_TIMEZONE_CONFIGURATION_KEY = "defaultTimezone"
static

The key to find the default timezone configuration.

◆ NETWORK_INFO_METADATA

const SettingEventMetadata alexaClientSDK::acsdkDeviceSettingsManager::NETWORK_INFO_METADATA
static
Initial value:
= {"System",
"NetworkInfoChanged",
"NetworkInfoReport",
"networkInfo"}

Network info setting events metadata.

◆ SETTINGS_CONFIGURATION_ROOT_KEY

const std::string alexaClientSDK::acsdkDeviceSettingsManager::SETTINGS_CONFIGURATION_ROOT_KEY = "deviceSettings"
static

The key in our config file to find the root of settings for this database.

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