Namespaces
	renderer

	storage

	test

Classes
class	Alarm

class	Alert

class	AlertObserverInterface

class	AlertsCapabilityAgent

class	AlertScheduler

class	Reminder

struct	TimeComparator

class	Timer

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)

std::ostream &	operator<< (std::ostream &stream, const AlertObserverInterface::State &state)

static const std::string	TAG ("Alert")
	String to identify log entries originating from this file. More...

static Alert::ParseFromJsonStatus	parseAlertAssetConfigurationFromJson (const rapidjson::Value &payload, Alert::AssetConfiguration assetConfiguration, Alert::DynamicData dynamicData)

static bool	hasAsset (const std::string &key, const std::unordered_map< std::string, Alert::Asset > &assets)

static bool	validateStaticData (const Alert::StaticData &staticData)

static const std::string	TAG ("AlertsCapabilityAgent")
	String to identify log entries originating from this file. More...

static std::shared_ptr< avsCommon::avs::CapabilityConfiguration >	getAlertsCapabilityConfiguration ()

static rapidjson::Value	buildAllAlertsContext (const std::vector< Alert::ContextInfo > &alertsInfo, Document::AllocatorType &allocator)

static rapidjson::Value	buildActiveAlertsContext (const std::vector< Alert::ContextInfo > &alertsInfo, Document::AllocatorType &allocator)

static void	submitMetric (const std::shared_ptr< MetricRecorderInterface > &metricRecorder, const std::string &eventName, int count)

static const std::string	TAG ("AlertScheduler")
	String to identify log entries originating from this file. More...

Variables
static const std::chrono::minutes	ALERT_PAST_DUE_CUTOFF_MINUTES = std::chrono::minutes(30)

static const std::string	KEY_TOKEN = "token"
	String for lookup of the token value in a parsed JSON document. More...

static const std::string	KEY_SCHEDULED_TIME = "scheduledTime"
	String for lookup of the scheduled time value in a parsed JSON document. More...

static const std::string	KEY_ASSETS = "assets"
	String for lookup of the assets array in a parsed JSON document. More...

static const std::string	KEY_ASSET_ID = "assetId"
	String for lookup of the asset id within an asset object in a parsed JSON document. More...

static const std::string	KEY_ASSET_URL = "url"
	String for lookup of the asset url within an asset object in a parsed JSON document. More...

static const std::string	KEY_ASSET_PLAY_ORDER = "assetPlayOrder"
	String for lookup of the asset play order array in a parsed JSON document. More...

static const std::string	KEY_LOOP_COUNT = "loopCount"
	String for lookup of the loop count value in a parsed JSON document. More...

static const std::string	KEY_LOOP_PAUSE_IN_MILLISECONDS = "loopPauseInMilliSeconds"
	String for lookup of the loop pause in milliseconds value in a parsed JSON document. More...

static const std::string	KEY_BACKGROUND_ASSET_ID = "backgroundAlertAsset"
	String for lookup of the backgroundAssetId for an alert, if assets are provided. More...

const std::chrono::seconds	MAXIMUM_ALERT_RENDERING_TIME = std::chrono::hours(1)
	We won't allow an alert to render more than 1 hour. More...

const auto	BACKGROUND_ALERT_SOUND_PAUSE_TIME = std::chrono::seconds(10)
	Length of pause of alert sounds when played in background. More...

static const std::string	ALERTS_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"

static const std::string	ALERTS_CAPABILITY_INTERFACE_NAME = "Alerts"
	Alerts interface name. More...

static const std::string	ALERTS_CAPABILITY_INTERFACE_VERSION = "1.4"
	Alerts interface version. More...

static const std::string	KEY_TYPE = "type"
	The value for Type which we need for json parsing. More...

static const std::string	DIRECTIVE_NAME_SET_ALERT = "SetAlert"
	The value of the SetAlert Directive. More...

static const std::string	DIRECTIVE_NAME_DELETE_ALERT = "DeleteAlert"
	The value of the DeleteAlert Directive. More...

static const std::string	DIRECTIVE_NAME_DELETE_ALERTS = "DeleteAlerts"
	The value of the DeleteAlerts Directive. More...

static const std::string	DIRECTIVE_NAME_SET_VOLUME = "SetVolume"
	The value of the SetVolume Directive. More...

static const std::string	DIRECTIVE_NAME_ADJUST_VOLUME = "AdjustVolume"
	The value of the AdjustVolume Directive. More...

static const std::string	DIRECTIVE_NAME_SET_ALARM_VOLUME_RAMP = "SetAlarmVolumeRamp"
	The value of the SetAlarmVolumeRamp Directive. More...

