Namespaces
	storage

	test

	types

Classes
class	CloudControlledSettingProtocol

class	DeviceControlledSettingProtocol

class	Setting

class	SettingCallbackAdapter

class	SettingCallbackAdapterInterface

class	SettingCallbacks

struct	SettingConfiguration

class	SettingConnectionObserver

struct	SettingEventMetadata

class	SettingEventRequestObserver

class	SettingEventSender

class	SettingEventSenderInterface

class	SettingInterface

class	SettingObserverInterface

class	SettingProtocolInterface

class	SettingsManager

class	SettingsManagerBuilderBase

class	SettingsManagerBuilderBase< settings::SettingsManager< SettingsT... > >

class	SharedAVSSettingProtocol

Typedefs
using	Locale = std::string
	Alias for the locale type. More...

using	DeviceLocales = std::vector< Locale >
	Alias for locales enabled in the device. More...

using	WakeWord = std::string
	Alias for the wake word type. More...

using	WakeWords = std::set< WakeWord >
	Alias for a set of wake words type. More...

using	DoNotDisturbSetting = SettingInterface< bool >
	Type for do not disturb setting. More...

using	AlarmVolumeRampSetting = SettingInterface< types::AlarmVolumeRampTypes >
	Forward declaration for AlarmVolumeRamp setting. More...

using	WakeWordConfirmationSetting = SettingInterface< WakeWordConfirmationSettingType >
	Type for wake word confirmation setting. More...

using	SpeechConfirmationSetting = SettingInterface< SpeechConfirmationSettingType >
	Type for end of speech confirmation setting. More...

using	TimeZoneSetting = SettingInterface< std::string >
	Type for time zone setting. More...

using	WakeWordsSetting = SettingInterface< WakeWords >
	Type for wake words. More...

using	LocalesSetting = SettingInterface< DeviceLocales >
	Type for locale. More...

using	NetworkInfoSetting = SettingInterface< types::NetworkInfo >
	Type for network info. More...

using	DeviceSettingsManager = SettingsManager< DoNotDisturbSetting, AlarmVolumeRampSetting, WakeWordConfirmationSetting, SpeechConfirmationSetting, TimeZoneSetting, WakeWordsSetting, LocalesSetting, NetworkInfoSetting >
	The DeviceSettingsManager will manage all common settings to alexa devices. More...

using	DeviceSettingManagerSettingConfigurations = std::tuple< SettingConfiguration< DoNotDisturbSetting >, SettingConfiguration< AlarmVolumeRampSetting >, SettingConfiguration< WakeWordConfirmationSetting >, SettingConfiguration< SpeechConfirmationSetting >, SettingConfiguration< TimeZoneSetting >, SettingConfiguration< WakeWordsSetting >, SettingConfiguration< LocalesSetting >, SettingConfiguration< NetworkInfoSetting > >
	An alias to shorten the name. More...

template<typename ValueT >
using	IntegralByteType = typename std::enable_if< isIntegralByteType< ValueT >(), ValueT >::type

template<typename ValueT >
using	EnumOrString = typename std::enable_if< isEnumOrString< ValueT >(), ValueT >::type

template<typename ValueT >
using	StringCollection = typename std::enable_if< isStringCollection< ValueT >(), ValueT >::type

template<typename ValueT >
using	OtherTypes = typename std::enable_if< !isEnumOrString< ValueT >() &&!isIntegralByteType< ValueT >() &&!isStringCollection< ValueT >(), ValueT >::type

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

enum	SettingNotifications { SettingNotifications::LOCAL_CHANGE_IN_PROGRESS, SettingNotifications::AVS_CHANGE_IN_PROGRESS, SettingNotifications::LOCAL_CHANGE, SettingNotifications::AVS_CHANGE, SettingNotifications::LOCAL_CHANGE_FAILED, SettingNotifications::AVS_CHANGE_FAILED, SettingNotifications::LOCAL_CHANGE_CANCELLED, SettingNotifications::AVS_CHANGE_CANCELLED }

