#include <Alarm.h>

Inheritance diagram for alexaClientSDK::acsdkAlerts::Alarm:

Collaboration diagram for alexaClientSDK::acsdkAlerts::Alarm:

Public Member Functions
	Alarm (std::function< std::pair< std::unique_ptr< std::istream >, const avsCommon::utils::MediaType >()> defaultAudioFactory, std::function< std::pair< std::unique_ptr< std::istream >, const avsCommon::utils::MediaType >()> shortAudioFactory, std::shared_ptr< settings::DeviceSettingsManager > settingsManager)

std::string	getTypeName () const override

Public Member Functions inherited from alexaClientSDK::acsdkAlerts::Alert
	Alert (std::function< std::pair< std::unique_ptr< std::istream >, const avsCommon::utils::MediaType >()> defaultAudioFactory, std::function< std::pair< std::unique_ptr< std::istream >, const avsCommon::utils::MediaType >()> shortAudioFactory, std::shared_ptr< settings::DeviceSettingsManager > settingsManager)

std::function< std::pair< std::unique_ptr< std::istream >, const avsCommon::utils::MediaType >)>	getDefaultAudioFactory () const

std::function< std::pair< std::unique_ptr< std::istream >, const avsCommon::utils::MediaType >)>	getShortAudioFactory () const

Alert::ContextInfo	getContextInfo () const

acsdkAlertsInterfaces::AlertObserverInterface::AlertInfo	createAlertInfo (acsdkAlertsInterfaces::AlertObserverInterface::State state, const std::string &reason="") const

void	onRendererStateChange (renderer::RendererObserverInterface::State state, const std::string &reason) override

ParseFromJsonStatus	parseFromJson (const rapidjson::Value &payload, std::string *errorMessage)

void	setRenderer (std::shared_ptr< renderer::RendererInterface > renderer)

void	setObserver (acsdkAlertsInterfaces::AlertObserverInterface *observer)

void	activate ()

void	deactivate (StopReason reason)

bool	updateScheduledTime (const std::string &newScheduledTime)

bool	snooze (const std::string &updatedScheduledTime)

void	setFocusState (avsCommon::avs::FocusState focusState, avsCommon::avs::MixingBehavior behavior)

bool	setStateActive ()

void	reset ()

std::string	getToken () const

int64_t	getScheduledTime_Unix () const

std::string	getScheduledTime_ISO_8601 () const

std::chrono::system_clock::time_point	getScheduledTime_Utc_TimePoint () const

acsdkAlertsInterfaces::AlertObserverInterface::Type	getType () const

avsCommon::utils::Optional< acsdkAlertsInterfaces::AlertObserverInterface::OriginalTime >	getOriginalTime () const

avsCommon::utils::Optional< std::string >	getLabel () const

Alert::State	getState () const

StopReason	getStopReason () const

void	getAlertData (StaticData staticData, DynamicData dynamicData) const

bool	setAlertData (StaticData staticData, DynamicData dynamicData)

int	getId () const

bool	isPastDue (int64_t currentUnixTime, std::chrono::seconds timeLimit)

int	getLoopCount () const

std::chrono::milliseconds	getLoopPause () const

std::string	getBackgroundAssetId () const

AssetConfiguration	getAssetConfiguration () const

bool	setAssetConfiguration (const AssetConfiguration &assetConfiguration)

void	printDiagnostic ()

Public Member Functions inherited from alexaClientSDK::acsdkAlerts::renderer::RendererObserverInterface
virtual	~RendererObserverInterface ()=default

Static Public Member Functions
static std::string	getTypeNameStatic ()
	Static member function to get the string representation of this type. More...

Static Public Member Functions inherited from alexaClientSDK::acsdkAlerts::Alert
static avsCommon::utils::Optional< acsdkAlertsInterfaces::AlertObserverInterface::OriginalTime >	validateOriginalTimeString (const std::string &originalTimeStr)

static avsCommon::utils::Optional< std::string >	validateLabelString (const std::string &label)

static std::string	stateToString (Alert::State state)

static std::string	stopReasonToString (Alert::StopReason stopReason)

static std::string	parseFromJsonStatusToString (Alert::ParseFromJsonStatus parseFromJsonStatus)

Static Public Member Functions inherited from alexaClientSDK::acsdkAlerts::renderer::RendererObserverInterface
static std::string	stateToString (State state)

Additional Inherited Members
Public Types inherited from alexaClientSDK::acsdkAlerts::Alert
enum	State { State::UNSET, State::SET, State::READY, State::ACTIVATING, State::ACTIVE, State::SNOOZING, State::SNOOZED, State::STOPPING, State::STOPPED, State::COMPLETED }

enum	StopReason { StopReason::UNSET, StopReason::AVS_STOP, StopReason::LOCAL_STOP, StopReason::SHUTDOWN, StopReason::LOG_OUT }

enum	ParseFromJsonStatus { ParseFromJsonStatus::OK, ParseFromJsonStatus::MISSING_REQUIRED_PROPERTY, ParseFromJsonStatus::INVALID_VALUE }

Public Types inherited from alexaClientSDK::acsdkAlerts::renderer::RendererObserverInterface
enum	State { State::UNSET, State::STARTED, State::STOPPED, State::COMPLETED, State::ERROR }

Detailed Description

An Alarm class. This represents an alert which the user wishes to activate at a specific point in time, which they specify as that absolute time point, rather than an offset from the current time.

There is no expected special behavior for this type of alert - it will render a simple audio asset on the device when activated.

Constructor & Destructor Documentation

◆ Alarm()

alexaClientSDK::acsdkAlerts::Alarm::Alarm	(	std::function< std::pair< std::unique_ptr< std::istream >, const avsCommon::utils::MediaType >()>	defaultAudioFactory,
		std::function< std::pair< std::unique_ptr< std::istream >, const avsCommon::utils::MediaType >()>	shortAudioFactory,
		std::shared_ptr< settings::DeviceSettingsManager >	settingsManager
	)

Member Function Documentation

◆ getTypeName()

std::string alexaClientSDK::acsdkAlerts::Alarm::getTypeName ( ) const

overridevirtual

Returns a string to identify the type of the class. Required for persistent storage.

Returns: The type name of the alert.

Implements alexaClientSDK::acsdkAlerts::Alert.

◆ getTypeNameStatic()

static std::string alexaClientSDK::acsdkAlerts::Alarm::getTypeNameStatic ( )

inlinestatic

Static member function to get the string representation of this type.

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

/workplace/avs-device-sdk/capabilities/Alerts/acsdkAlerts/include/acsdkAlerts/Alarm.h

Public Member Functions