static const std::string	SET_ALERT_SUCCEEDED_EVENT_NAME = "SetAlertSucceeded"
	The value of the SetAlertSucceeded Event name. More...

static const std::string	SET_ALERT_FAILED_EVENT_NAME = "SetAlertFailed"
	The value of the SetAlertFailed Event name. More...

static const std::string	DELETE_ALERT_SUCCEEDED_EVENT_NAME = "DeleteAlertSucceeded"
	The value of the DeleteAlertSucceeded Event name. More...

static const std::string	DELETE_ALERT_FAILED_EVENT_NAME = "DeleteAlertFailed"
	The value of the DeleteAlertFailed Event name. More...

static const std::string	ALERT_STARTED_EVENT_NAME = "AlertStarted"
	The value of the AlertStarted Event name. More...

static const std::string	ALERT_STOPPED_EVENT_NAME = "AlertStopped"
	The value of the AlertStopped Event name. More...

static const std::string	ALERT_ENTERED_FOREGROUND_EVENT_NAME = "AlertEnteredForeground"
	The value of the AlertEnteredForeground Event name. More...

static const std::string	ALERT_ENTERED_BACKGROUND_EVENT_NAME = "AlertEnteredBackground"
	The value of the AlertEnteredBackground Event name. More...

static const std::string	ALERT_VOLUME_CHANGED_EVENT_NAME = "VolumeChanged"
	The value of the VolumeChanged Event name. More...

static const std::string	ALERT_DELETE_ALERTS_SUCCEEDED_EVENT_NAME = "DeleteAlertsSucceeded"
	The value of the DeleteAlertsSucceeded Event name. More...

static const std::string	ALERT_DELETE_ALERTS_FAILED_EVENT_NAME = "DeleteAlertsFailed"
	The value of the DeleteAlertsFailed Event name. More...

static const std::string	ALERT_ALARM_VOLUME_RAMP_CHANGED_EVENT_NAME = "AlarmVolumeRampChanged"
	The value of the AlarmVolumeRampChanged Event name. More...

static const std::string	ALERT_REPORT_ALARM_VOLUME_RAMP_EVENT_NAME = "AlarmVolumeRampReport"
	The value of the ReportAlarmVolumeRamp Event name. More...

static const std::string	EVENT_PAYLOAD_TOKEN_KEY = "token"
	The value of the event payload key for a single token. More...

static const std::string	EVENT_PAYLOAD_TOKENS_KEY = "tokens"
	The value of the event payload key for multiple tokens. More...

static const std::string	DIRECTIVE_PAYLOAD_TOKEN_KEY = "token"
	The value of Token text in a Directive we may receive. More...

static const std::string	DIRECTIVE_PAYLOAD_TOKENS_KEY = "tokens"
	The value of Token list key in a Directive we may receive. More...

static const std::string	DIRECTIVE_PAYLOAD_VOLUME = "volume"
	The value of volume key in a Directive we may receive. More...

static const std::string	DIRECTIVE_PAYLOAD_ALARM_VOLUME_RAMP = "alarmVolumeRamp"
	The value of alarm volume ramp key in a Directive we may receive. More...

static const std::string	AVS_CONTEXT_HEADER_NAMESPACE_VALUE_KEY = "Alerts"

static const std::string	AVS_CONTEXT_HEADER_NAME_VALUE_KEY = "AlertsState"
	The value of the Alerts Context Names. More...

static const std::string	AVS_CONTEXT_ALL_ALERTS_TOKEN_KEY = "allAlerts"
	The value of the Alerts Context allAlerts node. More...

static const std::string	AVS_CONTEXT_ACTIVE_ALERTS_TOKEN_KEY = "activeAlerts"
	The value of the Alerts Context activeAlerts node. More...

static const std::string	AVS_CONTEXT_ALERT_TOKEN_KEY = "token"
	The value of the Alerts Context token key. More...

static const std::string	AVS_CONTEXT_ALERT_TYPE_KEY = "type"
	The value of the Alerts Context type key. More...

static const std::string	AVS_CONTEXT_ALERT_SCHEDULED_TIME_KEY = "scheduledTime"
	The value of the Alerts Context scheduled time key. More...

static const std::string	AVS_PAYLOAD_VOLUME_KEY = "volume"
	The value of the volume state info volume key. More...

static const std::string	AVS_PAYLOAD_ALARM_VOLUME_RAMP_KEY = "alarmVolumeRamp"
	The value of the alarm volume ramp state key for alarm volume ramp events. More...

static const std::string	AVS_PAYLOAD_ERROR_KEY = "error"
	The JSON key in the payload of error events. More...

static const std::string	AVS_PAYLOAD_ERROR_TYPE_KEY = "type"
	The JSON key for the error type in the payload of error events. More...