enum	SettingStatus { SettingStatus::NOT_AVAILABLE, SettingStatus::LOCAL_CHANGE_IN_PROGRESS, SettingStatus::AVS_CHANGE_IN_PROGRESS, SettingStatus::SYNCHRONIZED }

enum	SpeechConfirmationSettingType { SpeechConfirmationSettingType::NONE, SpeechConfirmationSettingType::TONE }

enum	WakeWordConfirmationSettingType { WakeWordConfirmationSettingType::NONE, WakeWordConfirmationSettingType::TONE }

Functions
std::ostream &	operator<< (std::ostream &stream, const SettingNotifications &value)

std::string	settingStatusToString (SettingStatus status)

SettingStatus	stringToSettingStatus (const std::string &statusString)

template<typename ValueT >
static constexpr bool	isIntegralByteType ()

template<typename ValueT , typename = IntegralByteType<ValueT>>
std::pair< bool, std::string >	toSettingString (const IntegralByteType< ValueT > &value)

template<typename ValueT , typename = IntegralByteType<ValueT>>
std::pair< bool, ValueT >	fromSettingString (const std::string &str, const IntegralByteType< ValueT > &defaultValue)

template<typename ValueT >
static constexpr bool	isEnumOrString ()

template<typename ValueT , typename = EnumOrString<ValueT>>
std::pair< bool, std::string >	toSettingString (const ValueT &value)

template<typename ValueT , typename = EnumOrString<ValueT>>
std::pair< bool, ValueT >	fromSettingString (const std::string &str, const ValueT &defaultValue)

template<typename ValueT >
static constexpr bool	isStringCollection ()

template<typename ValueT , StringCollection< ValueT > * = nullptr>
std::pair< bool, std::string >	toSettingString (const StringCollection< ValueT > &value)

template<typename ValueT , StringCollection< ValueT > * = nullptr>
std::pair< bool, ValueT >	fromSettingString (const std::string &str, const StringCollection< ValueT > &defaultValue)

template<typename ValueT >
std::pair< bool, std::string >	toSettingString (const OtherTypes< ValueT > &value)

template<typename ValueT >
std::pair< bool, ValueT >	fromSettingString (const std::string &str, const OtherTypes< ValueT > &defaultValue)

SpeechConfirmationSettingType	getSpeechConfirmationDefault ()

std::ostream &	operator<< (std::ostream &stream, const SpeechConfirmationSettingType &value)

std::istream &	operator>> (std::istream &is, SpeechConfirmationSettingType &value)

WakeWordConfirmationSettingType	getWakeWordConfirmationDefault ()

std::ostream &	operator<< (std::ostream &stream, const WakeWordConfirmationSettingType &value)

std::istream &	operator>> (std::istream &is, WakeWordConfirmationSettingType &value)

Variables
	m_applyFunction {applyValueFn}

	m_protocol {std::move(settingProtocol)}

constexpr char	QUOTE = '"'
	Quote used for json string values. More...

static const std::string	EMPTY_JSON_LIST = "[]"

Typedef Documentation

◆ AlarmVolumeRampSetting

using alexaClientSDK::settings::AlarmVolumeRampSetting = typedef SettingInterface<types::AlarmVolumeRampTypes>

Forward declaration for AlarmVolumeRamp setting.

◆ DeviceLocales

using alexaClientSDK::settings::DeviceLocales = typedef std::vector<Locale>

Alias for locales enabled in the device.

◆ DeviceSettingManagerSettingConfigurations

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

An alias to shorten the name.

◆ DeviceSettingsManager

using alexaClientSDK::settings::DeviceSettingsManager = typedef SettingsManager< DoNotDisturbSetting, AlarmVolumeRampSetting, WakeWordConfirmationSetting, SpeechConfirmationSetting, TimeZoneSetting, WakeWordsSetting, LocalesSetting, NetworkInfoSetting>

