alexaClientSDK::settings::SharedAVSSettingProtocol Class Reference

#include <SharedAVSSettingProtocol.h>

Inheritance diagram for alexaClientSDK::settings::SharedAVSSettingProtocol:

Collaboration diagram for alexaClientSDK::settings::SharedAVSSettingProtocol:

Public Member Functions
void	connectionStatusChangeCallback (bool isConnected)
	~SharedAVSSettingProtocol ()
SettingProtocolInterface methods.
SetSettingResult	localChange (ApplyChangeFunction applyChange, RevertChangeFunction revertChange, SettingNotificationFunction notifyObservers) override
bool	avsChange (ApplyChangeFunction applyChange, RevertChangeFunction revertChange, SettingNotificationFunction notifyObservers) override
bool	restoreValue (ApplyDbChangeFunction applyChange, SettingNotificationFunction notifyObservers) override
bool	clearData () override
Public Member Functions inherited from alexaClientSDK::settings::SettingProtocolInterface
virtual	~SettingProtocolInterface ()=default

Static Public Member Functions
static std::unique_ptr< SharedAVSSettingProtocol >	create (const SettingEventMetadata &metadata, std::shared_ptr< SettingEventSenderInterface > eventSender, std::shared_ptr< storage::DeviceSettingStorageInterface > settingStorage, std::shared_ptr< avsCommon::sdkInterfaces::AVSConnectionManagerInterface > connectionManager, const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &metricRecorder, bool isDefaultCloudAuthoritative=false)

Additional Inherited Members
Public Types inherited from alexaClientSDK::settings::SettingProtocolInterface
using	ApplyChangeFunction = std::function< std::pair< bool, std::string >()>
using	ApplyDbChangeFunction = std::function< std::pair< bool, std::string >(const std::string &dbValue)>
using	SettingNotificationFunction = std::function< void(SettingNotifications notification)>
using	RevertChangeFunction = std::function< std::string()>

Detailed Description

Implement the logic of shared setting protocol. In the shared setting protocol, a change to the setting value can be originated by an AVS or device UI request.

Constructor & Destructor Documentation

~SharedAVSSettingProtocol()

alexaClientSDK::settings::SharedAVSSettingProtocol::~SharedAVSSettingProtocol

(

)

Destructor. Deregisters from connection notifications.

Member Function Documentation

avsChange()

bool alexaClientSDK::settings::SharedAVSSettingProtocol::avsChange ( ApplyChangeFunction  applyChange, RevertChangeFunction  revertChange, SettingNotificationFunction  notifyObservers  )

overridevirtual

Implements the protocol for changing a setting value triggered by an AVS directive.

Parameters

applyChange	Function that can be used to apply the new value.
revertChange	Function that can be used to revert the change. This function should only be called if the apply change succeeded but some other part of the protocol has failed.
notifyObservers	Function used to notify the observers of the protocol result.

Returns

true if the directive was enqueued correctly; false otherwise.

Implements alexaClientSDK::settings::SettingProtocolInterface.

clearData()

bool alexaClientSDK::settings::SharedAVSSettingProtocol::clearData ( )

overridevirtual

Clear the data for this setting.

Returns

true if it data is cleared; otherwise.

Implements alexaClientSDK::settings::SettingProtocolInterface.

connectionStatusChangeCallback()

void alexaClientSDK::settings::SharedAVSSettingProtocol::connectionStatusChangeCallback

(

bool

isConnected

)

The callback method to be called whenever there is a change in connection status.

Parameters

isConnected

If true, indicates that the device is connected to AVS, otherwise false.

create()

static std::unique_ptr<SharedAVSSettingProtocol> alexaClientSDK::settings::SharedAVSSettingProtocol::create ( const SettingEventMetadata &  metadata, std::shared_ptr< SettingEventSenderInterface >  eventSender, std::shared_ptr< storage::DeviceSettingStorageInterface >  settingStorage, std::shared_ptr< avsCommon::sdkInterfaces::AVSConnectionManagerInterface >  connectionManager, const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &  metricRecorder, bool  isDefaultCloudAuthoritative = false  )

static

Create a shared protocol object.

Parameters

metadata	The setting metadata used to generate a unique database key.
eventSender	Object used to send events to avs in order to report changes to the device.
settingStorage	The setting storage object.
connectionManager	An AVSConnectionManagerInterface instance to listen for connection status updates.
metricRecorder	The MetricRecorderInterface to record metrics.
isDefaultCloudAuthoritative	Indicates if the default value for the setting should be cloud authoritative or not. If it is, for the first time when the setting is created, the default value of the setting will be sent to AVS using a report event. If it is not cloud authoritative, then the default value of the setting will be sent to AVS using a changed event.

Returns

A pointer to the new SharedAVSSettingProtocol object if it succeeds; nullptr otherwise.

localChange()

SetSettingResult alexaClientSDK::settings::SharedAVSSettingProtocol::localChange ( ApplyChangeFunction  applyChange, RevertChangeFunction  revertChange, SettingNotificationFunction  notifyObservers  )

overridevirtual

Implements the protocol for changing a setting value through local UI.

Parameters

applyChange	Function that can be used to apply the new value.
revertChange	Function that can be used to revert the change. This function should only be called if the apply change succeeded but some other part of the protocol has failed.
notifyObservers	Function used to notify the observers of the protocol result.

Returns

Returns what was the set result.

Implements alexaClientSDK::settings::SettingProtocolInterface.

restoreValue()

bool alexaClientSDK::settings::SharedAVSSettingProtocol::restoreValue ( ApplyDbChangeFunction  applyChange, SettingNotificationFunction  notifyObservers  )

overridevirtual

Implements the protocol for restoring a value from the storage.

Parameters

applyChange	Function that can be used to apply the value restored from the storage. This function will be called with empty string if no value was found in the database.
notifyObservers	Function used to notify the observers of the protocol result.

Returns

true if the directive was enqueued correctly; false otherwise.

Implements alexaClientSDK::settings::SettingProtocolInterface.

---

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

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