static const std::string	AVS_PAYLOAD_ERROR_MESSAGE_KEY = "message"
	The JSON key for the error message in the payload of error events. More...

static const std::string	EMPTY_DIALOG_REQUEST_ID = ""
	An empty dialogRequestId. More...

static const std::string	NAMESPACE = "Alerts"
	The namespace for this capability agent. More...

static const avsCommon::avs::NamespaceAndName	SET_ALERT {NAMESPACE, DIRECTIVE_NAME_SET_ALERT}
	The SetAlert directive signature. More...

static const avsCommon::avs::NamespaceAndName	DELETE_ALERT {NAMESPACE, DIRECTIVE_NAME_DELETE_ALERT}
	The DeleteAlert directive signature. More...

static const avsCommon::avs::NamespaceAndName	DELETE_ALERTS {NAMESPACE, DIRECTIVE_NAME_DELETE_ALERTS}
	The DeleteAlerts directive signature. More...

static const avsCommon::avs::NamespaceAndName	SET_VOLUME {NAMESPACE, DIRECTIVE_NAME_SET_VOLUME}
	The SetVolume directive signature. More...

static const avsCommon::avs::NamespaceAndName	ADJUST_VOLUME {NAMESPACE, DIRECTIVE_NAME_ADJUST_VOLUME}
	The AdjustVolume directive signature. More...

static const avsCommon::avs::NamespaceAndName	SET_ALARM_VOLUME_RAMP {NAMESPACE, DIRECTIVE_NAME_SET_ALARM_VOLUME_RAMP}
	The SetAlarmVolumeRamp directive signature. More...

static const std::string	ALERT_METRIC_SOURCE_PREFIX = "ALERT-"
	Metric Activity Name Prefix for ALERT metric source. More...

static const std::string	FAILED_SNOOZE_ALERT = "failedToSnoozeAlert"
	Metric constants related to Alerts. More...

static const std::string	FAILED_SCHEDULE_ALERT = "failedToScheduleAlert"

static const std::string	INVALID_PAYLOAD_FOR_SET_ALARM_VOLUME = "invalidPayloadToSetAlarmRamping"

static const std::string	INVALID_PAYLOAD_FOR_CHANGE_ALARM_VOLUME = "invalidPayloadToChangeAlarmVolume"

Function Documentation

◆ buildActiveAlertsContext()

static rapidjson::Value alexaClientSDK::capabilityAgents::alerts::buildActiveAlertsContext	(	const std::vector< Alert::ContextInfo > &	alertsInfo,
		Document::AllocatorType &	allocator
	)

static

Utility function to construct a rapidjson array of alert details, representing all the currently active alerts.

Parameters

alertsInfo	The currently active alert, which may be nullptr if no alert is active.
allocator	The rapidjson allocator, required for the results of this function to be mergable with other rapidjson::Value objects.

Returns: The rapidjson::Value representing the array.

◆ buildAllAlertsContext()

static rapidjson::Value alexaClientSDK::capabilityAgents::alerts::buildAllAlertsContext	(	const std::vector< Alert::ContextInfo > &	alertsInfo,
		Document::AllocatorType &	allocator
	)

static

Utility function to construct a rapidjson array of alert details, representing all the alerts currently managed.

Parameters

alertsInfo	All the alerts being managed by this Capability Agent.
allocator	The rapidjson allocator, required for the results of this function to be mergable with other rapidjson::Value objects.

Returns: The rapidjson::Value representing the array.

◆ getAlertsCapabilityConfiguration()

std::shared_ptr< CapabilityConfiguration > alexaClientSDK::capabilityAgents::alerts::getAlertsCapabilityConfiguration ( )

static

Creates the alerts capability configuration.

Returns: The alerts capability configuration.

◆ hasAsset()

static bool alexaClientSDK::capabilityAgents::alerts::hasAsset	(	const std::string &	key,
		const std::unordered_map< std::string, Alert::Asset > &	assets
	)

static

Checks if the assets map contains a certain key and that the object mapped by the key is valid.

Parameters

key	The key to search in the assets map
assets	The assets map

Returns: true if the key was found in the assets, if the asset's id is the same as the key and asset url is not empty

◆ operator<<() [1/4]

std::ostream& alexaClientSDK::capabilityAgents::alerts::operator<<	(	std::ostream &	stream,
		const AlertObserverInterface::State &	state
	)

inline

Write a State value to an ostream.

Parameters

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

Returns: The ostream that was passed in and written to.

◆ operator<<() [2/4]

std::ostream& alexaClientSDK::capabilityAgents::alerts::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<<() [3/4]

std::ostream& alexaClientSDK::capabilityAgents::alerts::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<<() [4/4]