The DeviceSettingsManager will manage all common settings to alexa devices.

◆ DoNotDisturbSetting

using alexaClientSDK::settings::DoNotDisturbSetting = typedef SettingInterface<bool>

Type for do not disturb setting.

◆ EnumOrString

template<typename ValueT >

using alexaClientSDK::settings::EnumOrString = typedef typename std::enable_if<isEnumOrString<ValueT>(), ValueT>::type

Define a valid type for enums and string types.

Template Parameters

ValueT The value type. This will only be a valid type for enums and string.

◆ IntegralByteType

template<typename ValueT >

using alexaClientSDK::settings::IntegralByteType = typedef typename std::enable_if<isIntegralByteType<ValueT>(), ValueT>::type

Define a valid type for int8_t and uint8_t.

Template Parameters

ValueT The value type. This will only be a valid type for int8_t or uint8_t.

◆ Locale

using alexaClientSDK::settings::Locale = typedef std::string

Alias for the locale type.

◆ LocalesSetting

using alexaClientSDK::settings::LocalesSetting = typedef SettingInterface<DeviceLocales>

Type for locale.

◆ NetworkInfoSetting

using alexaClientSDK::settings::NetworkInfoSetting = typedef SettingInterface<types::NetworkInfo>

Type for network info.

◆ OtherTypes

template<typename ValueT >

using alexaClientSDK::settings::OtherTypes = typedef typename std::enable_if< !isEnumOrString<ValueT>() && !isIntegralByteType<ValueT>() && !isStringCollection<ValueT>(), ValueT>::type

Define a valid type for arithmetic types (except (u)int8_t), and classes.

Template Parameters

ValueT The value type. This will only be a valid type for arithmetic types (except (u)int8_t), and classes.

◆ SpeechConfirmationSetting

using alexaClientSDK::settings::SpeechConfirmationSetting = typedef SettingInterface<SpeechConfirmationSettingType>

Type for end of speech confirmation setting.

◆ StringCollection

template<typename ValueT >

using alexaClientSDK::settings::StringCollection = typedef typename std::enable_if<isStringCollection<ValueT>(), ValueT>::type

Define a valid type for string collection.

Template Parameters

ValueT The value type. This will only be a valid type for string collection.

◆ TimeZoneSetting

using alexaClientSDK::settings::TimeZoneSetting = typedef SettingInterface<std::string>

Type for time zone setting.

◆ WakeWord

using alexaClientSDK::settings::WakeWord = typedef std::string

Alias for the wake word type.

◆ WakeWordConfirmationSetting

using alexaClientSDK::settings::WakeWordConfirmationSetting = typedef SettingInterface<WakeWordConfirmationSettingType>

Type for wake word confirmation setting.

◆ WakeWords

using alexaClientSDK::settings::WakeWords = typedef std::set<WakeWord>

Alias for a set of wake words type.

◆ WakeWordsSetting

using alexaClientSDK::settings::WakeWordsSetting = typedef SettingInterface<WakeWords>

Type for wake words.

Enumeration Type Documentation

◆ DeviceSettingsIndex

enum alexaClientSDK::settings::DeviceSettingsIndex

Enumerates the settings that are kept inside DeviceSettingsManager.

Note: This enumeration must reflect the order that the settings show up in the DeviceSettingsManager declaration.

Enumerator
DO_NOT_DISTURB
ALARM_VOLUME_RAMP
WAKEWORD_CONFIRMATION
SPEECH_CONFIRMATION
TIMEZONE
WAKE_WORDS
LOCALE
NETWORK_INFO

◆ SettingNotifications

enum alexaClientSDK::settings::SettingNotifications

strong

Enumerate the type of notifications.

