AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Classes | Typedefs | Functions | Variables
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::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)
 
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 validateAssetConfiguration (const Alert::AssetConfiguration &assetConfiguration)
 
static const std::string TAG ("AlertsCapabilityAgent")
 String to identify log entries originating from this file. More...
 
static std::shared_ptr< avsCommon::avs::CapabilityConfigurationgetAlertsCapabilityConfiguration ()
 
static rapidjson::Value buildAllAlertsContext (const std::vector< Alert::ContextInfo > &alertsInfo, Document::AllocatorType &allocator)
 
static std::string currentISO8601TimeUTC ()
 
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 void addGenericMetadata (std::unordered_map< std::string, std::string > &metadata, const std::string &alertToken, const std::string &alertType, bool isConnected, long monotonicTime, const std::string &scheduledTriggerTime, const std::string &actualTriggerTime)
 
static void addAlertStartedRingingMetadata (std::unordered_map< std::string, std::string > &metadata, const std::string &ascending, int volume)
 
static void addAlertCanceledMetadata (std::unordered_map< std::string, std::string > &metadata)
 
static void submitMetricWithMetadata (const std::shared_ptr< MetricRecorderInterface > &metricRecorder, const std::string &eventName, std::unordered_map< std::string, std::string > metadata)
 
static const std::string TAG ("AlertScheduler")
 String to identify log entries originating from this file. More...
 
static void submitMetric (const std::shared_ptr< MetricRecorderInterface > &metricRecorder, const std::string &eventName, int count)
 
std::function< std::shared_ptr< acsdkAlertsInterfaces::AlertsCapabilityAgentInterface > const std::shared_ptr< acsdkAlerts::renderer::Renderer > &, const std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface > &, const std::shared_ptr< avsCommon::sdkInterfaces::AVSConnectionManagerInterface > &, const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &, const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &, const acsdkManufactory::Annotated< avsCommon::sdkInterfaces::AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface > &, const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &, const std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerInterface > &, const std::shared_ptr< avsCommon::sdkInterfaces::audio::AudioFactoryInterface > &, const acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface > &, const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &, const std::shared_ptr< acsdkSystemClockMonitorInterfaces::SystemClockNotifierInterface > &, const std::shared_ptr< certifiedSender::CertifiedSender > &, const std::shared_ptr< registrationManager::CustomerDataManagerInterface > &, const std::shared_ptr< settings::DeviceSettingsManager > &, const std::shared_ptr< storage::AlertStorageInterface > &)> getCreateAlertsCapabilityAgent (bool startAlertSchedulingOnInitialization)
 

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...
 
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.5"
 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 EVENT_PAYLOAD_SCHEDULED_TIME_KEY = "scheduledTime"
 The value of the event payload key for scheduled time. More...
 
static const std::string EVENT_PAYLOAD_EVENT_TIME_KEY = "eventTime"
 The value of the event payload key for event time. 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 OFFLINE_STOPPED_ALERT_TOKEN_KEY = "token"
 The value of the offline stopped alert token key. More...
 
static const std::string OFFLINE_STOPPED_ALERT_SCHEDULED_TIME_KEY = "scheduledTime"
 The value of the offline stopped alert scheduledTime key. More...
 
static const std::string OFFLINE_STOPPED_ALERT_EVENT_TIME_KEY = "eventTime"
 The value of the offline stopped alert eventTime key. More...
 
static const std::string OFFLINE_STOPPED_ALERT_ID_KEY = "id"
 The value of the offline stopped alert id key. 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 ALERT_STARTED_METRIC_NAME = "NotificationStartedRinging"
 Metric names. More...
 
static const std::string ALERT_CANCELED_METRIC_NAME = "NotificationCanceled"
 
static const std::string METRIC_METADATA_TYPE_KEY = "NotificationType"
 Metric metadata keys. More...
 
static const std::string METRIC_METADATA_TOKEN_KEY = "NotificationId"
 