std::ostream& alexaClientSDK::capabilityAgents::alerts::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.

◆ parseAlertAssetConfigurationFromJson()

static Alert::ParseFromJsonStatus alexaClientSDK::capabilityAgents::alerts::parseAlertAssetConfigurationFromJson	(	const rapidjson::Value &	payload,
		Alert::AssetConfiguration *	assetConfiguration,
		Alert::DynamicData *	dynamicData
	)

static

Utility function to parse the optional Asset data from an AVS SetAlert Directive. The only strictly required fields for assets to be valid are the assets themselves (a pair of id & url), and the assetPlayOrder. If the other fields are missing or empty, they are ignored. If the assets are malformed or missing, or otherwise not complete for asset rendering, this function returns early allowing the caller to proceed as if there were no assets in the Directive. This allows the Alert to still serve its purpose in some capacity.

Parameters

	payload	The pre-parsed rapidjson::Value.
[out]	assetConfiguration	An output parameter where the assets will be stored if parsed successfully.

Returns: The status of the parse.

◆ submitMetric()

static void alexaClientSDK::capabilityAgents::alerts::submitMetric	(	const std::shared_ptr< MetricRecorderInterface > &	metricRecorder,
		const std::string &	eventName,
		int	count
	)

static

Submits a metric for a given count and name

Parameters

metricRecorder	The `MetricRecorderInterface` which records Metric events
eventName	The name of the metric event
count	The count for metric event

◆ TAG() [1/3]

static const std::string alexaClientSDK::capabilityAgents::alerts::TAG ( "AlertScheduler" )

static

String to identify log entries originating from this file.

◆ TAG() [2/3]

static const std::string alexaClientSDK::capabilityAgents::alerts::TAG ( "Alert" )

static

String to identify log entries originating from this file.

◆ TAG() [3/3]

static const std::string alexaClientSDK::capabilityAgents::alerts::TAG ( "AlertsCapabilityAgent" )

static

String to identify log entries originating from this file.

◆ validateStaticData()

static bool alexaClientSDK::capabilityAgents::alerts::validateStaticData ( const Alert::StaticData & staticData )

static

Validates the static data

Parameters

staticData Static data struct to validate

Returns: true if the data is valid

Variable Documentation

◆ ADJUST_VOLUME

const avsCommon::avs::NamespaceAndName alexaClientSDK::capabilityAgents::alerts::ADJUST_VOLUME {NAMESPACE, DIRECTIVE_NAME_ADJUST_VOLUME}

static

The AdjustVolume directive signature.

◆ ALERT_ALARM_VOLUME_RAMP_CHANGED_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::alerts::ALERT_ALARM_VOLUME_RAMP_CHANGED_EVENT_NAME = "AlarmVolumeRampChanged"

static

The value of the AlarmVolumeRampChanged Event name.

◆ ALERT_DELETE_ALERTS_FAILED_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::alerts::ALERT_DELETE_ALERTS_FAILED_EVENT_NAME = "DeleteAlertsFailed"

static

The value of the DeleteAlertsFailed Event name.

◆ ALERT_DELETE_ALERTS_SUCCEEDED_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::alerts::ALERT_DELETE_ALERTS_SUCCEEDED_EVENT_NAME = "DeleteAlertsSucceeded"

static

The value of the DeleteAlertsSucceeded Event name.

◆ ALERT_ENTERED_BACKGROUND_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::alerts::ALERT_ENTERED_BACKGROUND_EVENT_NAME = "AlertEnteredBackground"

static

The value of the AlertEnteredBackground Event name.

◆ ALERT_ENTERED_FOREGROUND_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::alerts::ALERT_ENTERED_FOREGROUND_EVENT_NAME = "AlertEnteredForeground"

static

The value of the AlertEnteredForeground Event name.

◆ ALERT_METRIC_SOURCE_PREFIX

const std::string alexaClientSDK::capabilityAgents::alerts::ALERT_METRIC_SOURCE_PREFIX = "ALERT-"

static

Metric Activity Name Prefix for ALERT metric source.

◆ ALERT_PAST_DUE_CUTOFF_MINUTES

const std::chrono::minutes alexaClientSDK::capabilityAgents::alerts::ALERT_PAST_DUE_CUTOFF_MINUTES = std::chrono::minutes(30)

static

◆ ALERT_REPORT_ALARM_VOLUME_RAMP_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::alerts::ALERT_REPORT_ALARM_VOLUME_RAMP_EVENT_NAME = "AlarmVolumeRampReport"

static

The value of the ReportAlarmVolumeRamp Event name.

◆ ALERT_STARTED_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::alerts::ALERT_STARTED_EVENT_NAME = "AlertStarted"

static

The value of the AlertStarted Event name.

