![]() |
Alexa Auto SDK
2.0.0
|
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 () |
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.
|
strong |
Specifies the state of an alert
|
pure virtual |
Notifies the platform implementation of an alert state change
[in] | alertToken | The opaque token that uniquely identifies the alert |
[in] | state | The new alert state |
[in] | reason | The reason for the state change |
|
pure virtual |
Notifies the platform implementation of an alert created, with detailed alert info.
[in] | alertToken | The AVS token of the alert. |
[in] | detailedInfo | The 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. |
|
pure virtual |
Notifies the platform implementation of an alert deleted, with the alertToken.
[in] | alertToken | The AVS token of the alert. |
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.
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