alexaClientSDK::settings::SettingCallbackAdapter< ManagerT, id > Class Template Reference

#include <SettingCallbackAdapter.h>

Inheritance diagram for alexaClientSDK::settings::SettingCallbackAdapter< ManagerT, id >:

Collaboration diagram for alexaClientSDK::settings::SettingCallbackAdapter< ManagerT, id >:

Public Types
using	ValueType = typename ManagerT::template ValueType< id >
	Setting value type. More...
using	FunctionType = std::function< void(const ValueType &, SettingNotifications)>
	Callback function value type. More...

Public Member Functions
virtual	~SettingCallbackAdapter ()=default
Functions from @c SettingCallbackAdapterInterface
bool	addToManager (ManagerT &manager) override
void	removeFromManager (ManagerT &manager) override
Public Member Functions inherited from alexaClientSDK::settings::SettingCallbackAdapterInterface< ManagerT >
virtual	~SettingCallbackAdapterInterface ()=default

Static Public Member Functions
static std::shared_ptr< SettingCallbackAdapter >	create (FunctionType callback)

Detailed Description

template<typename ManagerT, size_t id>
class alexaClientSDK::settings::SettingCallbackAdapter< ManagerT, id >

A SettingCallbackAdapter can be used to register callback functions called when there is a setting notification.

This is an example of how to use this adapter.

MyClass(std::shared_ptr<DeviceSettingsManager> manager) : m_manager {manager} {
   m_adapter = SettingCallbackAdapter<DeviceSettingsManager, id>::create([](bool, SettingNotifications) {
       // do something.
   });
   m_adapter->addToManager(*m_manager);
}

~MyClass() {
   m_adapter->removeFromManager(*m_manager);
}

Template Parameters

ManagerT	The setting manager type that this callback will be added to.
id	The id of the setting inside the manager.

Member Typedef Documentation

FunctionType

template<typename ManagerT , size_t id>

using alexaClientSDK::settings::SettingCallbackAdapter< ManagerT, id >::FunctionType = std::function<void(const ValueType&, SettingNotifications)>

Callback function value type.

ValueType

template<typename ManagerT , size_t id>

using alexaClientSDK::settings::SettingCallbackAdapter< ManagerT, id >::ValueType = typename ManagerT::template ValueType<id>

Setting value type.

Constructor & Destructor Documentation

~SettingCallbackAdapter()

template<typename ManagerT , size_t id>

virtual alexaClientSDK::settings::SettingCallbackAdapter< ManagerT, id >::~SettingCallbackAdapter ( )

virtualdefault

The virtual destructor.

Member Function Documentation

addToManager()

template<typename ManagerT , size_t id>

bool alexaClientSDK::settings::SettingCallbackAdapter< ManagerT, id >::addToManager ( ManagerT &  manager )

overridevirtual

Add callback to the given manager.

Parameters

manager

Manager that has the setting to be observed.

Returns

true if it succeeds; otherwise.

The template keyword is required because addObserver definition depends on ManagerT.

Implements alexaClientSDK::settings::SettingCallbackAdapterInterface< ManagerT >.

create()

template<typename ManagerT , size_t id>

std::shared_ptr< SettingCallbackAdapter< ManagerT, id > > alexaClientSDK::settings::SettingCallbackAdapter< ManagerT, id >::create ( SettingCallbackAdapter< ManagerT, id >::FunctionType  callback )

static

Creates a SettingCallbackAdapter object.

Parameters

callback

The function callback that should be called upon notification.

removeFromManager()

template<typename ManagerT , size_t id>

void alexaClientSDK::settings::SettingCallbackAdapter< ManagerT, id >::removeFromManager ( ManagerT &  manager )

overridevirtual

Remove callback from the given manager.

Parameters

manager

Manager that has the setting that was being observed.

The template keyword is required because removeObserver definition depends on ManagerT.

Implements alexaClientSDK::settings::SettingCallbackAdapterInterface< ManagerT >.

---

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

• /workplace/avs-device-sdk/Settings/include/Settings/SettingCallbackAdapter.h