◆ ALERT_STOPPED_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::alerts::ALERT_STOPPED_EVENT_NAME = "AlertStopped"

static

The value of the AlertStopped Event name.

◆ ALERT_VOLUME_CHANGED_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::alerts::ALERT_VOLUME_CHANGED_EVENT_NAME = "VolumeChanged"

static

The value of the VolumeChanged Event name.

◆ ALERTS_CAPABILITY_INTERFACE_NAME

const std::string alexaClientSDK::capabilityAgents::alerts::ALERTS_CAPABILITY_INTERFACE_NAME = "Alerts"

static

Alerts interface name.

◆ ALERTS_CAPABILITY_INTERFACE_TYPE

const std::string alexaClientSDK::capabilityAgents::alerts::ALERTS_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"

static

Alerts capability constants Alerts interface type

◆ ALERTS_CAPABILITY_INTERFACE_VERSION

const std::string alexaClientSDK::capabilityAgents::alerts::ALERTS_CAPABILITY_INTERFACE_VERSION = "1.4"

static

Alerts interface version.

◆ AVS_CONTEXT_ACTIVE_ALERTS_TOKEN_KEY

const std::string alexaClientSDK::capabilityAgents::alerts::AVS_CONTEXT_ACTIVE_ALERTS_TOKEN_KEY = "activeAlerts"

static

The value of the Alerts Context activeAlerts node.

◆ AVS_CONTEXT_ALERT_SCHEDULED_TIME_KEY

const std::string alexaClientSDK::capabilityAgents::alerts::AVS_CONTEXT_ALERT_SCHEDULED_TIME_KEY = "scheduledTime"

static

The value of the Alerts Context scheduled time key.

◆ AVS_CONTEXT_ALERT_TOKEN_KEY

const std::string alexaClientSDK::capabilityAgents::alerts::AVS_CONTEXT_ALERT_TOKEN_KEY = "token"

static

The value of the Alerts Context token key.

◆ AVS_CONTEXT_ALERT_TYPE_KEY

const std::string alexaClientSDK::capabilityAgents::alerts::AVS_CONTEXT_ALERT_TYPE_KEY = "type"

static

The value of the Alerts Context type key.

◆ AVS_CONTEXT_ALL_ALERTS_TOKEN_KEY

const std::string alexaClientSDK::capabilityAgents::alerts::AVS_CONTEXT_ALL_ALERTS_TOKEN_KEY = "allAlerts"

static

The value of the Alerts Context allAlerts node.

◆ AVS_CONTEXT_HEADER_NAME_VALUE_KEY

const std::string alexaClientSDK::capabilityAgents::alerts::AVS_CONTEXT_HEADER_NAME_VALUE_KEY = "AlertsState"

static

The value of the Alerts Context Names.

◆ AVS_CONTEXT_HEADER_NAMESPACE_VALUE_KEY

const std::string alexaClientSDK::capabilityAgents::alerts::AVS_CONTEXT_HEADER_NAMESPACE_VALUE_KEY = "Alerts"

static

◆ AVS_PAYLOAD_ALARM_VOLUME_RAMP_KEY

const std::string alexaClientSDK::capabilityAgents::alerts::AVS_PAYLOAD_ALARM_VOLUME_RAMP_KEY = "alarmVolumeRamp"

static

The value of the alarm volume ramp state key for alarm volume ramp events.

◆ AVS_PAYLOAD_ERROR_KEY

const std::string alexaClientSDK::capabilityAgents::alerts::AVS_PAYLOAD_ERROR_KEY = "error"

static

The JSON key in the payload of error events.

◆ AVS_PAYLOAD_ERROR_MESSAGE_KEY

const std::string alexaClientSDK::capabilityAgents::alerts::AVS_PAYLOAD_ERROR_MESSAGE_KEY = "message"

static

The JSON key for the error message in the payload of error events.

◆ AVS_PAYLOAD_ERROR_TYPE_KEY

const std::string alexaClientSDK::capabilityAgents::alerts::AVS_PAYLOAD_ERROR_TYPE_KEY = "type"

static

The JSON key for the error type in the payload of error events.

◆ AVS_PAYLOAD_VOLUME_KEY

const std::string alexaClientSDK::capabilityAgents::alerts::AVS_PAYLOAD_VOLUME_KEY = "volume"

static

The value of the volume state info volume key.

◆ BACKGROUND_ALERT_SOUND_PAUSE_TIME

const auto alexaClientSDK::capabilityAgents::alerts::BACKGROUND_ALERT_SOUND_PAUSE_TIME = std::chrono::seconds(10)

Length of pause of alert sounds when played in background.

◆ DELETE_ALERT

