#include <AlertObserverInterface.h>

Collaboration diagram for alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface::AlertInfo:

Public Member Functions
	AlertInfo (const std::string &token, const Type type, const State state, const std::chrono::system_clock::time_point &scheduledTime, const avsCommon::utils::Optional< OriginalTime > &originalTime=avsCommon::utils::Optional< OriginalTime >(), const avsCommon::utils::Optional< std::string > &label=avsCommon::utils::Optional< std::string >(), const std::string &reason="")

Public Attributes
std::string	token
	An opaque token that uniquely identifies the alert. More...

Type	type
	The type of the alert. More...

State	state
	The state of the alert. More...

std::chrono::system_clock::time_point	scheduledTime
	UTC timestamp for when the alert is scheduled. More...

avsCommon::utils::Optional< OriginalTime >	originalTime

avsCommon::utils::Optional< std::string >	label
	An optional label for the content of an alert. More...

std::string	reason
	The reason for the state change. More...

Detailed Description

This struct includes the information of an alert. Note that attributes originalTime and label reflect the optional fields in the SetAlert directive.

See also: https://developer.amazon.com/en-US/docs/alexa/alexa-voice-service/alerts.html Refer to documentation of OriginalTime struct for details about originalTime. Attribute label includes the content of the alert. For example, when the user creates a named timer "Alexa, set a coffee timer for 3 minutes", "coffee" would be the label of the timer. When the user create a regular timer "Alexa, set a timer for 3 minutes", the label field would be empty in SetAlert directive. The label attribute can be used for display purpose on a screen-based device, e.g. showing the label of the timer on an alert ringing screen.

Constructor & Destructor Documentation

◆ AlertInfo()

alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface::AlertInfo::AlertInfo	(	const std::string &	token,
		const Type	type,
		const State	state,
		const std::chrono::system_clock::time_point &	scheduledTime,
		const avsCommon::utils::Optional< OriginalTime > &	originalTime = `avsCommon::utils::Optional<OriginalTime>()`,
		const avsCommon::utils::Optional< std::string > &	label = `avsCommon::utils::Optional<std::string>()`,
		const std::string &	reason = `""`
	)

inline

Constructor.

Parameters

token	An opaque token that uniquely identifies the alert.
type	The type of the alert.
state	The state of the alert.
scheduledTime	The UTC timestamp for when the alert is scheduled.
originalTime	An optional `OriginalTime` for the local time when the alert was originally set.
label	An optional label for the content of an alert.
reason	The reason for the state change.

Member Data Documentation

◆ label

avsCommon::utils::Optional<std::string> alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface::AlertInfo::label

An optional label for the content of an alert.

◆ originalTime

avsCommon::utils::Optional<OriginalTime> alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface::AlertInfo::originalTime

An optional OriginalTime for the local time when the alert was originally set. This value remains unchanged when the alert is snoozed.

◆ reason

std::string alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface::AlertInfo::reason

The reason for the state change.

◆ scheduledTime

std::chrono::system_clock::time_point alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface::AlertInfo::scheduledTime

UTC timestamp for when the alert is scheduled.

◆ state

State alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface::AlertInfo::state

The state of the alert.

◆ token

std::string alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface::AlertInfo::token

An opaque token that uniquely identifies the alert.

◆ type

Type alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface::AlertInfo::type

The type of the alert.

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

/workplace/avs-device-sdk/capabilities/Alerts/acsdkAlertsInterfaces/include/acsdkAlertsInterfaces/AlertObserverInterface.h

Public Member Functions

Public Attributes