static const std::string METRIC_METADATA_VERSION_KEY = "NotificationMetadataVersion"
 
static const std::string METRIC_METADATA_DEVICE_STATE_KEY = "DeviceState"
 
static const std::string METRIC_METADATA_ACTUAL_TRIGGER_TIME_KEY = "ActualTriggerTime"
 
static const std::string METRIC_METADATA_SCHEDULED_TRIGGER_TIME_KEY = "ScheduledTriggerTime"
 
static const std::string METRIC_METADATA_MONOTONIC_TIME_KEY = "MonotonicTime"
 
static const std::string METRIC_METADATA_IS_ASCENDING_KEY = "IsAscending"
 
static const std::string METRIC_METADATA_ALERT_VOLUME_KEY = "NotificationVolume"
 
static const std::string METRIC_METADATA_IS_QUEUED_KEY = "IsNotificationQueued"
 
static const std::string METRIC_METADATA_CANCELED_REASON_KEY = "CanceledReason"
 
static const int METRIC_METADATA_VERSION_VALUE = 2
 Metric metadata values. More...
 
static const int MILLISECONDS_IN_A_SECOND = 1000
 
static const std::string METRIC_METADATA_IS_QUEUED_VALUE = "false"
 
static const std::string METRIC_METADATA_DEVICE_STATE_ONLINE = "ONLINE"
 
static const std::string METRIC_METADATA_DEVICE_STATE_OFFLINE = "OFFLINE"
 
static const std::string METRIC_METADATA_CANCELED_REASON_VALUE = "TriggerTimeInThePast"
 
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"
 
static const std::string ALERT_RINGING_LESS_THAN_30_PERCENT_MAX_VOLUME
 
static const std::string ALERT_RINGING_ZERO_VOLUME = "alertTriggeredAtZeroAlertVolume"
 
static const int ALERT_VOLUME_METRIC_LIMIT = 30
 
static const std::string ALERT_METRIC_SOURCE_PREFIX = "ALERT-"
 Metric Activity Name Prefix for ALERT metric source. More...
 
static const std::string ALERT_SCHEDULING_FAILED = "alertSchedulingFailed"
 Metric constants related to Alerts. More...
 
static const std::string ALERT_PAST_DUE_DURING_SCHEDULING = "alertpastDueWhileScheduling"
 
static const std::string ACTIVE_ALERT_RELOADED_DURING_SCHEDULING = "activeAlertReloadedDuringScheduling"
 

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::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

◆ addAlertCanceledMetadata()

static void alexaClientSDK::acsdkAlerts::addAlertCanceledMetadata ( std::unordered_map< std::string, std::string > &  metadata)
static

◆ addAlertStartedRingingMetadata()

static void alexaClientSDK::acsdkAlerts::addAlertStartedRingingMetadata ( std::unordered_map< std::string, std::string > &  metadata,
const std::string &  ascending,
int  volume 
)
static

◆ addGenericMetadata()

static void alexaClientSDK::acsdkAlerts::addGenericMetadata ( std::unordered_map< std::string, std::string > &  metadata,
const std::string &  alertToken,
const std::string &  alertType,
bool  isConnected,
long  monotonicTime,
const std::string &  scheduledTriggerTime,
const std::string &  actualTriggerTime 
)
static

◆ buildActiveAlertsContext()

static rapidjson::Value alexaClientSDK::acsdkAlerts::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
alertsInfoThe currently active alert, which may be nullptr if no alert is active.
allocatorThe 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::acsdkAlerts::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
alertsInfoAll the alerts being managed by this Capability Agent.
allocatorThe rapidjson allocator, required for the results of this function to be mergable with other rapidjson::Value objects.
Returns
The rapidjson::Value representing the array.

◆ currentISO8601TimeUTC()

static std::string alexaClientSDK::acsdkAlerts::currentISO8601TimeUTC ( )
static

Generate a UTC ISO8601-formatted timestamp