Enumerator
LOCAL_CHANGE_IN_PROGRESS	The setting that was changed locally is being applied.
AVS_CHANGE_IN_PROGRESS	The setting that was changed via cloud is being applied.
LOCAL_CHANGE	Setting value changed due to a local change.
AVS_CHANGE	Setting value changed due to a change requested via cloud.
LOCAL_CHANGE_FAILED	Local request failed.
AVS_CHANGE_FAILED	AVS request failed.
LOCAL_CHANGE_CANCELLED	Local request cancelled due to a new request.
AVS_CHANGE_CANCELLED	AVS request cancelled due to a new request.

◆ SettingStatus

enum alexaClientSDK::settings::SettingStatus

strong

Specifies the state of a setting.

Enumerator
NOT_AVAILABLE	The setting has either not been set and not been persisted in a storage or the setting is in an unknown status.
LOCAL_CHANGE_IN_PROGRESS	The setting has been set locally but not synchronized with AVS.
AVS_CHANGE_IN_PROGRESS	AVS request is in progress.
SYNCHRONIZED	The setting has been set locally and synchronized with AVS.

◆ SpeechConfirmationSettingType

enum alexaClientSDK::settings::SpeechConfirmationSettingType

strong

Defines the values for speech confirmation setting.

Enumerator
NONE	No speech confirmation.
TONE	A tone will be played for speech confirmation.

◆ WakeWordConfirmationSettingType

enum alexaClientSDK::settings::WakeWordConfirmationSettingType

strong

Defines the values for wake word confirmation setting.

Enumerator
NONE	No wake word confirmation.
TONE	A tone will be played for wake word confirmation.

Function Documentation

◆ fromSettingString() [1/4]

template<typename ValueT , typename = IntegralByteType<ValueT>>

std::pair<bool, ValueT> alexaClientSDK::settings::fromSettingString	(	const std::string &	str,
		const IntegralByteType< ValueT > &	defaultValue
	)

Convert a string (json format) to (int8_t or uint8_t) setting representation.

Template Parameters

ValueT The value type (either int8_t or uint8_t).

Parameters

str	The json string that represents the object.
defaultValue	In case the string conversion fails, we'll return this default value.

Returns: A pair where first represents whether the conversion succeeded or not, and the second is the converted value.

◆ fromSettingString() [2/4]

template<typename ValueT , typename = EnumOrString<ValueT>>

std::pair<bool, ValueT> alexaClientSDK::settings::fromSettingString	(	const std::string &	str,
		const ValueT &	defaultValue
	)

Convert a string (json format) to setting representation for strings and enums.

Template Parameters

ValueT The value type.

Parameters

str	The json string that represents the object.
defaultValue	In case the string conversion fails, we'll return this default value.

Returns: A pair where first represents whether the conversion succeeded or not, and the second is the converted value.

Note: For enums, we assume the operator>> is defined and the failbit should be set in case of failure to convert from string.

◆ fromSettingString() [3/4]

template<typename ValueT , StringCollection< ValueT > * = nullptr>

std::pair<bool, ValueT> alexaClientSDK::settings::fromSettingString	(	const std::string &	str,
		const StringCollection< ValueT > &	defaultValue
	)

Convert a string (json format) to the setting representation for a string collection.

Template Parameters

ValueT The value type.

Parameters

str	The json string that represents the object.
defaultValue	In case the string conversion fails, we'll return this default value.

Returns: A pair where first represents whether the conversion succeeded or not, and the second is the converted value.

◆ fromSettingString() [4/4]

template<typename ValueT >

std::pair<bool, ValueT> alexaClientSDK::settings::fromSettingString	(	const std::string &	str,
		const OtherTypes< ValueT > &	defaultValue
	)

Convert a string (json format) to setting representation for arithmetic types (except (u)int8_t), and classes.

Template Parameters

ValueT The value type.

Parameters

str	The json string that represents the object.
defaultValue	In case the string conversion fails, we'll return this default value.

Returns: A pair where first represents whether the conversion succeeded or not, and the second is the converted value.

Note: For classes and structs, we assume the operator>> is defined and the failbit should be set in case of failure to convert from string.

◆ getSpeechConfirmationDefault()

