Alexa Auto SDK  2.0.0
Classes | Public Member Functions | List of all members
com.amazon.aace.alexa.Alerts Class Reference

Classes

enum  AlertState
 

Public Member Functions

void alertStateChanged (String alertToken, AlertState state, String reason)
 
void alertCreated (String alertToken, String detailedInfo)
 
void alertDeleted (String alertToken)
 
final void localStop ()
 
final 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.

Member Function Documentation

◆ alertStateChanged()

void com.amazon.aace.alexa.Alerts.alertStateChanged ( String  alertToken,
AlertState  state,
String  reason 
)

Notifies the platform implementation of an alert state change

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

◆ alertCreated()

void com.amazon.aace.alexa.Alerts.alertCreated ( String  alertToken,
String  detailedInfo 
)

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

Parameters
alertTokenThe AVS token of the alert.
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()

void com.amazon.aace.alexa.Alerts.alertDeleted ( String  alertToken)

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

Parameters
alertTokenThe AVS token of the alert.

◆ localStop()

final void com.amazon.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()

final void com.amazon.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