Returns
UTC ISO8601-formatted timestamp as std::string

◆ getAlertsCapabilityConfiguration()

std::shared_ptr< CapabilityConfiguration > alexaClientSDK::acsdkAlerts::getAlertsCapabilityConfiguration ( )
static

Creates the alerts capability configuration.

Returns
The alerts capability configuration.

◆ getComponent()

AlertsComponent alexaClientSDK::acsdkAlerts::getComponent ( bool  startAlertSchedulingOnInitialization = true)

Get the manufactory Component for an Alerts Capability Agent.

Parameters
startAlertSchedulingOnInitializationWhether 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.

◆ getCreateAlertsCapabilityAgent()

std::function<std::shared_ptr<acsdkAlertsInterfaces::AlertsCapabilityAgentInterface> const std::shared_ptr<acsdkAlerts::renderer::Renderer>&, const std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownNotifierInterface>&, const std::shared_ptr<avsCommon::sdkInterfaces::AVSConnectionManagerInterface>&, const std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface>&, const std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface>&, const acsdkManufactory:: Annotated<avsCommon::sdkInterfaces::AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface>&, const std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface>&, const std::shared_ptr<avsCommon::sdkInterfaces::SpeakerManagerInterface>&, const std::shared_ptr<avsCommon::sdkInterfaces::audio::AudioFactoryInterface>&, const acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface>&, const std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface>&, const std::shared_ptr<acsdkSystemClockMonitorInterfaces::SystemClockNotifierInterface>&, const std::shared_ptr<certifiedSender::CertifiedSender>&, const std::shared_ptr<registrationManager::CustomerDataManagerInterface>&, const std::shared_ptr<settings::DeviceSettingsManager>&, const std::shared_ptr<storage::AlertStorageInterface>&)> alexaClientSDK::acsdkAlerts::getCreateAlertsCapabilityAgent ( bool  startAlertSchedulingOnInitialization)

Forwards startAlertSchedulingOnInitialization to the Alert CA's factory method.

Parameters
startAlertSchedulingOnInitializationWhether to start scheduling alerts after client initialization. If this is set to false, no alert scheduling will occur until onSystemClockSynchronized is called.
Returns
A std::function factory method for the Alerts CA.

◆ hasAsset()

static bool alexaClientSDK::acsdkAlerts::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
keyThe key to search in the assets map
assetsThe 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/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
streamThe stream to write the value to.
stateThe 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
streamThe stream to write the value to.
reasonThe 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
streamThe stream to write the value to.
statusThe 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::acsdkAlerts::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
payloadThe pre-parsed rapidjson::Value.
[out]assetConfigurationAn output parameter where the assets will be stored if parsed successfully.
Returns
The status of the parse.

◆ submitMetric() [1/2]

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

Submits a metric for a given count and name

Parameters
metricRecorderThe MetricRecorderInterface which records Metric events
eventNameThe name of the metric event
countThe count for metric event

◆ submitMetric() [2/2]

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

Submits a metric for a given count and name

Parameters
metricRecorderThe MetricRecorderInterface which records Metric events
eventNameThe name of the metric event
countThe count for metric event

◆ submitMetricWithMetadata()

static void alexaClientSDK::acsdkAlerts::submitMetricWithMetadata ( const std::shared_ptr< MetricRecorderInterface > &  metricRecorder,
const std::string &  eventName,
std::unordered_map< std::string, std::string >  metadata 
)
static

◆ TAG() [1/3]

static const std::string alexaClientSDK::acsdkAlerts::TAG ( "AlertScheduler"  )
static

String to identify log entries originating from this file.

◆ TAG() [2/3]

static const std::string alexaClientSDK::acsdkAlerts::TAG ( "Alert"  )
static

String to identify log entries originating from this file.

◆ TAG() [3/3]

static const std::string alexaClientSDK::acsdkAlerts::TAG ( "AlertsCapabilityAgent"  )
static