const avsCommon::avs::NamespaceAndName alexaClientSDK::capabilityAgents::alerts::DELETE_ALERT {NAMESPACE, DIRECTIVE_NAME_DELETE_ALERT}

static

The DeleteAlert directive signature.

◆ DELETE_ALERT_FAILED_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::alerts::DELETE_ALERT_FAILED_EVENT_NAME = "DeleteAlertFailed"

static

The value of the DeleteAlertFailed Event name.

◆ DELETE_ALERT_SUCCEEDED_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::alerts::DELETE_ALERT_SUCCEEDED_EVENT_NAME = "DeleteAlertSucceeded"

static

The value of the DeleteAlertSucceeded Event name.

◆ DELETE_ALERTS

const avsCommon::avs::NamespaceAndName alexaClientSDK::capabilityAgents::alerts::DELETE_ALERTS {NAMESPACE, DIRECTIVE_NAME_DELETE_ALERTS}

static

The DeleteAlerts directive signature.

◆ DIRECTIVE_NAME_ADJUST_VOLUME

const std::string alexaClientSDK::capabilityAgents::alerts::DIRECTIVE_NAME_ADJUST_VOLUME = "AdjustVolume"

static

The value of the AdjustVolume Directive.

◆ DIRECTIVE_NAME_DELETE_ALERT

const std::string alexaClientSDK::capabilityAgents::alerts::DIRECTIVE_NAME_DELETE_ALERT = "DeleteAlert"

static

The value of the DeleteAlert Directive.

◆ DIRECTIVE_NAME_DELETE_ALERTS

const std::string alexaClientSDK::capabilityAgents::alerts::DIRECTIVE_NAME_DELETE_ALERTS = "DeleteAlerts"

static

The value of the DeleteAlerts Directive.

◆ DIRECTIVE_NAME_SET_ALARM_VOLUME_RAMP

const std::string alexaClientSDK::capabilityAgents::alerts::DIRECTIVE_NAME_SET_ALARM_VOLUME_RAMP = "SetAlarmVolumeRamp"

static

The value of the SetAlarmVolumeRamp Directive.

◆ DIRECTIVE_NAME_SET_ALERT

const std::string alexaClientSDK::capabilityAgents::alerts::DIRECTIVE_NAME_SET_ALERT = "SetAlert"

static

The value of the SetAlert Directive.

◆ DIRECTIVE_NAME_SET_VOLUME

const std::string alexaClientSDK::capabilityAgents::alerts::DIRECTIVE_NAME_SET_VOLUME = "SetVolume"

static

The value of the SetVolume Directive.

◆ DIRECTIVE_PAYLOAD_ALARM_VOLUME_RAMP

const std::string alexaClientSDK::capabilityAgents::alerts::DIRECTIVE_PAYLOAD_ALARM_VOLUME_RAMP = "alarmVolumeRamp"

static

The value of alarm volume ramp key in a Directive we may receive.

◆ DIRECTIVE_PAYLOAD_TOKEN_KEY

const std::string alexaClientSDK::capabilityAgents::alerts::DIRECTIVE_PAYLOAD_TOKEN_KEY = "token"

static

The value of Token text in a Directive we may receive.

◆ DIRECTIVE_PAYLOAD_TOKENS_KEY

const std::string alexaClientSDK::capabilityAgents::alerts::DIRECTIVE_PAYLOAD_TOKENS_KEY = "tokens"

static

The value of Token list key in a Directive we may receive.

◆ DIRECTIVE_PAYLOAD_VOLUME

const std::string alexaClientSDK::capabilityAgents::alerts::DIRECTIVE_PAYLOAD_VOLUME = "volume"

static

The value of volume key in a Directive we may receive.

◆ EMPTY_DIALOG_REQUEST_ID

const std::string alexaClientSDK::capabilityAgents::alerts::EMPTY_DIALOG_REQUEST_ID = ""

static

An empty dialogRequestId.

◆ EVENT_PAYLOAD_TOKEN_KEY

const std::string alexaClientSDK::capabilityAgents::alerts::EVENT_PAYLOAD_TOKEN_KEY = "token"

static

The value of the event payload key for a single token.

◆ EVENT_PAYLOAD_TOKENS_KEY

const std::string alexaClientSDK::capabilityAgents::alerts::EVENT_PAYLOAD_TOKENS_KEY = "tokens"

static

The value of the event payload key for multiple tokens.

◆ FAILED_SCHEDULE_ALERT

const std::string alexaClientSDK::capabilityAgents::alerts::FAILED_SCHEDULE_ALERT = "failedToScheduleAlert"

static

◆ FAILED_SNOOZE_ALERT

const std::string alexaClientSDK::capabilityAgents::alerts::FAILED_SNOOZE_ALERT = "failedToSnoozeAlert"

