AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Public Attributes | List of all members
alexaClientSDK::settings::SettingObserverInterface< SettingT > Class Template Referenceabstract

#include <SettingObserverInterface.h>

Inheritance diagram for alexaClientSDK::settings::SettingObserverInterface< SettingT >:
Inheritance graph
[legend]

Public Member Functions

virtual ~SettingObserverInterface ()=default
 
virtual void onSettingNotification (const typename SettingT::ValueType &value, SettingNotifications notification)=0
 

Public Attributes

friend SettingT
 Only objects from SettingT can call the value change notification. More...
 

Detailed Description

template<typename SettingT>
class alexaClientSDK::settings::SettingObserverInterface< SettingT >

Base definition of SettingObserver.

Template Parameters
SettingTThe setting type to be observed.

Constructor & Destructor Documentation

◆ ~SettingObserverInterface()

template<typename SettingT>
virtual alexaClientSDK::settings::SettingObserverInterface< SettingT >::~SettingObserverInterface ( )
virtualdefault

The virtual destructor.

Member Function Documentation

◆ onSettingNotification()

template<typename SettingT>
virtual void alexaClientSDK::settings::SettingObserverInterface< SettingT >::onSettingNotification ( const typename SettingT::ValueType &  value,
SettingNotifications  notification 
)
pure virtual

Function called when the observed setting is called.

Parameters
valueThe current value of the setting. For LOCAL_CHANGE and AVS_CHANGE, the value should be the same as the one requested.
notificationThe notification type.

Member Data Documentation

◆ SettingT

template<typename SettingT>
friend alexaClientSDK::settings::SettingObserverInterface< SettingT >::SettingT

Only objects from SettingT can call the value change notification.


The documentation for this class was generated from the following file:

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