String to identify log entries originating from this file.

◆ validateAssetConfiguration()

static bool alexaClientSDK::acsdkAlerts::validateAssetConfiguration ( const Alert::AssetConfiguration assetConfiguration)
static

Validates asset configuration

Parameters
assetConfigurationThe Asset Configuration
Returns
true if the data is valid

Variable Documentation

◆ ACTIVE_ALERT_RELOADED_DURING_SCHEDULING

const std::string alexaClientSDK::acsdkAlerts::ACTIVE_ALERT_RELOADED_DURING_SCHEDULING = "activeAlertReloadedDuringScheduling"
static

◆ ADJUST_VOLUME

const avsCommon::avs::NamespaceAndName alexaClientSDK::acsdkAlerts::ADJUST_VOLUME {NAMESPACE, DIRECTIVE_NAME_ADJUST_VOLUME}
static

The AdjustVolume directive signature.

◆ ALERT_ALARM_VOLUME_RAMP_CHANGED_EVENT_NAME

const std::string alexaClientSDK::acsdkAlerts::ALERT_ALARM_VOLUME_RAMP_CHANGED_EVENT_NAME = "AlarmVolumeRampChanged"
static

The value of the AlarmVolumeRampChanged Event name.

◆ ALERT_CANCELED_METRIC_NAME

const std::string alexaClientSDK::acsdkAlerts::ALERT_CANCELED_METRIC_NAME = "NotificationCanceled"
static

◆ ALERT_DELETE_ALERTS_FAILED_EVENT_NAME

const std::string alexaClientSDK::acsdkAlerts::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::acsdkAlerts::ALERT_DELETE_ALERTS_SUCCEEDED_EVENT_NAME = "DeleteAlertsSucceeded"
static

The value of the DeleteAlertsSucceeded Event name.

◆ ALERT_ENTERED_BACKGROUND_EVENT_NAME

const std::string alexaClientSDK::acsdkAlerts::ALERT_ENTERED_BACKGROUND_EVENT_NAME = "AlertEnteredBackground"
static

The value of the AlertEnteredBackground Event name.

◆ ALERT_ENTERED_FOREGROUND_EVENT_NAME

const std::string alexaClientSDK::acsdkAlerts::ALERT_ENTERED_FOREGROUND_EVENT_NAME = "AlertEnteredForeground"
static

The value of the AlertEnteredForeground Event name.

◆ ALERT_METRIC_SOURCE_PREFIX [1/2]

const std::string alexaClientSDK::acsdkAlerts::ALERT_METRIC_SOURCE_PREFIX = "ALERT-"
static

Metric Activity Name Prefix for ALERT metric source.

◆ ALERT_METRIC_SOURCE_PREFIX [2/2]

const std::string alexaClientSDK::acsdkAlerts::ALERT_METRIC_SOURCE_PREFIX = "ALERT-"
static

Metric Activity Name Prefix for ALERT metric source.

◆ ALERT_PAST_DUE_CUTOFF_MINUTES

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

◆ ALERT_PAST_DUE_DURING_SCHEDULING

const std::string alexaClientSDK::acsdkAlerts::ALERT_PAST_DUE_DURING_SCHEDULING = "alertpastDueWhileScheduling"
static

◆ ALERT_REPORT_ALARM_VOLUME_RAMP_EVENT_NAME

const std::string alexaClientSDK::acsdkAlerts::ALERT_REPORT_ALARM_VOLUME_RAMP_EVENT_NAME = "AlarmVolumeRampReport"
static

The value of the ReportAlarmVolumeRamp Event name.

◆ ALERT_RINGING_LESS_THAN_30_PERCENT_MAX_VOLUME

const std::string alexaClientSDK::acsdkAlerts::ALERT_RINGING_LESS_THAN_30_PERCENT_MAX_VOLUME
static
Initial value:
=
"alertTriggeredAtLessThan30PercentMaxAlertVolume"