static

Metric constants related to Alerts.

◆ INVALID_PAYLOAD_FOR_CHANGE_ALARM_VOLUME

const std::string alexaClientSDK::capabilityAgents::alerts::INVALID_PAYLOAD_FOR_CHANGE_ALARM_VOLUME = "invalidPayloadToChangeAlarmVolume"

static

◆ INVALID_PAYLOAD_FOR_SET_ALARM_VOLUME

const std::string alexaClientSDK::capabilityAgents::alerts::INVALID_PAYLOAD_FOR_SET_ALARM_VOLUME = "invalidPayloadToSetAlarmRamping"

static

◆ KEY_ASSET_ID

const std::string alexaClientSDK::capabilityAgents::alerts::KEY_ASSET_ID = "assetId"

static

String for lookup of the asset id within an asset object in a parsed JSON document.

◆ KEY_ASSET_PLAY_ORDER

const std::string alexaClientSDK::capabilityAgents::alerts::KEY_ASSET_PLAY_ORDER = "assetPlayOrder"

static

String for lookup of the asset play order array in a parsed JSON document.

◆ KEY_ASSET_URL

const std::string alexaClientSDK::capabilityAgents::alerts::KEY_ASSET_URL = "url"

static

String for lookup of the asset url within an asset object in a parsed JSON document.

◆ KEY_ASSETS

const std::string alexaClientSDK::capabilityAgents::alerts::KEY_ASSETS = "assets"

static

String for lookup of the assets array in a parsed JSON document.

◆ KEY_BACKGROUND_ASSET_ID

const std::string alexaClientSDK::capabilityAgents::alerts::KEY_BACKGROUND_ASSET_ID = "backgroundAlertAsset"

static

String for lookup of the backgroundAssetId for an alert, if assets are provided.

◆ KEY_LOOP_COUNT

const std::string alexaClientSDK::capabilityAgents::alerts::KEY_LOOP_COUNT = "loopCount"

static

String for lookup of the loop count value in a parsed JSON document.

◆ KEY_LOOP_PAUSE_IN_MILLISECONDS

const std::string alexaClientSDK::capabilityAgents::alerts::KEY_LOOP_PAUSE_IN_MILLISECONDS = "loopPauseInMilliSeconds"

static

String for lookup of the loop pause in milliseconds value in a parsed JSON document.

◆ KEY_SCHEDULED_TIME

const std::string alexaClientSDK::capabilityAgents::alerts::KEY_SCHEDULED_TIME = "scheduledTime"

static

String for lookup of the scheduled time value in a parsed JSON document.

◆ KEY_TOKEN

const std::string alexaClientSDK::capabilityAgents::alerts::KEY_TOKEN = "token"

static

String for lookup of the token value in a parsed JSON document.

◆ KEY_TYPE

const std::string alexaClientSDK::capabilityAgents::alerts::KEY_TYPE = "type"

static

The value for Type which we need for json parsing.

◆ MAXIMUM_ALERT_RENDERING_TIME

const std::chrono::seconds alexaClientSDK::capabilityAgents::alerts::MAXIMUM_ALERT_RENDERING_TIME = std::chrono::hours(1)

We won't allow an alert to render more than 1 hour.

◆ NAMESPACE

const std::string alexaClientSDK::capabilityAgents::alerts::NAMESPACE = "Alerts"

static

The namespace for this capability agent.

◆ SET_ALARM_VOLUME_RAMP

const avsCommon::avs::NamespaceAndName alexaClientSDK::capabilityAgents::alerts::SET_ALARM_VOLUME_RAMP {NAMESPACE, DIRECTIVE_NAME_SET_ALARM_VOLUME_RAMP}

static

The SetAlarmVolumeRamp directive signature.

◆ SET_ALERT

const avsCommon::avs::NamespaceAndName alexaClientSDK::capabilityAgents::alerts::SET_ALERT {NAMESPACE, DIRECTIVE_NAME_SET_ALERT}

static

The SetAlert directive signature.

◆ SET_ALERT_FAILED_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::alerts::SET_ALERT_FAILED_EVENT_NAME = "SetAlertFailed"

static

The value of the SetAlertFailed Event name.

◆ SET_ALERT_SUCCEEDED_EVENT_NAME

const std::string alexaClientSDK::capabilityAgents::alerts::SET_ALERT_SUCCEEDED_EVENT_NAME = "SetAlertSucceeded"

static

The value of the SetAlertSucceeded Event name.

◆ SET_VOLUME

const avsCommon::avs::NamespaceAndName alexaClientSDK::capabilityAgents::alerts::SET_VOLUME {NAMESPACE, DIRECTIVE_NAME_SET_VOLUME}

