Alexa Auto SDK  2.0.0
Public Types | Public Member Functions | List of all members
aace::alexa::Alerts Class Referenceabstract

Public Types

enum  AlertState {
  AlertState::READY,
  AlertState::STARTED,
  AlertState::STOPPED,
  AlertState::SNOOZED,
  AlertState::COMPLETED,
  AlertState::PAST_DUE,
  AlertState::FOCUS_ENTERED_FOREGROUND,
  AlertState::FOCUS_ENTERED_BACKGROUND,
  AlertState::ERROR
}
 

Public Member Functions

virtual void alertStateChanged (const std::string &alertToken, AlertState state, const std::string &reason)=0
 
virtual void alertCreated (const std::string &alertToken, const std::string &detailedInfo)=0
 
virtual void alertDeleted (const std::string &alertToken)=0
 
void localStop ()
 
void removeAllAlerts ()
 

Detailed Description

Alerts should be extended to handle alerts (e.g. timers, alarms, reminders) from AVS.

The platform implementation is responsible for rendering visual cues for an active alert. The Alerts MediaPlayer will receive directives from the Engine to handle alerts audio playback.

See also
AudioChannel

Member Enumeration Documentation

◆ AlertState

Specifies the state of an alert

Enumerator
READY 

The alert is ready to activate and is waiting for channel focus.

STARTED 

The alert is activated, and rendering is perceivable by the user.

STOPPED 

The alert has stopped due to user or system intervention.

SNOOZED 

The alert is active but has been snoozed.

COMPLETED 

The alert has completed on its own, without user interaction.

PAST_DUE 

The alert has expired and will not be rendered.

FOCUS_ENTERED_FOREGROUND 

The alert has entered the foreground.

FOCUS_ENTERED_BACKGROUND 

The alert has entered the background.

ERROR 

The alert has encountered an error.

Member Function Documentation

◆ alertStateChanged()

virtual void aace::alexa::Alerts::alertStateChanged ( const std::string &  alertToken,
AlertState  state,
const std::string &  reason 
)
pure virtual

Notifies the platform implementation of an alert state change

Parameters
[in]alertTokenThe opaque token that uniquely identifies the alert
[in]stateThe new alert state
[in]reasonThe reason for the state change

◆ alertCreated()

virtual void aace::alexa::Alerts::alertCreated ( const std::string &  alertToken,
const std::string &  detailedInfo 
)
pure virtual

Notifies the platform implementation of an alert created, with detailed alert info.

Parameters
[in]alertTokenThe AVS token of the alert.
[in]detailedInfoThe alert info payload : { "time" : <String> "type" : <String> "label" : <String> } time The time string ( Scheduled Time ISO_8601 ). type The type of the alert ( ALERT, REMINDER, TIMER ). label The label of the TIMER, description for REMINDER, or empty string for ALARM.

◆ alertDeleted()

virtual void aace::alexa::Alerts::alertDeleted ( const std::string &  alertToken)
pure virtual

Notifies the platform implementation of an alert deleted, with the alertToken.

Parameters
[in]alertTokenThe AVS token of the alert.

◆ localStop()

void aace::alexa::Alerts::localStop ( )

Notifies the Engine of a platform request to stop any active alert, such as when a user presses a physical 'stop' button.

◆ removeAllAlerts()

void aace::alexa::Alerts::removeAllAlerts ( )

Notifies the Engine of a platform request to clear the user's pending alerts from storage. This may be useful for a scenario in which a user's pending alerts should not go off after he logs out of the application.


Alexa Auto SDK 2.0.0 - Copyright 2017-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0