◆ ALERT_RINGING_ZERO_VOLUME

const std::string alexaClientSDK::acsdkAlerts::ALERT_RINGING_ZERO_VOLUME = "alertTriggeredAtZeroAlertVolume"
static

◆ ALERT_SCHEDULING_FAILED

const std::string alexaClientSDK::acsdkAlerts::ALERT_SCHEDULING_FAILED = "alertSchedulingFailed"
static

Metric constants related to Alerts.

◆ ALERT_STARTED_EVENT_NAME

const std::string alexaClientSDK::acsdkAlerts::ALERT_STARTED_EVENT_NAME = "AlertStarted"
static

The value of the AlertStarted Event name.

◆ ALERT_STARTED_METRIC_NAME

const std::string alexaClientSDK::acsdkAlerts::ALERT_STARTED_METRIC_NAME = "NotificationStartedRinging"
static

Metric names.

◆ ALERT_STOPPED_EVENT_NAME

const std::string alexaClientSDK::acsdkAlerts::ALERT_STOPPED_EVENT_NAME = "AlertStopped"
static

The value of the AlertStopped Event name.

◆ ALERT_VOLUME_CHANGED_EVENT_NAME

const std::string alexaClientSDK::acsdkAlerts::ALERT_VOLUME_CHANGED_EVENT_NAME = "VolumeChanged"
static

The value of the VolumeChanged Event name.

◆ ALERT_VOLUME_METRIC_LIMIT

const int alexaClientSDK::acsdkAlerts::ALERT_VOLUME_METRIC_LIMIT = 30
static

◆ ALERTS_CAPABILITY_INTERFACE_NAME

const std::string alexaClientSDK::acsdkAlerts::ALERTS_CAPABILITY_INTERFACE_NAME = "Alerts"
static

Alerts interface name.

◆ ALERTS_CAPABILITY_INTERFACE_TYPE

const std::string alexaClientSDK::acsdkAlerts::ALERTS_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"
static

Alerts capability constants Alerts interface type

◆ ALERTS_CAPABILITY_INTERFACE_VERSION

const std::string alexaClientSDK::acsdkAlerts::ALERTS_CAPABILITY_INTERFACE_VERSION = "1.5"
static

Alerts interface version.

◆ 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.

◆ AVS_CONTEXT_ACTIVE_ALERTS_TOKEN_KEY

const std::string alexaClientSDK::acsdkAlerts::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::acsdkAlerts::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::acsdkAlerts::AVS_CONTEXT_ALERT_TOKEN_KEY = "token"
static

The value of the Alerts Context token key.

◆ AVS_CONTEXT_ALERT_TYPE_KEY

const std::string alexaClientSDK::acsdkAlerts::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::acsdkAlerts::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::acsdkAlerts::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::acsdkAlerts::AVS_CONTEXT_HEADER_NAMESPACE_VALUE_KEY = "Alerts"
static

◆ AVS_PAYLOAD_ALARM_VOLUME_RAMP_KEY

const std::string alexaClientSDK::acsdkAlerts::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::acsdkAlerts::AVS_PAYLOAD_ERROR_KEY = "error"
static

The JSON key in the payload of error events.

◆ AVS_PAYLOAD_ERROR_MESSAGE_KEY

const std::string alexaClientSDK::acsdkAlerts::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::acsdkAlerts::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::acsdkAlerts::AVS_PAYLOAD_VOLUME_KEY = "volume"
static

The value of the volume state info volume key.

◆ BACKGROUND_ALERT_SOUND_PAUSE_TIME

const auto alexaClientSDK::acsdkAlerts::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::acsdkAlerts::DELETE_ALERT {NAMESPACE, DIRECTIVE_NAME_DELETE_ALERT}
static

The DeleteAlert directive signature.

◆ DELETE_ALERT_FAILED_EVENT_NAME

const std::string alexaClientSDK::acsdkAlerts::DELETE_ALERT_FAILED_EVENT_NAME = "DeleteAlertFailed"
static