static

The SetVolume directive signature.

Namespaces

Classes

Functions

Variables

Function Documentation

◆ buildActiveAlertsContext()

◆ buildAllAlertsContext()

◆ getAlertsCapabilityConfiguration()

◆ hasAsset()

◆ operator<<() [1/4]

◆ operator<<() [2/4]

◆ operator<<() [3/4]

◆ operator<<() [4/4]

◆ parseAlertAssetConfigurationFromJson()

◆ submitMetric()

◆ TAG() [1/3]

◆ TAG() [2/3]

◆ TAG() [3/3]

◆ validateStaticData()

Variable Documentation

◆ ADJUST_VOLUME

◆ ALERT_ALARM_VOLUME_RAMP_CHANGED_EVENT_NAME

◆ ALERT_DELETE_ALERTS_FAILED_EVENT_NAME

◆ ALERT_DELETE_ALERTS_SUCCEEDED_EVENT_NAME

◆ ALERT_ENTERED_BACKGROUND_EVENT_NAME

◆ ALERT_ENTERED_FOREGROUND_EVENT_NAME

◆ ALERT_METRIC_SOURCE_PREFIX

◆ ALERT_PAST_DUE_CUTOFF_MINUTES

◆ ALERT_REPORT_ALARM_VOLUME_RAMP_EVENT_NAME

◆ ALERT_STARTED_EVENT_NAME

◆ ALERT_STOPPED_EVENT_NAME

◆ ALERT_VOLUME_CHANGED_EVENT_NAME

◆ ALERTS_CAPABILITY_INTERFACE_NAME

◆ ALERTS_CAPABILITY_INTERFACE_TYPE

◆ ALERTS_CAPABILITY_INTERFACE_VERSION

◆ AVS_CONTEXT_ACTIVE_ALERTS_TOKEN_KEY

◆ AVS_CONTEXT_ALERT_SCHEDULED_TIME_KEY

◆ AVS_CONTEXT_ALERT_TOKEN_KEY

◆ AVS_CONTEXT_ALERT_TYPE_KEY

◆ AVS_CONTEXT_ALL_ALERTS_TOKEN_KEY

◆ AVS_CONTEXT_HEADER_NAME_VALUE_KEY

◆ AVS_CONTEXT_HEADER_NAMESPACE_VALUE_KEY

◆ AVS_PAYLOAD_ALARM_VOLUME_RAMP_KEY

◆ AVS_PAYLOAD_ERROR_KEY

◆ AVS_PAYLOAD_ERROR_MESSAGE_KEY

◆ AVS_PAYLOAD_ERROR_TYPE_KEY

◆ AVS_PAYLOAD_VOLUME_KEY

◆ BACKGROUND_ALERT_SOUND_PAUSE_TIME

◆ DELETE_ALERT

◆ DELETE_ALERT_FAILED_EVENT_NAME

◆ DELETE_ALERT_SUCCEEDED_EVENT_NAME

◆ DELETE_ALERTS

◆ DIRECTIVE_NAME_ADJUST_VOLUME

◆ DIRECTIVE_NAME_DELETE_ALERT

◆ DIRECTIVE_NAME_DELETE_ALERTS

◆ DIRECTIVE_NAME_SET_ALARM_VOLUME_RAMP

◆ DIRECTIVE_NAME_SET_ALERT

◆ DIRECTIVE_NAME_SET_VOLUME

◆ DIRECTIVE_PAYLOAD_ALARM_VOLUME_RAMP

◆ DIRECTIVE_PAYLOAD_TOKEN_KEY

◆ DIRECTIVE_PAYLOAD_TOKENS_KEY

◆ DIRECTIVE_PAYLOAD_VOLUME

◆ EMPTY_DIALOG_REQUEST_ID

◆ EVENT_PAYLOAD_TOKEN_KEY

◆ EVENT_PAYLOAD_TOKENS_KEY

◆ FAILED_SCHEDULE_ALERT

◆ FAILED_SNOOZE_ALERT

◆ INVALID_PAYLOAD_FOR_CHANGE_ALARM_VOLUME

◆ INVALID_PAYLOAD_FOR_SET_ALARM_VOLUME

◆ KEY_ASSET_ID

◆ KEY_ASSET_PLAY_ORDER

◆ KEY_ASSET_URL

◆ KEY_ASSETS

◆ KEY_BACKGROUND_ASSET_ID

◆ KEY_LOOP_COUNT

◆ KEY_LOOP_PAUSE_IN_MILLISECONDS

◆ KEY_SCHEDULED_TIME

◆ KEY_TOKEN

◆ KEY_TYPE

◆ MAXIMUM_ALERT_RENDERING_TIME