forked from alexa/alexa-auto-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassaace_1_1alexa_1_1_alerts.html
263 lines (253 loc) · 15.7 KB
/
classaace_1_1alexa_1_1_alerts.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Alexa Auto SDK: aace::alexa::Alerts Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="aace-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Alexa Auto SDK
 <span id="projectnumber">1.0.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>aace</b></li><li class="navelem"><b>alexa</b></li><li class="navelem"><a class="el" href="classaace_1_1alexa_1_1_alerts.html">Alerts</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classaace_1_1alexa_1_1_alerts-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">aace::alexa::Alerts Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a81cccb7e632cf26b7903d9c9c168fb22"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1alexa_1_1_alerts.html#a81cccb7e632cf26b7903d9c9c168fb22">AlertState</a> { <br />
  <a class="el" href="classaace_1_1alexa_1_1_alerts.html#a81cccb7e632cf26b7903d9c9c168fb22a2baa69eafc7204f3bd8648eba580c489">AlertState::READY</a>,
<br />
  <a class="el" href="classaace_1_1alexa_1_1_alerts.html#a81cccb7e632cf26b7903d9c9c168fb22a17130e6c806885e23770df1519b18eb7">AlertState::STARTED</a>,
<br />
  <a class="el" href="classaace_1_1alexa_1_1_alerts.html#a81cccb7e632cf26b7903d9c9c168fb22a09d4d696b4e935115b9313e3c412509a">AlertState::STOPPED</a>,
<br />
  <a class="el" href="classaace_1_1alexa_1_1_alerts.html#a81cccb7e632cf26b7903d9c9c168fb22adbd414f9aaabb67e8430e9520f604a79">AlertState::SNOOZED</a>,
<br />
  <a class="el" href="classaace_1_1alexa_1_1_alerts.html#a81cccb7e632cf26b7903d9c9c168fb22a8f7afecbc8fbc4cd0f50a57d1172482e">AlertState::COMPLETED</a>,
<br />
  <a class="el" href="classaace_1_1alexa_1_1_alerts.html#a81cccb7e632cf26b7903d9c9c168fb22a560bb2d9ea9002aa8c70a4462ca6c304">AlertState::PAST_DUE</a>,
<br />
  <a class="el" href="classaace_1_1alexa_1_1_alerts.html#a81cccb7e632cf26b7903d9c9c168fb22aa72d9c6d4fab6a8bb2fcc8fe3f7dff13">AlertState::FOCUS_ENTERED_FOREGROUND</a>,
<br />
  <a class="el" href="classaace_1_1alexa_1_1_alerts.html#a81cccb7e632cf26b7903d9c9c168fb22a8f2c39a6e3871da5c682a37a792a6b05">AlertState::FOCUS_ENTERED_BACKGROUND</a>,
<br />
  <a class="el" href="classaace_1_1alexa_1_1_alerts.html#a81cccb7e632cf26b7903d9c9c168fb22abb1ca97ec761fc37101737ba0aa2e7c5">AlertState::ERROR</a>
