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
419
420
421
422
423
424
|
<h1>SDLAddCommand Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section--initWithHandler:">-initWithHandler:</a></li>
<li><a href="#section--initWithId:vrCommands:handler:">-initWithId:vrCommands:handler:</a></li>
<li><a href="#section--initWithId:vrCommands:menuName:handler:">-initWithId:vrCommands:menuName:handler:</a></li>
<li><a href="#section--initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:handler:">-initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:handler:</a></li>
<li><a href="#section--initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:iconIsTemplate:handler:">-initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:iconIsTemplate:handler:</a></li>
<li><a href="#section--initWithId:vrCommands:menuName:parentId:position:icon:handler:">-initWithId:vrCommands:menuName:parentId:position:icon:handler:</a></li>
<li><a href="#section-handler">handler</a></li>
<li><a href="#section-cmdID">cmdID</a></li>
<li><a href="#section-menuParams">menuParams</a></li>
<li><a href="#section-vrCommands">vrCommands</a></li>
<li><a href="#section-cmdIcon">cmdIcon</a></li>
</ul>
<h3>Overview</h3>
<p>This class will add a command to the application’s Command Menu</p>
<p>A command will be added to the end of the list of elements in the Command Menu under the following conditions:</p>
<ol>
<li>When a SDLAddCommand is added with no SDLMenuParams value provided.</li>
<li>When a SDLMenuParams value is provided with a SDLMenuParam.position value greater than or equal to the number of menu items currently defined in the menu specified by the SDLMenuParam.parentID value.</li>
</ol>
<p>The set of choices which the application builds using SDLAddCommand can be a mixture of:</p>
<ol>
<li>Choices having only VR synonym definitions, but no SDLMenuParams definitions</li>
<li>Choices having only SDLMenuParams definitions, but no VR synonym definitions</li>
<li>Choices having both SDLMenuParams and VR synonym definitions</li>
</ol>
<p>HMILevel needs to be FULL, LIMITED or BACKGROUD
@since SDL 1.0</p>
<div class="aside aside-see">
<p class="aside-title">See</p>
SDLDeleteCommand, SDLAddSubMenu, SDLDeleteSubMenu
</div>
<section class="section task-group-section">
<h3 id="section--initWithHandler:">
-initWithHandler:
</h3>
<p>Constructs a SDLAddCommand with a handler callback when an event occurs.</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">initWithHandler</span><span class="p">:</span>
<span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</a></span><span class="p">)</span><span class="nv">handler</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">handler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>handler</dt>
<dd><p>A callback that is called when a button event occurs for the command.</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A SDLAddCommand object</p>
</div>
<h3 id="section--initWithId:vrCommands:handler:">
-initWithId:vrCommands:handler:
</h3>
<p>Convenience init for creating a voice command menu item.</p>
<p>@discussion This menu item can only be triggered by the VR system and does not show up in the HMI application menu.</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">initWithId</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">commandId</span>
<span class="nf">vrCommands</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">vrCommands</span>
<span class="nf">handler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</a></span><span class="p">)</span>
<span class="n"><a href="../Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)handler">handler</a></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="n">id</span> <span class="nv">commandId</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">vrCommands</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?,</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>commandId</dt>
<dd><p>A unique id for the menu item.</p></dd>
<dt>vrCommands</dt>
<dd><p>One or more voice recognition phrases. If recognized by the VR system, the handler will be called.</p></dd>
<dt>handler</dt>
<dd><p>Called when the VR system recognizes a phrase in <code><a href="../Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)vrCommands">vrCommands</a></code></p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A SDLAddCommand object</p>
</div>
<h3 id="section--initWithId:vrCommands:menuName:handler:">
-initWithId:vrCommands:menuName:handler:
</h3>
<p>Convenience init for creating a menu item with text.</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">initWithId</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">commandId</span>
<span class="nf">vrCommands</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">vrCommands</span>
<span class="nf">menuName</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">menuName</span>
<span class="nf">handler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</a></span><span class="p">)</span>
<span class="n"><a href="../Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)handler">handler</a></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="n">id</span> <span class="nv">commandId</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">vrCommands</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?,</span> <span class="nv">menuName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>commandId</dt>
<dd><p>A unique id for the menu item.</p></dd>
<dt>vrCommands</dt>
<dd><p>One or more voice recognition phrases. If recognized by the VR system, the handler will be called.</p></dd>
<dt>menuName</dt>
<dd><p>The text that will appear in the menu.</p></dd>
<dt>handler</dt>
<dd><p>Called when the menu item is selected and/or when the VR system recognizes a phrase in <code><a href="../Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)vrCommands">vrCommands</a></code></p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A SDLAddCommand object</p>
</div>
<h3 id="section--initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:handler:">
-initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:handler:
</h3>
<p>Convenience init for creating a menu item with text and a custom icon.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
<p>The icon must be uploaded to Core before being displayed in the menu.</p>
</div>
<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">initWithId</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">commandId</span>
<span class="nf">vrCommands</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">vrCommands</span>
<span class="nf">menuName</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">menuName</span>
<span class="nf">parentId</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">parentId</span>
<span class="nf">position</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">position</span>
<span class="nf">iconValue</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">iconValue</span>
<span class="nf">iconType</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLImageType.h@T@SDLImageType">SDLImageType</a></span><span class="p">)</span><span class="nv">iconType</span>
<span class="nf">handler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</a></span><span class="p">)</span>
<span class="n"><a href="../Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)handler">handler</a></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="n">id</span> <span class="nv">commandId</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">vrCommands</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?,</span> <span class="nv">menuName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">parentId</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">position</span><span class="p">:</span> <span class="kt">UInt16</span><span class="p">,</span> <span class="nv">iconValue</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">iconType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLImageType.h@T@SDLImageType">SDLImageType</a></span><span class="p">?,</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>commandId</dt>
<dd><p>A unique id for the menu item.</p></dd>
<dt>vrCommands</dt>
<dd><p>One or more voice recognition phrases. If recognized by the VR system, the handler will be called.</p></dd>
<dt>menuName</dt>
<dd><p>The text that will appear in the menu.</p></dd>
<dt>parentId</dt>
<dd><p>The command id of the parent menu if menu item is in a submenu. If not in a submenu, the parentId is 0.</p></dd>
<dt>position</dt>
<dd><p>The menu item’s row number in the menu.</p></dd>
<dt>iconValue</dt>
<dd><p>The unique name used to upload the image to Core.</p></dd>
<dt>iconType</dt>
<dd><p>Whether the image is static or dynamic.</p></dd>
<dt>handler</dt>
<dd><p>Called when the menu item is selected and/or when the VR system recognizes a phrase in <code><a href="../Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)vrCommands">vrCommands</a></code></p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A SDLAddCommand object</p>
</div>
<h3 id="section--initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:iconIsTemplate:handler:">
-initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:iconIsTemplate:handler:
</h3>
<p>Convenience init for creating a menu item with text and a custom icon.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
<p>The icon must be uploaded to Core before being displayed in the menu.</p>
</div>
<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">initWithId</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">commandId</span>
<span class="nf">vrCommands</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">vrCommands</span>
<span class="nf">menuName</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">menuName</span>
<span class="nf">parentId</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">parentId</span>
<span class="nf">position</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">position</span>
<span class="nf">iconValue</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">iconValue</span>
<span class="nf">iconType</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLImageType.h@T@SDLImageType">SDLImageType</a></span><span class="p">)</span><span class="nv">iconType</span>
<span class="nf">iconIsTemplate</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">iconIsTemplate</span>
<span class="nf">handler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</a></span><span class="p">)</span>
<span class="n"><a href="../Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)handler">handler</a></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="n">id</span> <span class="nv">commandId</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">vrCommands</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?,</span> <span class="nv">menuName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">parentId</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">position</span><span class="p">:</span> <span class="kt">UInt16</span><span class="p">,</span> <span class="nv">iconValue</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">iconType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLImageType.h@T@SDLImageType">SDLImageType</a></span><span class="p">?,</span> <span class="nv">iconIsTemplate</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>commandId</dt>
<dd><p>A unique id for the menu item.</p></dd>
<dt>vrCommands</dt>
<dd><p>One or more voice recognition phrases. If recognized by the VR system, the handler will be called.</p></dd>
<dt>menuName</dt>
<dd><p>The text that will appear in the menu.</p></dd>
<dt>parentId</dt>
<dd><p>The command id of the parent menu if menu item is in a submenu. If not in a submenu, the parentId is 0.</p></dd>
<dt>position</dt>
<dd><p>The menu item’s row number in the menu.</p></dd>
<dt>iconValue</dt>
<dd><p>The unique name used to upload the image to Core.</p></dd>
<dt>iconType</dt>
<dd><p>Whether the image is static or dynamic.</p></dd>
<dt>iconIsTemplate</dt>
<dd><p>Whether or not the image is a template that can be (re)colored by the SDL HMI</p></dd>
<dt>handler</dt>
<dd><p>Called when the menu item is selected and/or when the VR system recognizes a phrase in <code><a href="../Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)vrCommands">vrCommands</a></code></p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A SDLAddCommand object</p>
</div>
<h3 id="section--initWithId:vrCommands:menuName:parentId:position:icon:handler:">
-initWithId:vrCommands:menuName:parentId:position:icon:handler:
</h3>
<p>Convenience init for creating a menu item with text and a custom icon.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
<p>The icon must be uploaded to Core before being displayed in the menu.</p>
</div>
<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">initWithId</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">commandId</span>
<span class="nf">vrCommands</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">vrCommands</span>
<span class="nf">menuName</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">menuName</span>
<span class="nf">parentId</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">parentId</span>
<span class="nf">position</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">position</span>
<span class="nf">icon</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">handler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</a></span><span class="p">)</span>
<span class="n"><a href="../Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)handler">handler</a></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="n">id</span> <span class="nv">commandId</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">vrCommands</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?,</span> <span class="nv">menuName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">parentId</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">position</span><span class="p">:</span> <span class="kt">UInt16</span><span class="p">,</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">handler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>commandId</dt>
<dd><p>A unique id for the menu item.</p></dd>
<dt>vrCommands</dt>
<dd><p>One or more voice recognition phrases. If recognized by the VR system, the handler will be called.</p></dd>
<dt>menuName</dt>
<dd><p>The text that will appear in the menu.</p></dd>
<dt>parentId</dt>
<dd><p>The command id of the parent menu if menu item is in a submenu. If not in a submenu, the parentId is 0.</p></dd>
<dt>position</dt>
<dd><p>The menu item’s row number in the menu.</p></dd>
<dt>icon</dt>
<dd><p>A image that appears next to the <code>menuName</code> text.</p></dd>
<dt>handler</dt>
<dd><p>Called when the menu item is selected and/or when the VR system recognizes a phrase in <code><a href="../Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)vrCommands">vrCommands</a></code></p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A SDLAddCommand object</p>
</div>
<h3 id="section-handler">
handler
</h3>
<p>A handler that will let you know when the button you created is subscribed.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
This will only work if you use <code><a href="../Classes/SDLManager.html">SDLManager</a></code>.
</div>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span>
<span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</a></span> <span class="n">handler</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</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-cmdID">
cmdID
</h3>
<p>A unique id that identifies the command.</p>
<p>@discussion Is returned in an <code><a href="../Classes/SDLOnCommand.html">SDLOnCommand</a></code> notification to identify the command selected by the user</p>
<p>Required, Integer, 0 - 2,000,000,000</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">cmdID</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">cmdID</span><span class="p">:</span> <span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</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-menuParams">
menuParams
</h3>
<p>A <code><a href="../Classes/SDLMenuParams.html">SDLMenuParams</a></code> pointer which defines the command and how it is added to the command menu.</p>
<p>@discussion If provided, this will define the command and how it is added to the command menu. If null, commands will not be accessible through the HMI application menu.</p>
<p>Optional</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLMenuParams.html">SDLMenuParams</a></span> <span class="o">*</span><span class="n">menuParams</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">menuParams</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLMenuParams.html">SDLMenuParams</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-vrCommands">
vrCommands
</h3>
<p>An array of strings to be used as VR synonyms for this command.</p>
<p>@discussion If provided, defines one or more VR phrases the recognition of any of which triggers the <code><a href="../Classes/SDLOnCommand.html">SDLOnCommand</a></code> notification with this cmdID. If null, commands will not be accessible by voice commands (when the user hits push-to-talk).</p>
<p>Optional, Array of Strings, Max String length 99 chars, Array size 1 - 100</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</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">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">vrCommands</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">vrCommands</span><span class="p">:</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-cmdIcon">
cmdIcon
</h3>
<p>Image struct containing a static or dynamic icon.</p>
<p>@discussion If provided, defines the image to be be shown along with a command. If omitted on supported displays, no (or the default if applicable) icon will be displayed</p>
<p>Optional</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</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">cmdIcon</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">cmdIcon</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>
|
