alexaClientSDK::acsdkAlerts Namespace Reference

Namespaces
	renderer
	storage
	test

Classes
class	Alarm
class	Alert
class	AlertsCapabilityAgent
class	AlertScheduler
class	Reminder
struct	TimeComparator
class	Timer

Typedefs
using	AlertsComponent = acsdkManufactory::Component< std::shared_ptr< acsdkAlertsInterfaces::AlertsCapabilityAgentInterface >, acsdkManufactory::Import< std::shared_ptr< acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface > >, acsdkManufactory::Import< std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface > >, acsdkManufactory::Import< std::shared_ptr< acsdkSystemClockMonitorInterfaces::SystemClockNotifierInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::AVSConnectionManagerInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > >, acsdkManufactory::Import< acsdkManufactory::Annotated< avsCommon::sdkInterfaces::AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionMonitorInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::audio::AudioFactoryInterface > >, acsdkManufactory::Import< acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > >, acsdkManufactory::Import< std::shared_ptr< certifiedSender::CertifiedSender > >, acsdkManufactory::Import< std::shared_ptr< registrationManager::CustomerDataManagerInterface > >, acsdkManufactory::Import< std::shared_ptr< settings::DeviceSettingsManager > >, acsdkManufactory::Import< std::shared_ptr< storage::AlertStorageInterface > >>

Functions
std::ostream &	operator<< (std::ostream &stream, const Alert::State &state)
std::ostream &	operator<< (std::ostream &stream, const Alert::StopReason &reason)
std::ostream &	operator<< (std::ostream &stream, const Alert::ParseFromJsonStatus &status)
AlertsComponent	getComponent (bool startAlertSchedulingOnInitialization=true)

Variables
static const std::chrono::minutes	ALERT_PAST_DUE_CUTOFF_MINUTES = std::chrono::minutes(30)
static const constexpr char *	ALERTS_MEDIA_PLAYER_NAME = "AlertsMediaPlayer"
	String to identify the alerts media player to render audio. More...

Typedef Documentation

AlertsComponent

using alexaClientSDK::acsdkAlerts::AlertsComponent = typedef acsdkManufactory::Component< std::shared_ptr<acsdkAlertsInterfaces::AlertsCapabilityAgentInterface>, acsdkManufactory::Import< std::shared_ptr<acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface> >, acsdkManufactory::Import<std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownNotifierInterface> >, acsdkManufactory::Import<std::shared_ptr<acsdkSystemClockMonitorInterfaces::SystemClockNotifierInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::AVSConnectionManagerInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> >, acsdkManufactory::Import<acsdkManufactory::Annotated< avsCommon::sdkInterfaces::AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::InternetConnectionMonitorInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::SpeakerManagerInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::audio::AudioFactoryInterface> >, acsdkManufactory::Import<acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> >, acsdkManufactory::Import<std::shared_ptr<certifiedSender::CertifiedSender> >, acsdkManufactory::Import<std::shared_ptr<registrationManager::CustomerDataManagerInterface> >, acsdkManufactory::Import<std::shared_ptr<settings::DeviceSettingsManager> >, acsdkManufactory::Import<std::shared_ptr<storage::AlertStorageInterface> >>

Definition of a Manufactory component that exports an Alerts Capability Agent.

Function Documentation

getComponent()

AlertsComponent alexaClientSDK::acsdkAlerts::getComponent

(

bool

startAlertSchedulingOnInitialization = true

)

Get the manufactory Component for an Alerts Capability Agent.

Parameters

startAlertSchedulingOnInitialization

Whether to start scheduling alerts after client initialization. If this is set to false, no alert scheduling will occur until onSystemClockSynchronized is called.

Returns

An AlertsComponent.

operator<<() [1/3]

std::ostream& alexaClientSDK::acsdkAlerts::operator<< ( std::ostream &  stream, const Alert::State &  state  )

inline

Write a Alert::State value to an ostream as a string.

Parameters

stream	The stream to write the value to.
state	The Alert::State value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [2/3]

std::ostream& alexaClientSDK::acsdkAlerts::operator<< ( std::ostream &  stream, const Alert::StopReason &  reason  )

inline

Write a Alert::StopReason value to an ostream as a string.

Parameters

stream	The stream to write the value to.
reason	The Alert::StopReason value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [3/3]

std::ostream& alexaClientSDK::acsdkAlerts::operator<< ( std::ostream &  stream, const Alert::ParseFromJsonStatus &  status  )

inline

Write a Alert::ParseFromJsonStatus value to an ostream as a string.

Parameters

stream	The stream to write the value to.
status	The Alert::ParseFromJsonStatus value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

Variable Documentation

ALERT_PAST_DUE_CUTOFF_MINUTES

const std::chrono::minutes alexaClientSDK::acsdkAlerts::ALERT_PAST_DUE_CUTOFF_MINUTES = std::chrono::minutes(30)

static

ALERTS_MEDIA_PLAYER_NAME

const constexpr char* alexaClientSDK::acsdkAlerts::ALERTS_MEDIA_PLAYER_NAME = "AlertsMediaPlayer"

static

String to identify the alerts media player to render audio.