The value of the DeleteAlertFailed Event name.

◆ DELETE_ALERT_SUCCEEDED_EVENT_NAME

const std::string alexaClientSDK::acsdkAlerts::DELETE_ALERT_SUCCEEDED_EVENT_NAME = "DeleteAlertSucceeded"
static

The value of the DeleteAlertSucceeded Event name.

◆ DELETE_ALERTS

const avsCommon::avs::NamespaceAndName alexaClientSDK::acsdkAlerts::DELETE_ALERTS {NAMESPACE, DIRECTIVE_NAME_DELETE_ALERTS}
static

The DeleteAlerts directive signature.

◆ DIRECTIVE_NAME_ADJUST_VOLUME

const std::string alexaClientSDK::acsdkAlerts::DIRECTIVE_NAME_ADJUST_VOLUME = "AdjustVolume"
static

The value of the AdjustVolume Directive.

◆ DIRECTIVE_NAME_DELETE_ALERT

const std::string alexaClientSDK::acsdkAlerts::DIRECTIVE_NAME_DELETE_ALERT = "DeleteAlert"
static

The value of the DeleteAlert Directive.

◆ DIRECTIVE_NAME_DELETE_ALERTS

const std::string alexaClientSDK::acsdkAlerts::DIRECTIVE_NAME_DELETE_ALERTS = "DeleteAlerts"
static

The value of the DeleteAlerts Directive.

◆ DIRECTIVE_NAME_SET_ALARM_VOLUME_RAMP

const std::string alexaClientSDK::acsdkAlerts::DIRECTIVE_NAME_SET_ALARM_VOLUME_RAMP = "SetAlarmVolumeRamp"
static

The value of the SetAlarmVolumeRamp Directive.

◆ DIRECTIVE_NAME_SET_ALERT

const std::string alexaClientSDK::acsdkAlerts::DIRECTIVE_NAME_SET_ALERT = "SetAlert"
static

The value of the SetAlert Directive.

◆ DIRECTIVE_NAME_SET_VOLUME

const std::string alexaClientSDK::acsdkAlerts::DIRECTIVE_NAME_SET_VOLUME = "SetVolume"
static

The value of the SetVolume Directive.

◆ DIRECTIVE_PAYLOAD_ALARM_VOLUME_RAMP

const std::string alexaClientSDK::acsdkAlerts::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::acsdkAlerts::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::acsdkAlerts::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::acsdkAlerts::DIRECTIVE_PAYLOAD_VOLUME = "volume"
static

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

◆ EMPTY_DIALOG_REQUEST_ID

const std::string alexaClientSDK::acsdkAlerts::EMPTY_DIALOG_REQUEST_ID = ""
static

An empty dialogRequestId.

◆ EVENT_PAYLOAD_EVENT_TIME_KEY

const std::string alexaClientSDK::acsdkAlerts::EVENT_PAYLOAD_EVENT_TIME_KEY = "eventTime"
static

The value of the event payload key for event time.

◆ EVENT_PAYLOAD_SCHEDULED_TIME_KEY

const std::string alexaClientSDK::acsdkAlerts::EVENT_PAYLOAD_SCHEDULED_TIME_KEY = "scheduledTime"
static

The value of the event payload key for scheduled time.

◆ EVENT_PAYLOAD_TOKEN_KEY

const std::string alexaClientSDK::acsdkAlerts::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::acsdkAlerts::EVENT_PAYLOAD_TOKENS_KEY = "tokens"
static

The value of the event payload key for multiple tokens.

◆ FAILED_SCHEDULE_ALERT

const std::string alexaClientSDK::acsdkAlerts::FAILED_SCHEDULE_ALERT = "failedToScheduleAlert"
static

◆ FAILED_SNOOZE_ALERT

const std::string alexaClientSDK::acsdkAlerts::FAILED_SNOOZE_ALERT = "failedToSnoozeAlert"
static

