summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLAlert.html
blob: 47c6f8eb83490105c476be8d646d55da83d9430b (plain)
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
<h1>SDLAlert Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithAlertText:softButtons:playTone:ttsChunks:alertIcon:cancelID:">-initWithAlertText:softButtons:playTone:ttsChunks:alertIcon:cancelID:</a></li>
  <li><a href="#section--initWithTTSChunks:playTone:">-initWithTTSChunks:playTone:</a></li>
  <li><a href="#section--initWithAlertText1:alertText2:alertText3:softButtons:playTone:ttsChunks:duration:progressIndicator:alertIcon:cancelID:">-initWithAlertText1:alertText2:alertText3:softButtons:playTone:ttsChunks:duration:progressIndicator:alertIcon:cancelID:</a></li>
  <li><a href="#section-alertText1">alertText1</a></li>
  <li><a href="#section-alertText2">alertText2</a></li>
  <li><a href="#section-alertText3">alertText3</a></li>
  <li><a href="#section-ttsChunks">ttsChunks</a></li>
  <li><a href="#section-duration">duration</a></li>
  <li><a href="#section-playTone">playTone</a></li>
  <li><a href="#section-progressIndicator">progressIndicator</a></li>
  <li><a href="#section-softButtons">softButtons</a></li>
  <li><a href="#section-cancelID">cancelID</a></li>
  <li><a href="#section-alertIcon">alertIcon</a></li>
</ul>

<h3>Overview</h3>

<p>Shows an alert which typically consists of text-to-speech message and text on the display. Either <code>alertText1</code>, <code>alertText2</code> or <code>TTSChunks</code> needs to be set or the request will be rejected.</p>

<p>If connecting to SDL Core v.6.0+, the alert can be canceled programmatically using the <code>cancelID</code>. Canceling will not dismiss the alert&rsquo;s speech - only the modal view will be dismissed. On older versions of SDL Core, the alert will persist until the user has interacted with the alert or the specified timeout has elapsed.</p>

<p>@since SDL 1.0</p>


<section class="section task-group-section">
  <h3 id="section--initWithAlertText:softButtons:playTone:ttsChunks:alertIcon:cancelID:">
      -initWithAlertText:softButtons:playTone:ttsChunks:alertIcon:cancelID:
  </h3>
  
  <p>Convenience init for creating a modal view with text, buttons, and optional sound cues.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span>
    <span class="nf">initWithAlertText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">alertText</span>
          <span class="nf">softButtons</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">softButtons</span>
             <span class="nf">playTone</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">playTone</span>
            <span class="nf">ttsChunks</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">ttsChunks</span>
            <span class="nf">alertIcon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span>
             <span class="nf">cancelID</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">cancelID</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">alertText</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">softButtons</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span><span class="p">]?,</span> <span class="nv">playTone</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">ttsChunks</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span><span class="p">]?,</span> <span class="n"><a href="../Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)alertIcon">alertIcon</a></span> <span class="nv">icon</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</a></span><span class="p">?,</span> <span class="nv">cancelID</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>alertText</dt>
      <dd><p>The string to be displayed in the first field of the display</p></dd>
      <dt>softButtons</dt>
      <dd><p>Soft buttons to be displayed</p></dd>
      <dt>playTone</dt>
      <dd><p>Whether the alert tone should be played before the TTS (if any) is spoken</p></dd>
      <dt>ttsChunks</dt>
      <dd><p>Speech or a sound file to be played when the alert shows</p></dd>
      <dt>cancelID</dt>
      <dd><p>An ID for this specific alert to allow cancellation through the <code>CancelInteraction</code> RPC</p></dd>
      <dt>icon</dt>
      <dd><p>Image to be displayed in the alert</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An SDLAlert object</p>
  </div>
  
  <h3 id="section--initWithTTSChunks:playTone:">
      -initWithTTSChunks:playTone:
  </h3>
  
  <p>Convenience init for creating a sound-only alert.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTTSChunks</span><span class="p">:</span>
                            <span class="p">(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">ttsChunks</span>
                                 <span class="nf">playTone</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">playTone</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">ttsChunks</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span><span class="p">]?,</span> <span class="nv">playTone</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>ttsChunks</dt>
      <dd><p>Speech or a sound file to be played when the alert shows</p></dd>
      <dt>playTone</dt>
      <dd><p>Whether the alert tone should be played before the TTS is spoken</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An SDLAlert object</p>
  </div>
  
  <h3 id="section--initWithAlertText1:alertText2:alertText3:softButtons:playTone:ttsChunks:duration:progressIndicator:alertIcon:cancelID:">
      -initWithAlertText1:alertText2:alertText3:softButtons:playTone:ttsChunks:duration:progressIndicator:alertIcon:cancelID:
  </h3>
  
  <p>Convenience init for setting all alert parameters.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span>
    <span class="nf">initWithAlertText1</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">alertText1</span>
            <span class="nf">alertText2</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">alertText2</span>
            <span class="nf">alertText3</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">alertText3</span>
           <span class="nf">softButtons</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">softButtons</span>
              <span class="nf">playTone</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">playTone</span>
             <span class="nf">ttsChunks</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">ttsChunks</span>
              <span class="nf">duration</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">duration</span>
     <span class="nf">progressIndicator</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">progressIndicator</span>
             <span class="nf">alertIcon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span>
              <span class="nf">cancelID</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">cancelID</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">alertText1</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">alertText2</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">alertText3</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">softButtons</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span><span class="p">]?,</span> <span class="nv">playTone</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">ttsChunks</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span><span class="p">]?,</span> <span class="nv">duration</span><span class="p">:</span> <span class="kt">UInt16</span><span class="p">,</span> <span class="nv">progressIndicator</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="n"><a href="../Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)alertIcon">alertIcon</a></span> <span class="nv">icon</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</a></span><span class="p">?,</span> <span class="nv">cancelID</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>alertText1</dt>
      <dd><p>The first line of the alert</p></dd>
      <dt>alertText2</dt>
      <dd><p>The second line of the alert</p></dd>
      <dt>alertText3</dt>
      <dd><p>The third line of the alert</p></dd>
      <dt>softButtons</dt>
      <dd><p>Buttons for the alert</p></dd>
      <dt>playTone</dt>
      <dd><p>Whether the alert tone should be played before the TTS (if any) is spoken</p></dd>
      <dt>ttsChunks</dt>
      <dd><p>An array of text chunks to be spoken or a prerecorded sound file</p></dd>
      <dt>duration</dt>
      <dd><p>The duration of the displayed portion of the alert, in milliseconds</p></dd>
      <dt>progressIndicator</dt>
      <dd><p>Whether an animation indicating that loading of a feature is progressing should be shown</p></dd>
      <dt>cancelID</dt>
      <dd><p>An ID for this specific alert to allow cancellation through the <code>CancelInteraction</code> RPC</p></dd>
      <dt>icon</dt>
      <dd><p>Image to be displayed in the alert</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An SDLAlert object</p>
  </div>
  
  <h3 id="section-alertText1">
      alertText1
  </h3>
  
  <p>The first line of the alert text field.</p>

