AlexaClientSDK
1.19.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
Public Member Functions | |
bool | createDatabase () override |
bool | open () override |
void | close () override |
bool | store (std::shared_ptr< Alert >) override |
bool | load (std::vector< std::shared_ptr< Alert >> *, std::shared_ptr< settings::DeviceSettingsManager >) override |
bool | modify (std::shared_ptr< Alert >) override |
bool | erase (std::shared_ptr< Alert >) override |
bool | clearDatabase () override |
bool | bulkErase (const std::list< std::shared_ptr< Alert >> &) override |
Public Member Functions inherited from alexaClientSDK::capabilityAgents::alerts::storage::AlertStorageInterface | |
virtual | ~AlertStorageInterface ()=default |
Test AlertStorageInterface
implementation to provide a valid instance for the initialization of other components.
|
inlineoverridevirtual |
Erases multiple alerts from the database. This function must be atomic, no alert is to be deleted if there was an error deleting one.
alertList | The list of alerts to be erased. |
Implements alexaClientSDK::capabilityAgents::alerts::storage::AlertStorageInterface.
|
inlineoverridevirtual |
A utility function to clear the database of all records. Note that the database will still exist, as will the tables. Only the rows will be erased.
Implements alexaClientSDK::capabilityAgents::alerts::storage::AlertStorageInterface.
|
inlineoverridevirtual |
Close the currently open database, if one is open.
Implements alexaClientSDK::capabilityAgents::alerts::storage::AlertStorageInterface.
|
inlineoverridevirtual |
Creates a new database. If a database is already being handled by this object or there is another internal error, then this function returns false.
true
If the database is created ok, or false
if a database is already being handled by this object or there is a problem creating the database. Implements alexaClientSDK::capabilityAgents::alerts::storage::AlertStorageInterface.
|
inlineoverridevirtual |
Erases a single alert from the database.
alert | The Alert to be erased. |
Alert
was successfully erased. Implements alexaClientSDK::capabilityAgents::alerts::storage::AlertStorageInterface.
|
inlineoverridevirtual |
Loads all alerts in the database.
[out] | alertContainer | The container where alerts should be stored. |
settingsManager | A settingsManager object that manages alarm volume ramp setting. |
Alerts
were successfully loaded. Implements alexaClientSDK::capabilityAgents::alerts::storage::AlertStorageInterface.
|
inlineoverridevirtual |
Updates a database record of the Alert
parameter. The fields which are updated by this operation are the state and scheduled times of the alert. All other fields of an alert do not change over time, and so will not be captured in the database when calling this function.
alert | The Alert to be modified. |
Alert
was successfully modified. Implements alexaClientSDK::capabilityAgents::alerts::storage::AlertStorageInterface.
|
inlineoverridevirtual |
Open an existing database. If this object is already managing an open database, or there is a problem opening the database, this function returns false.
true
If the database is opened ok, false
if this object is already managing an open database, or if there is another internal reason the database could not be opened. Implements alexaClientSDK::capabilityAgents::alerts::storage::AlertStorageInterface.
|
inlineoverridevirtual |
Stores a single Alert
in the database.
The | Alert to store. |
Alert
was successfully stored. Implements alexaClientSDK::capabilityAgents::alerts::storage::AlertStorageInterface.
AlexaClientSDK 1.19.0 - Copyright 2016-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0