Metric constants related to Alerts.

◆ INVALID_PAYLOAD_FOR_CHANGE_ALARM_VOLUME

const std::string alexaClientSDK::acsdkAlerts::INVALID_PAYLOAD_FOR_CHANGE_ALARM_VOLUME = "invalidPayloadToChangeAlarmVolume"
static

◆ INVALID_PAYLOAD_FOR_SET_ALARM_VOLUME

const std::string alexaClientSDK::acsdkAlerts::INVALID_PAYLOAD_FOR_SET_ALARM_VOLUME = "invalidPayloadToSetAlarmRamping"
static

◆ KEY_ASSET_ID

const std::string alexaClientSDK::acsdkAlerts::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::acsdkAlerts::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::acsdkAlerts::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::acsdkAlerts::KEY_ASSETS = "assets"
static

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

◆ KEY_BACKGROUND_ASSET_ID

const std::string alexaClientSDK::acsdkAlerts::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::acsdkAlerts::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::acsdkAlerts::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::acsdkAlerts::KEY_SCHEDULED_TIME = "scheduledTime"
static

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

◆ KEY_TOKEN

const std::string alexaClientSDK::acsdkAlerts::KEY_TOKEN = "token"
static

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

◆ KEY_TYPE

const std::string alexaClientSDK::acsdkAlerts::KEY_TYPE = "type"
static

The value for Type which we need for json parsing.

◆ MAXIMUM_ALERT_RENDERING_TIME

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

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

◆ METRIC_METADATA_ACTUAL_TRIGGER_TIME_KEY

const std::string alexaClientSDK::acsdkAlerts::METRIC_METADATA_ACTUAL_TRIGGER_TIME_KEY = "ActualTriggerTime"
static

◆ METRIC_METADATA_ALERT_VOLUME_KEY

const std::string alexaClientSDK::acsdkAlerts::METRIC_METADATA_ALERT_VOLUME_KEY = "NotificationVolume"
static

◆ METRIC_METADATA_CANCELED_REASON_KEY

const std::string alexaClientSDK::acsdkAlerts::METRIC_METADATA_CANCELED_REASON_KEY = "CanceledReason"
static

◆ METRIC_METADATA_CANCELED_REASON_VALUE

const std::string alexaClientSDK::acsdkAlerts::METRIC_METADATA_CANCELED_REASON_VALUE = "TriggerTimeInThePast"
static

◆ METRIC_METADATA_DEVICE_STATE_KEY

const std::string alexaClientSDK::acsdkAlerts::METRIC_METADATA_DEVICE_STATE_KEY = "DeviceState"
static

◆ METRIC_METADATA_DEVICE_STATE_OFFLINE

const std::string alexaClientSDK::acsdkAlerts::METRIC_METADATA_DEVICE_STATE_OFFLINE = "OFFLINE"
static

◆ METRIC_METADATA_DEVICE_STATE_ONLINE

const std::string alexaClientSDK::acsdkAlerts::METRIC_METADATA_DEVICE_STATE_ONLINE = "ONLINE"
static

◆ METRIC_METADATA_IS_ASCENDING_KEY

const std::string alexaClientSDK::acsdkAlerts::METRIC_METADATA_IS_ASCENDING_KEY = "IsAscending"
static

◆ METRIC_METADATA_IS_QUEUED_KEY

const std::string alexaClientSDK::acsdkAlerts::METRIC_METADATA_IS_QUEUED_KEY = "IsNotificationQueued"
static

◆ METRIC_METADATA_IS_QUEUED_VALUE

const std::string alexaClientSDK::acsdkAlerts::METRIC_METADATA_IS_QUEUED_VALUE = "false"
static

◆ METRIC_METADATA_MONOTONIC_TIME_KEY

const std::string alexaClientSDK::acsdkAlerts::METRIC_METADATA_MONOTONIC_TIME_KEY = "MonotonicTime"
static