SpeechConfirmationSettingType alexaClientSDK::settings::getSpeechConfirmationDefault ( )

inline

Retrieves the default value of speech confirmation

Returns: The default value speech confirmations setting.

◆ getWakeWordConfirmationDefault()

WakeWordConfirmationSettingType alexaClientSDK::settings::getWakeWordConfirmationDefault ( )

inline

Retrieves the default value of wake word confirmation

Returns: The default value wake word confirmations setting.

◆ isEnumOrString()

template<typename ValueT >

static constexpr bool alexaClientSDK::settings::isEnumOrString ( )

static

Test whether the type is either an enum type or string.

Template Parameters

ValueT The value type to be tested.

Returns: true if the given type is string or enum; false otherwise.

◆ isIntegralByteType()

template<typename ValueT >

static constexpr bool alexaClientSDK::settings::isIntegralByteType ( )

static

Test whether the type is int8_t or uint8_t.

Template Parameters

ValueT The value type to be tested.

Returns: true if the given type is (u)int8_t; false otherwise.

◆ isStringCollection()

template<typename ValueT >

static constexpr bool alexaClientSDK::settings::isStringCollection ( )

static

Test whether the type is a string collection.

Template Parameters

ValueT The value type to be tested.

Returns: true if the given type is a string set; false otherwise.

◆ operator<<() [1/3]

std::ostream& alexaClientSDK::settings::operator<<	(	std::ostream &	stream,
		const SpeechConfirmationSettingType &	value
	)

inline

Write a SpeechConfirmationSettingType value to the given stream.

Parameters

stream	The stream to write the value to.
value	The value to write to the stream as a string.

Returns: The stream that was passed in and written to.

◆ operator<<() [2/3]

std::ostream& alexaClientSDK::settings::operator<<	(	std::ostream &	stream,
		const WakeWordConfirmationSettingType &	value
	)

inline

Write a WakeWordConfirmationSettingType value to the given stream.

Parameters

stream	The stream to write the value to.
value	The value to write to the stream as a string.

Returns: The stream that was passed in and written to.

◆ operator<<() [3/3]

std::ostream& alexaClientSDK::settings::operator<<	(	std::ostream &	stream,
		const SettingNotifications &	value
	)

inline

Write a SettingNotifications value to the given stream.

Parameters

stream	The stream to write the value to.
value	The value to write to the stream as a string.

Returns: The stream that was passed in and written to.

◆ operator>>() [1/2]

std::istream& alexaClientSDK::settings::operator>>	(	std::istream &	is,
		SpeechConfirmationSettingType &	value
	)

inline

Converts an input string stream value to SpeechConfirmationSettingType.

Parameters

	stream	The string stream to retrieve the value from.
[out]	value	The value to write to.

Returns: The stream that was passed in.

◆ operator>>() [2/2]

std::istream& alexaClientSDK::settings::operator>>	(	std::istream &	is,
		WakeWordConfirmationSettingType &	value
	)

inline

Converts an input string stream value to WakeWordConfirmationSettingType.

Parameters

	stream	The string stream to retrieve the value from.
[out]	value	The value to write to.

Returns: The stream that was passed in.

◆ settingStatusToString()

std::string alexaClientSDK::settings::settingStatusToString ( SettingStatus status )

inline

This function converts the provided SettingStatus to a string.

Parameters

status The SettingStatus to convert to a string.

Returns: The string conversion of the SettingStatus.

◆ stringToSettingStatus()

SettingStatus alexaClientSDK::settings::stringToSettingStatus ( const std::string & statusString )

inline

This function parses a string and converts it to its corresponding SettingStatus.

Parameters

statusString The string to be converted to SettingStatus.

Returns: The SettingStatus corresponding to the string provided.

◆ toSettingString() [1/4]

template<typename ValueT , typename = IntegralByteType<ValueT>>

std::pair<bool, std::string> alexaClientSDK::settings::toSettingString ( const IntegralByteType< ValueT > & value )