<p>@discussion     At least either <code>alertText1</code>, <code><a href="../Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)alertText2">alertText2</a></code> or <code><a href="../Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)ttsChunks">ttsChunks</a></code> need to be provided.
@discussion     If supported, the <code>displayCapabilities</code> will have a <code>TextField</code> with a <code>name</code> of <code>alertText1</code>.</p>

<p>String, Optional, Max length 500 chars
@since SDL 1.0</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">alertText1</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">alertText1</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-alertText2">
      alertText2
  </h3>
  
  <p>The second line of the alert text field.</p>

<p>@discussion     At least either <code><a href="../Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)alertText1">alertText1</a></code>, <code>alertText2</code> or <code><a href="../Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)ttsChunks">ttsChunks</a></code> need to be provided.
@discussion     If supported, the <code>displayCapabilities</code> will have a <code>TextField</code> with a <code>name</code> of <code>alertText2</code></p>

<p>String, Optional, Max length 500 chars
@since SDL 1.0</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">alertText2</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">alertText2</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-alertText3">
      alertText3
  </h3>
  
  <p>The optional third line of the alert text field.</p>

<p>@discussion If supported, the <code>displayCapabilities</code> will have a <code>TextField</code> with a <code>name</code> of <code>alertText3</code></p>

<p>String, Optional, Max length 500 chars
@since SDL 2.0</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">alertText3</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">alertText3</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-ttsChunks">
      ttsChunks
  </h3>
  
  <p>An array of text chunks to be spoken or a prerecorded sound file.</p>

<p>@discussion At least either <code><a href="../Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)alertText1">alertText1</a></code>, <code><a href="../Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)alertText2">alertText2</a></code> or <code>ttsChunks</code> need to be provided.</p>

<p>Array of SDLTTSChunk, Optional, Array length 1 - 100</p>

<p>@since SDL 1.0</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">ttsChunks</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">ttsChunks</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-duration">
      duration
  </h3>
  
  <p>The duration of the displayed portion of the alert, in milliseconds. Typical timeouts are 3 - 5 seconds. If omitted, the timeout is set to a default of 5 seconds.</p>

<p>Integer, Optional, Min value: 3000, Max value: 10000</p>

<p>@since SDL 1.0</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">duration</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">duration</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-playTone">
      playTone
  </h3>
  
  <p>Whether the alert tone should be played before the TTS (if any) is spoken. If omitted or set to false, no tone is played.</p>

<p>Boolean, Optional</p>

<p>@since SDL 1.0</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">playTone</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">playTone</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-progressIndicator">
      progressIndicator
  </h3>
  
  <p>If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing (e.g. a spinning wheel or hourglass, etc.).</p>

<p>Boolean, Optional</p>

<p>@since SDL 2.0</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">progressIndicator</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">progressIndicator</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-softButtons">
      softButtons
  </h3>
  
  <p>Buttons for the displayed alert. If omitted on supported displays, the displayed alert shall not have any buttons.</p>

<p>Array of SDLSoftButton, Optional, Array size 0 - 4</p>

<p>@since SDL 2.0</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">softButtons</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">softButtons</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-cancelID">
      cancelID
  </h3>
  
  <p>An ID for this specific alert to allow cancellation through the <code>CancelInteraction</code> RPC.</p>

<p>Integer, Optional</p>
<div class="aside aside-see">
    <p class="aside-title">See</p>
    SDLCancelInteraction
@since SDL 6.0

</div>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">cancelID</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">cancelID</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-alertIcon">
      alertIcon
  </h3>
  
  <p>Image to be displayed in the alert. If omitted on supported displays, no (or the default if applicable) icon should be displayed.</p>

<p>SDLImage, Optional
@since SDL 6.0</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">alertIcon</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">alertIcon</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
</section>