◆ METRIC_METADATA_SCHEDULED_TRIGGER_TIME_KEY

const std::string alexaClientSDK::acsdkAlerts::METRIC_METADATA_SCHEDULED_TRIGGER_TIME_KEY = "ScheduledTriggerTime"
static

◆ METRIC_METADATA_TOKEN_KEY

const std::string alexaClientSDK::acsdkAlerts::METRIC_METADATA_TOKEN_KEY = "NotificationId"
static

◆ METRIC_METADATA_TYPE_KEY

const std::string alexaClientSDK::acsdkAlerts::METRIC_METADATA_TYPE_KEY = "NotificationType"
static

Metric metadata keys.

◆ METRIC_METADATA_VERSION_KEY

const std::string alexaClientSDK::acsdkAlerts::METRIC_METADATA_VERSION_KEY = "NotificationMetadataVersion"
static

◆ METRIC_METADATA_VERSION_VALUE

const int alexaClientSDK::acsdkAlerts::METRIC_METADATA_VERSION_VALUE = 2
static

Metric metadata values.

◆ MILLISECONDS_IN_A_SECOND

const int alexaClientSDK::acsdkAlerts::MILLISECONDS_IN_A_SECOND = 1000
static

◆ NAMESPACE

const std::string alexaClientSDK::acsdkAlerts::NAMESPACE = "Alerts"
static

The namespace for this capability agent.

◆ OFFLINE_STOPPED_ALERT_EVENT_TIME_KEY

const std::string alexaClientSDK::acsdkAlerts::OFFLINE_STOPPED_ALERT_EVENT_TIME_KEY = "eventTime"
static

The value of the offline stopped alert eventTime key.

◆ OFFLINE_STOPPED_ALERT_ID_KEY

const std::string alexaClientSDK::acsdkAlerts::OFFLINE_STOPPED_ALERT_ID_KEY = "id"
static

The value of the offline stopped alert id key.

◆ OFFLINE_STOPPED_ALERT_SCHEDULED_TIME_KEY

const std::string alexaClientSDK::acsdkAlerts::OFFLINE_STOPPED_ALERT_SCHEDULED_TIME_KEY = "scheduledTime"
static

The value of the offline stopped alert scheduledTime key.

◆ OFFLINE_STOPPED_ALERT_TOKEN_KEY

const std::string alexaClientSDK::acsdkAlerts::OFFLINE_STOPPED_ALERT_TOKEN_KEY = "token"
static

The value of the offline stopped alert token key.

◆ SET_ALARM_VOLUME_RAMP

const avsCommon::avs::NamespaceAndName alexaClientSDK::acsdkAlerts::SET_ALARM_VOLUME_RAMP {NAMESPACE, DIRECTIVE_NAME_SET_ALARM_VOLUME_RAMP}
static

The SetAlarmVolumeRamp directive signature.

◆ SET_ALERT

const avsCommon::avs::NamespaceAndName alexaClientSDK::acsdkAlerts::SET_ALERT {NAMESPACE, DIRECTIVE_NAME_SET_ALERT}
static

The SetAlert directive signature.

◆ SET_ALERT_FAILED_EVENT_NAME

const std::string alexaClientSDK::acsdkAlerts::SET_ALERT_FAILED_EVENT_NAME = "SetAlertFailed"
static

The value of the SetAlertFailed Event name.

◆ SET_ALERT_SUCCEEDED_EVENT_NAME

const std::string alexaClientSDK::acsdkAlerts::SET_ALERT_SUCCEEDED_EVENT_NAME = "SetAlertSucceeded"
static

The value of the SetAlertSucceeded Event name.

◆ SET_VOLUME

const avsCommon::avs::NamespaceAndName alexaClientSDK::acsdkAlerts::SET_VOLUME {NAMESPACE, DIRECTIVE_NAME_SET_VOLUME}
static

The SetVolume directive signature.

AlexaClientSDK 1.25.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0