Convert a setting that is either a int8_t or uint8_t to a string (json format) representation.

Template Parameters

ValueT The value type (either int8_t or uint8_t).

Parameters

value The value to be converted.

Returns: A pair where first represents whether the conversion succeeded or not, and the second is the converted string.

◆ toSettingString() [2/4]

template<typename ValueT , typename = EnumOrString<ValueT>>

std::pair<bool, std::string> alexaClientSDK::settings::toSettingString ( const ValueT & value )

Convert a setting that is either a enum or string to a json format string representation.

Template Parameters

ValueT The value type.

Parameters

value The value to be converted.

Returns: A pair where first represents whether the conversion succeeded or not, and the second is the converted string.

Note: For enums, we assume the operator<< is defined and the failbit should be set in case of failure to convert to string.

◆ toSettingString() [3/4]

template<typename ValueT , StringCollection< ValueT > * = nullptr>

std::pair<bool, std::string> alexaClientSDK::settings::toSettingString ( const StringCollection< ValueT > & value )

Convert a setting that is a string collection to a json format string representation.

Template Parameters

ValueT The value type.

Parameters

value The value to be converted.

Returns: A pair where first represents whether the conversion succeeded or not, and the second is the converted string.

◆ toSettingString() [4/4]

template<typename ValueT >

std::pair<bool, std::string> alexaClientSDK::settings::toSettingString ( const OtherTypes< ValueT > & value )

Convert a setting that is either arithmetic types (except (u)int8_t), and classes to a json format representation.

Template Parameters

ValueT The value type.

Parameters

value The value to be converted.

Returns: A pair where first represents whether the conversion succeeded or not, and the second is the converted string.

Note: For classes, we assume the operator<< is defined and the failbit should be set in case of failure to convert to string.

Variable Documentation

◆ EMPTY_JSON_LIST

const std::string alexaClientSDK::settings::EMPTY_JSON_LIST = "[]"

static

◆ m_applyFunction

alexaClientSDK::settings::m_applyFunction {applyValueFn}

◆ m_protocol

alexaClientSDK::settings::m_protocol {std::move(settingProtocol)}

◆ QUOTE

constexpr char alexaClientSDK::settings::QUOTE = '"'

Quote used for json string values.

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ AlarmVolumeRampSetting

◆ DeviceLocales

◆ DeviceSettingManagerSettingConfigurations

◆ DeviceSettingsManager

◆ DoNotDisturbSetting

◆ EnumOrString

◆ IntegralByteType

◆ Locale

◆ LocalesSetting

◆ NetworkInfoSetting

◆ OtherTypes

◆ SpeechConfirmationSetting

◆ StringCollection

◆ TimeZoneSetting

◆ WakeWord

◆ WakeWordConfirmationSetting

◆ WakeWords

◆ WakeWordsSetting

Enumeration Type Documentation

◆ DeviceSettingsIndex

◆ SettingNotifications

◆ SettingStatus

◆ SpeechConfirmationSettingType

◆ WakeWordConfirmationSettingType

Function Documentation

◆ fromSettingString() [1/4]

◆ fromSettingString() [2/4]

◆ fromSettingString() [3/4]

◆ fromSettingString() [4/4]

◆ getSpeechConfirmationDefault()

◆ getWakeWordConfirmationDefault()

◆ isEnumOrString()

◆ isIntegralByteType()

◆ isStringCollection()

◆ operator<<() [1/3]

◆ operator<<() [2/3]

◆ operator<<() [3/3]

◆ operator>>() [1/2]

◆ operator>>() [2/2]

◆ settingStatusToString()

◆ stringToSettingStatus()

◆ toSettingString() [1/4]

◆ toSettingString() [2/4]

◆ toSettingString() [3/4]

◆ toSettingString() [4/4]

Variable Documentation

◆ EMPTY_JSON_LIST

◆ m_applyFunction

◆ m_protocol

◆ QUOTE