<br />
}</td></tr>
<tr class="separator:a81cccb7e632cf26b7903d9c9c168fb22"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:afc6cb0b2755cf2d90d50b070dec0162e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1alexa_1_1_alerts.html#afc6cb0b2755cf2d90d50b070dec0162e">alertStateChanged</a> (const std::string &alertToken, <a class="el" href="classaace_1_1alexa_1_1_alerts.html#a81cccb7e632cf26b7903d9c9c168fb22">AlertState</a> state, const std::string &reason)=0</td></tr>
<tr class="separator:afc6cb0b2755cf2d90d50b070dec0162e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ad3204360a08a578af1af59013f64a8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1alexa_1_1_alerts.html#a0ad3204360a08a578af1af59013f64a8">localStop</a> ()</td></tr>
<tr class="separator:a0ad3204360a08a578af1af59013f64a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a48eea8459c5a5c42819fb4fcd155ff89"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1alexa_1_1_alerts.html#a48eea8459c5a5c42819fb4fcd155ff89">removeAllAlerts</a> ()</td></tr>
<tr class="separator:a48eea8459c5a5c42819fb4fcd155ff89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classaace_1_1alexa_1_1_audio_channel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classaace_1_1alexa_1_1_audio_channel')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classaace_1_1alexa_1_1_audio_channel.html">aace::alexa::AudioChannel</a></td></tr>
<tr class="memitem:a6850227818b02b670e6beaa3dee00528 inherit pub_methods_classaace_1_1alexa_1_1_audio_channel"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classaace_1_1alexa_1_1_media_player.html">aace::alexa::MediaPlayer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1alexa_1_1_audio_channel.html#a6850227818b02b670e6beaa3dee00528">getMediaPlayer</a> ()</td></tr>
<tr class="separator:a6850227818b02b670e6beaa3dee00528 inherit pub_methods_classaace_1_1alexa_1_1_audio_channel"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ac3e6fb25db1e8af5dfb842ae1732a8 inherit pub_methods_classaace_1_1alexa_1_1_audio_channel"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classaace_1_1alexa_1_1_speaker.html">aace::alexa::Speaker</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1alexa_1_1_audio_channel.html#a5ac3e6fb25db1e8af5dfb842ae1732a8">getSpeaker</a> ()</td></tr>
<tr class="separator:a5ac3e6fb25db1e8af5dfb842ae1732a8 inherit pub_methods_classaace_1_1alexa_1_1_audio_channel"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b5807596680eb47671eaa5313da4e0d inherit pub_methods_classaace_1_1alexa_1_1_audio_channel"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classaace_1_1alexa_1_1_speaker.html#ae11df0cc137eb21d1c762303e0f7158e">aace::alexa::Speaker::Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1alexa_1_1_audio_channel.html#a4b5807596680eb47671eaa5313da4e0d">getSpeakerType</a> ()</td></tr>
<tr class="separator:a4b5807596680eb47671eaa5313da4e0d inherit pub_methods_classaace_1_1alexa_1_1_audio_channel"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classaace_1_1alexa_1_1_alerts.html">Alerts</a> should be extended to handle alerts (e.g. timers, alarms, reminders) from AVS.</p>
<p>The platform implementation is responsible for rendering visual cues for an active alert. The <a class="el" href="classaace_1_1alexa_1_1_alerts.html">Alerts</a> <code><a class="el" href="classaace_1_1alexa_1_1_media_player.html">MediaPlayer</a></code> will receive directives from the Engine to handle alerts audio playback.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classaace_1_1alexa_1_1_audio_channel.html">AudioChannel</a> </dd></dl>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a81cccb7e632cf26b7903d9c9c168fb22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81cccb7e632cf26b7903d9c9c168fb22">◆ </a></span>AlertState</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classaace_1_1alexa_1_1_alerts.html#a81cccb7e632cf26b7903d9c9c168fb22">aace::alexa::Alerts::AlertState</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies the state of an alert </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a81cccb7e632cf26b7903d9c9c168fb22a2baa69eafc7204f3bd8648eba580c489"></a>READY </td><td class="fielddoc"><p>The alert is ready to activate and is waiting for channel focus. </p>
</td></tr>
<tr><td class="fieldname"><a id="a81cccb7e632cf26b7903d9c9c168fb22a17130e6c806885e23770df1519b18eb7"></a>STARTED </td><td class="fielddoc"><p>The alert is activated, and rendering is perceivable by the user. </p>
</td></tr>
<tr><td class="fieldname"><a id="a81cccb7e632cf26b7903d9c9c168fb22a09d4d696b4e935115b9313e3c412509a"></a>STOPPED </td><td class="fielddoc"><p>The alert has stopped due to user or system intervention. </p>
</td></tr>
<tr><td class="fieldname"><a id="a81cccb7e632cf26b7903d9c9c168fb22adbd414f9aaabb67e8430e9520f604a79"></a>SNOOZED </td><td class="fielddoc"><p>The alert is active but has been snoozed. </p>
</td></tr>
<tr><td class="fieldname"><a id="a81cccb7e632cf26b7903d9c9c168fb22a8f7afecbc8fbc4cd0f50a57d1172482e"></a>COMPLETED </td><td class="fielddoc"><p>The alert has completed on its own, without user interaction. </p>
</td></tr>
<tr><td class="fieldname"><a id="a81cccb7e632cf26b7903d9c9c168fb22a560bb2d9ea9002aa8c70a4462ca6c304"></a>PAST_DUE </td><td class="fielddoc"><p>The alert has expired and will not be rendered. </p>
</td></tr>
<tr><td class="fieldname"><a id="a81cccb7e632cf26b7903d9c9c168fb22aa72d9c6d4fab6a8bb2fcc8fe3f7dff13"></a>FOCUS_ENTERED_FOREGROUND </td><td class="fielddoc"><p>The alert has entered the foreground. </p>
</td></tr>
<tr><td class="fieldname"><a id="a81cccb7e632cf26b7903d9c9c168fb22a8f2c39a6e3871da5c682a37a792a6b05"></a>FOCUS_ENTERED_BACKGROUND </td><td class="fielddoc"><p>The alert has entered the background. </p>
</td></tr>
<tr><td class="fieldname"><a id="a81cccb7e632cf26b7903d9c9c168fb22abb1ca97ec761fc37101737ba0aa2e7c5"></a>ERROR </td><td class="fielddoc"><p>The alert has encountered an error. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afc6cb0b2755cf2d90d50b070dec0162e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc6cb0b2755cf2d90d50b070dec0162e">◆ </a></span>alertStateChanged()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void aace::alexa::Alerts::alertStateChanged </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>alertToken</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classaace_1_1alexa_1_1_alerts.html#a81cccb7e632cf26b7903d9c9c168fb22">AlertState</a> </td>
<td class="paramname"><em>state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>reason</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Notifies the platform implementation of an alert state change</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">alertToken</td><td>The opaque token that uniquely identifies the alert </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>The new alert state </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">reason</td><td>The reason for the state change </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0ad3204360a08a578af1af59013f64a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ad3204360a08a578af1af59013f64a8">◆ </a></span>localStop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void aace::alexa::Alerts::localStop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Notifies the Engine of a platform request to stop any active alert, such as when a user presses a physical 'stop' button. </p>
</div>
</div>
<a id="a48eea8459c5a5c42819fb4fcd155ff89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48eea8459c5a5c42819fb4fcd155ff89">◆ </a></span>removeAllAlerts()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void aace::alexa::Alerts::removeAllAlerts </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>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. </p>
</div>
</div>
</div><!-- contents -->
<html>
<body>
<hr style="height:1px;border-width:0;color:gray;background-color:gray">
<p style="text-align:left;">
Alexa Auto SDK 1.0.2 - Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
<span style="float:right;">
Licensed under the <a HREF=http://aws.amazon.com/apache2.0/>Apache License, Version 2.0</a>
</span>
</p>
</body>
</html>