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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
|
<h1>SDLChoiceSet Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section-defaultTimeout">defaultTimeout</a></li>
<li><a href="#section-defaultLayout">defaultLayout</a></li>
<li><a href="#section-title">title</a></li>
<li><a href="#section-initialPrompt">initialPrompt</a></li>
<li><a href="#section-layout">layout</a></li>
<li><a href="#section-timeout">timeout</a></li>
<li><a href="#section-timeoutPrompt">timeoutPrompt</a></li>
<li><a href="#section-helpPrompt">helpPrompt</a></li>
<li><a href="#section-helpList">helpList</a></li>
<li><a href="#section-delegate">delegate</a></li>
<li><a href="#section-choices">choices</a></li>
<li><a href="#section--init">-init</a></li>
<li><a href="#section--initWithTitle:delegate:choices:">-initWithTitle:delegate:choices:</a></li>
<li><a href="#section--initWithTitle:delegate:layout:timeout:initialPromptString:timeoutPromptString:helpPromptString:vrHelpList:choices:">-initWithTitle:delegate:layout:timeout:initialPromptString:timeoutPromptString:helpPromptString:vrHelpList:choices:</a></li>
<li><a href="#section--initWithTitle:delegate:layout:timeout:initialPrompt:timeoutPrompt:helpPrompt:vrHelpList:choices:">-initWithTitle:delegate:layout:timeout:initialPrompt:timeoutPrompt:helpPrompt:vrHelpList:choices:</a></li>
<li><a href="#section--cancel">-cancel</a></li>
</ul>
<h3>Overview</h3>
<p>The choice set to be displayed to the user. Contains a list of selectable options.</p>
<section class="section task-group-section">
<h3 id="section-defaultTimeout">
defaultTimeout
</h3>
<p>Set this to change the default timeout for all choice sets. If a timeout is not set on an individual choice set object (or if it is set to 0.0), then it will use this timeout instead. See <code><a href="../Classes/SDLChoiceSet.html#/c:objc(cs)SDLChoiceSet(py)timeout">timeout</a></code> for more details. If this is not set by you, it will default to 10 seconds. The minimum is 5 seconds, the maximum is 100 seconds. If this is set below the minimum, it will be capped at 5 seconds. If this is set above the maximum, it will be capped at 100 seconds.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">class</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSTimeInterval</span> <span class="n">defaultTimeout</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="k">var</span> <span class="nv">defaultTimeout</span><span class="p">:</span> <span class="kt">TimeInterval</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-defaultLayout">
defaultLayout
</h3>
<p>Set this to change the default layout for all choice sets. If a layout is not set on an individual choice set object, then it will use this layout instead. See <code><a href="../Classes/SDLChoiceSet.html#/c:objc(cs)SDLChoiceSet(py)layout">layout</a></code> for more details. If this is not set by you, it will default to <code>SDLChoiceSetLayoutList</code>.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">class</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLChoiceSetLayout.html">SDLChoiceSetLayout</a></span> <span class="n">defaultLayout</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="k">var</span> <span class="nv">defaultLayout</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLChoiceSetLayout.html">SDLChoiceSetLayout</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-title">
title
</h3>
<p>Maps to PerformInteraction.initialText. The title of the choice set, and/or the initial text on a keyboard prompt.</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">copy</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">title</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">title</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-initialPrompt">
initialPrompt
</h3>
<p>Maps to PerformInteraction.initialPrompt. The initial prompt spoken to the user at the start of an interaction.</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">copy</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">initialPrompt</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">initialPrompt</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-layout">
layout
</h3>
<p>Maps to PerformInteraction.interactionLayout. Whether the presented choices are arranged as a set of tiles or a list.</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"><a href="../Enums/SDLChoiceSetLayout.html">SDLChoiceSetLayout</a></span> <span class="n">layout</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">layout</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLChoiceSetLayout.html">SDLChoiceSetLayout</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-timeout">
timeout
</h3>
<p>Maps to PerformInteraction.timeout. Timeout in seconds. Defaults to 0, which will use <code><a href="../Classes/SDLChoiceSet.html#/c:objc(cs)SDLChoiceSet(cpy)defaultTimeout">defaultTimeout</a></code>. If this is set below the minimum, it will be capped at 5 seconds. Minimum 5 seconds, maximum 100 seconds. If this is set above the maximum, it will be capped at 100 seconds. Defaults to 0.</p>
<div class="aside aside-note">
<p class="aside-title">Note</p>
This applies only to a manual selection (not a voice selection, which has its timeout handled by the system).
</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">NSTimeInterval</span> <span class="n">timeout</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">timeout</span><span class="p">:</span> <span class="kt">TimeInterval</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-timeoutPrompt">
timeoutPrompt
</h3>
<p>Maps to PerformInteraction.timeoutPrompt. This text is spoken when a VR interaction times out. If this set is presented in a manual (non-voice) only interaction, this will be ignored.</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">copy</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">timeoutPrompt</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">timeoutPrompt</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-helpPrompt">
helpPrompt
</h3>
<p>Maps to PerformInteraction.helpPrompt. This is the spoken string when a user speaks “help” when the interaction is occurring.</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">copy</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">helpPrompt</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">helpPrompt</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-helpList">
helpList
</h3>
<p>Maps to PerformInteraction.vrHelp. This is a list of help text presented to the user when they are in a voice recognition interaction from your choice set of options. If this set is presented in a touch only interaction, this will be ignored.</p>
<div class="aside aside-note">
<p class="aside-title">Note</p>
that while SDLVRHelpItem’s position will be automatically set based on position in the array, the image will need to uploaded by you before use using SDLFileManager.
</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">copy</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVRHelpItem.html">SDLVRHelpItem</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">helpList</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">helpList</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLVRHelpItem.html">SDLVRHelpItem</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-delegate">
delegate
</h3>
<p>The delegate of this choice set, called when the user interacts with it.</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">weak</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLChoiceSetDelegate.html">SDLChoiceSetDelegate</a></span><span class="o">></span> <span class="n">_Nullable</span> <span class="n">delegate</span><span class="p">;</span></code></pre>
<h3 id="section-choices">
choices
</h3>
<p>The choices to be displayed to the user within this choice set. These choices could match those already preloaded via <code>SDLScreenManager preloadChoices:withCompletionHandler:</code>.</p>
<p>This is limited to 100 items. If you attempt to set more than 100 items, the set will not have any items (this array will be empty).</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">copy</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLChoiceCell.html">SDLChoiceCell</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">choices</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">choices</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLChoiceCell.html">SDLChoiceCell</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--init">
-init
</h3>
<p>Initialize with a title, delegate, and choices. It will use the default timeout and layout, all other properties (such as prompts) will be <code>nil</code>.</p>
<p>WARNING: If you display multiple cells with the same <code>text</code> with the only uniquing property between cells being different <code>vrCommands</code> or a feature that is not displayed on the head unit (e.g. if the head unit doesn’t display <code>secondaryArtwork</code> and that’s the only uniquing property between two cells) then the cells may appear to be the same to the user in <code>Manual</code> mode. This only applies to RPC connections >= 7.1.0.</p>
<p>WARNING: On < 7.1.0 connections, the <code>text</code> cell will be automatically modified among cells that have the same <code>text</code> when they are preloaded, so they will always appear differently on-screen when they are displayed. <code>cell.uniqueText</code> will be created by appending <code>(2)</code>, <code>(3)</code>, etc.</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="n">init</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">()</span></code></pre>
<h3 id="section--initWithTitle:delegate:choices:">
-initWithTitle:delegate:choices:
</h3>
<p>Initialize with a title, delegate, and choices. It will use the default timeout and layout, all other properties (such as prompts) will be <code>nil</code>.</p>
<p>WARNING: If you display multiple cells with the same <code>text</code> with the only uniquing property between cells being different <code>vrCommands</code> or a feature that is not displayed on the head unit (e.g. if the head unit doesn’t display <code>secondaryArtwork</code> and that’s the only uniquing property between two cells) then the cells may appear to be the same to the user in <code>Manual</code> mode. This only applies to RPC connections >= 7.1.0.</p>
<p>WARNING: On < 7.1.0 connections, the <code>text</code> cell will be automatically modified among cells that have the same <code>text</code> when they are preloaded, so they will always appear differently on-screen when they are displayed. <code>cell.uniqueText</code> will be created by appending <code>(2)</code>, <code>(3)</code>, etc.</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">initWithTitle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span>
<span class="nf">delegate</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLChoiceSetDelegate.html">SDLChoiceSetDelegate</a></span><span class="o">></span><span class="p">)</span><span class="nv">delegate</span>
<span class="nf">choices</span><span class="p">:</span>
<span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLChoiceCell.html">SDLChoiceCell</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">choices</span><span class="p">;</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>title</dt>
<dd><p>The choice set’s title</p></dd>
<dt>delegate</dt>
<dd><p>The choice set delegate called after the user has interacted with your choice set</p></dd>
<dt>choices</dt>
<dd><p>The choices to be displayed to the user for interaction</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>The choice set</p>
</div>
<h3 id="section--initWithTitle:delegate:layout:timeout:initialPromptString:timeoutPromptString:helpPromptString:vrHelpList:choices:">
-initWithTitle:delegate:layout:timeout:initialPromptString:timeoutPromptString:helpPromptString:vrHelpList:choices:
</h3>
<p>Initializer with all possible properties.</p>
<p>WARNING: If you display multiple cells with the same <code>text</code> with the only uniquing property between cells being different <code>vrCommands</code> or a feature that is not displayed on the head unit (e.g. if the head unit doesn’t display <code>secondaryArtwork</code> and that’s the only uniquing property between two cells) then the cells may appear to be the same to the user in <code>Manual</code> mode. This only applies to RPC connections >= 7.1.0.</p>
<p>WARNING: On < 7.1.0 connections, the <code>text</code> cell will be automatically modified among cells that have the same <code>text</code> when they are preloaded, so they will always appear differently on-screen when they are displayed. <code>cell.uniqueText</code> will be created by appending <code>(2)</code>, <code>(3)</code>, etc.</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">initWithTitle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span>
<span class="nf">delegate</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLChoiceSetDelegate.html">SDLChoiceSetDelegate</a></span><span class="o">></span><span class="p">)</span><span class="nv">delegate</span>
<span class="nf">layout</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLChoiceSetLayout.html">SDLChoiceSetLayout</a></span><span class="p">)</span><span class="nv">layout</span>
<span class="nf">timeout</span><span class="p">:(</span><span class="n">NSTimeInterval</span><span class="p">)</span><span class="nv">timeout</span>
<span class="nf">initialPromptString</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">initialPrompt</span>
<span class="nf">timeoutPromptString</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">timeoutPrompt</span>
<span class="nf">helpPromptString</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">helpPrompt</span>
<span class="nf">vrHelpList</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVRHelpItem.html">SDLVRHelpItem</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">helpList</span>
<span class="nf">choices</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLChoiceCell.html">SDLChoiceCell</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">choices</span><span class="p">;</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>title</dt>
<dd><p>The choice set’s title</p></dd>
<dt>delegate</dt>
<dd><p>The choice set delegate called after the user has interacted with your choice set</p></dd>
<dt>layout</dt>
<dd><p>The layout of choice options (Manual/touch only)</p></dd>
<dt>timeout</dt>
<dd><p>The timeout of a touch interaction in seconds (Manual/touch only)</p></dd>
<dt>initialPrompt</dt>
<dd><p>A voice prompt spoken to the user when this set is displayed</p></dd>
<dt>timeoutPrompt</dt>
<dd><p>A voice prompt spoken to the user when the set times out (Voice only)</p></dd>
<dt>helpPrompt</dt>
<dd><p>A voice prompt spoken to the user when the user asks for “help”</p></dd>
<dt>helpList</dt>
<dd><p>A table list of text and images shown to the user during a voice recognition session for this choice set (Voice only)</p></dd>
<dt>choices</dt>
<dd><p>The list of choices presented to the user either as a manual/touch interaction or via the user’s voice</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>The choice set</p>
</div>
<h3 id="section--initWithTitle:delegate:layout:timeout:initialPrompt:timeoutPrompt:helpPrompt:vrHelpList:choices:">
-initWithTitle:delegate:layout:timeout:initialPrompt:timeoutPrompt:helpPrompt:vrHelpList:choices:
</h3>
<p>Initializer with all possible properties.</p>
<p>WARNING: If you display multiple cells with the same <code>text</code> with the only uniquing property between cells being different <code>vrCommands</code> or a feature that is not displayed on the head unit (e.g. if the head unit doesn’t display <code>secondaryArtwork</code> and that’s the only uniquing property between two cells) then the cells may appear to be the same to the user in <code>Manual</code> mode. This only applies to RPC connections >= 7.1.0.</p>
<p>WARNING: On < 7.1.0 connections, the <code>text</code> cell will be automatically modified among cells that have the same <code>text</code> when they are preloaded, so they will always appear differently on-screen when they are displayed. <code>cell.uniqueText</code> will be created by appending <code>(2)</code>, <code>(3)</code>, etc.</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">initWithTitle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span>
<span class="nf">delegate</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLChoiceSetDelegate.html">SDLChoiceSetDelegate</a></span><span class="o">></span><span class="p">)</span><span class="nv">delegate</span>
<span class="nf">layout</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLChoiceSetLayout.html">SDLChoiceSetLayout</a></span><span class="p">)</span><span class="nv">layout</span>
<span class="nf">timeout</span><span class="p">:(</span><span class="n">NSTimeInterval</span><span class="p">)</span><span class="nv">timeout</span>
<span class="nf">initialPrompt</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">initialPrompt</span>
<span class="nf">timeoutPrompt</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">timeoutPrompt</span>
<span class="nf">helpPrompt</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">helpPrompt</span>
<span class="nf">vrHelpList</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVRHelpItem.html">SDLVRHelpItem</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">helpList</span>
<span class="nf">choices</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLChoiceCell.html">SDLChoiceCell</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">choices</span><span class="p">;</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>title</dt>
<dd><p>The choice set’s title</p></dd>
<dt>delegate</dt>
<dd><p>The choice set delegate called after the user has interacted with your choice set</p></dd>
<dt>layout</dt>
<dd><p>The layout of choice options (Manual/touch only)</p></dd>
<dt>timeout</dt>
<dd><p>The timeout of a touch interaction in seconds (Manual/touch only)</p></dd>
<dt>initialPrompt</dt>
<dd><p>A voice prompt spoken to the user when this set is displayed</p></dd>
<dt>timeoutPrompt</dt>
<dd><p>A voice prompt spoken to the user when the set times out (Voice only)</p></dd>
<dt>helpPrompt</dt>
<dd><p>A voice prompt spoken to the user when the user asks for “help”</p></dd>
<dt>helpList</dt>
<dd><p>A table list of text and images shown to the user during a voice recognition session for this choice set (Voice only)</p></dd>
<dt>choices</dt>
<dd><p>The list of choices presented to the user either as a manual/touch interaction or via the user’s voice</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>The choice set</p>
</div>
<h3 id="section--cancel">
-cancel
</h3>
<p>Cancels the choice set. If the choice set has not yet been sent to Core, it will not be sent. If the choice set is already presented on Core, the choice set will be immediately dismissed. Canceling an already presented choice set will only work if connected to Core versions 6.0+. On older versions of Core, the choice set will not be dismissed.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">cancel</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">cancel</span><span class="p">()</span></code></pre>
</section>
|
