summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLShow.html
blob: 79272fd54deaca59f2f1fe4de1aa53fce6c89ee9 (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
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
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
<h1>SDLShow Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithMainField1:mainField2:alignment:">-initWithMainField1:mainField2:alignment:</a></li>
  <li><a href="#section--initWithMainField1:mainField1Type:mainField2:mainField2Type:alignment:">-initWithMainField1:mainField1Type:mainField2:mainField2Type:alignment:</a></li>
  <li><a href="#section--initWithMainField1:mainField2:mainField3:mainField4:alignment:">-initWithMainField1:mainField2:mainField3:mainField4:alignment:</a></li>
  <li><a href="#section--initWithMainField1:mainField1Type:mainField2:mainField2Type:mainField3:mainField3Type:mainField4:mainField4Type:alignment:">-initWithMainField1:mainField1Type:mainField2:mainField2Type:mainField3:mainField3Type:mainField4:mainField4Type:alignment:</a></li>
  <li><a href="#section--initWithMainField1:mainField2:alignment:statusBar:mediaClock:mediaTrack:">-initWithMainField1:mainField2:alignment:statusBar:mediaClock:mediaTrack:</a></li>
  <li><a href="#section--initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:mediaClock:mediaTrack:graphic:softButtons:customPresets:textFieldMetadata:">-initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:mediaClock:mediaTrack:graphic:softButtons:customPresets:textFieldMetadata:</a></li>
  <li><a href="#section-mainField1">mainField1</a></li>
  <li><a href="#section-mainField2">mainField2</a></li>
  <li><a href="#section-mainField3">mainField3</a></li>
  <li><a href="#section-mainField4">mainField4</a></li>
  <li><a href="#section-alignment">alignment</a></li>
  <li><a href="#section-statusBar">statusBar</a></li>
  <li><a href="#section-mediaClock">mediaClock</a></li>
  <li><a href="#section-mediaTrack">mediaTrack</a></li>
  <li><a href="#section-graphic">graphic</a></li>
  <li><a href="#section-secondaryGraphic">secondaryGraphic</a></li>
  <li><a href="#section-softButtons">softButtons</a></li>
  <li><a href="#section-customPresets">customPresets</a></li>
  <li><a href="#section-metadataTags">metadataTags</a></li>
</ul>

<h3>Overview</h3>

<p>Updates the application&rsquo;s display text area, regardless of whether or not
 this text area is visible to the user at the time of the request. The
 application&rsquo;s display text area remains unchanged until updated by subsequent
 calls to Show
 <p>
 The content of the application&rsquo;s display text area is visible to the user
 when the application
 is FULL or LIMITED, and the
 SDLSystemContext=MAIN and no
 SDLAlert is in progress
 <p>
 The Show operation cannot be used to create an animated scrolling screen. To
 avoid distracting the driver, Show commands cannot be issued more than once
 every 4 seconds. Requests made more frequently than this will be rejected
 <p>
 <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
 </p></p>

<p>Since SmartDeviceLink 1.0
 See SDLAlert SDLSetMediaClockTimer</p>


<section class="section task-group-section">
  <h3 id="section--initWithMainField1:mainField2:alignment:">
      -initWithMainField1:mainField2:alignment:
  </h3>
  
  <p>Undocumented</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithMainField1</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">mainField1</span> <span class="nf">mainField2</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">mainField2</span> <span class="nf">alignment</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span><span class="p">)</span><span class="nv">alignment</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">mainField1</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">mainField2</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">alignment</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span><span class="p">?)</span></code></pre>

  
  
  
  <h3 id="section--initWithMainField1:mainField1Type:mainField2:mainField2Type:alignment:">
      -initWithMainField1:mainField1Type:mainField2:mainField2Type:alignment:
  </h3>
  
  <p>Undocumented</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithMainField1</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">mainField1</span> <span class="nf">mainField1Type</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="p">)</span><span class="nv">mainField1Type</span> <span class="nf">mainField2</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">mainField2</span> <span class="nf">mainField2Type</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="p">)</span><span class="nv">mainField2Type</span> <span class="nf">alignment</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span><span class="p">)</span><span class="nv">alignment</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">mainField1</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">mainField1Type</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="p">?,</span> <span class="nv">mainField2</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">mainField2Type</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="p">?,</span> <span class="nv">alignment</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span><span class="p">?)</span></code></pre>

  
  
  
  <h3 id="section--initWithMainField1:mainField2:mainField3:mainField4:alignment:">
      -initWithMainField1:mainField2:mainField3:mainField4:alignment:
  </h3>
  
  <p>Undocumented</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithMainField1</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">mainField1</span> <span class="nf">mainField2</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">mainField2</span> <span class="nf">mainField3</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">mainField3</span> <span class="nf">mainField4</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">mainField4</span> <span class="nf">alignment</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span><span class="p">)</span><span class="nv">alignment</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">mainField1</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">mainField2</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">mainField3</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">mainField4</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">alignment</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span><span class="p">?)</span></code></pre>

  
  
  
  <h3 id="section--initWithMainField1:mainField1Type:mainField2:mainField2Type:mainField3:mainField3Type:mainField4:mainField4Type:alignment:">
      -initWithMainField1:mainField1Type:mainField2:mainField2Type:mainField3:mainField3Type:mainField4:mainField4Type:alignment:
  </h3>
  
  <p>Undocumented</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithMainField1</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">mainField1</span> <span class="nf">mainField1Type</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="p">)</span><span class="nv">mainField1Type</span> <span class="nf">mainField2</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">mainField2</span> <span class="nf">mainField2Type</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="p">)</span><span class="nv">mainField2Type</span> <span class="nf">mainField3</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">mainField3</span> <span class="nf">mainField3Type</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="p">)</span><span class="nv">mainField3Type</span> <span class="nf">mainField4</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">mainField4</span> <span class="nf">mainField4Type</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="p">)</span><span class="nv">mainField4Type</span> <span class="nf">alignment</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span><span class="p">)</span><span class="nv">alignment</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">mainField1</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">mainField1Type</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="p">?,</span> <span class="nv">mainField2</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">mainField2Type</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="p">?,</span> <span class="nv">mainField3</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">mainField3Type</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="p">?,</span> <span class="nv">mainField4</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">mainField4Type</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="p">?,</span> <span class="nv">alignment</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span><span class="p">?)</span></code></pre>

  
  
  
  <h3 id="section--initWithMainField1:mainField2:alignment:statusBar:mediaClock:mediaTrack:">
      -initWithMainField1:mainField2:alignment:statusBar:mediaClock:mediaTrack:
  </h3>
  
  <p>Undocumented</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithMainField1</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">mainField1</span> <span class="nf">mainField2</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">mainField2</span> <span class="nf">alignment</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span><span class="p">)</span><span class="nv">alignment</span> <span class="nf">statusBar</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">statusBar</span> <span class="nf">mediaClock</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">mediaClock</span> <span class="nf">mediaTrack</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">mediaTrack</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">mainField1</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">mainField2</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">alignment</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span><span class="p">?,</span> <span class="nv">statusBar</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">mediaClock</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">mediaTrack</span><span class="p">:</span> <span class="kt">String</span><span class="p">?)</span></code></pre>

  
  
  
  <h3 id="section--initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:mediaClock:mediaTrack:graphic:softButtons:customPresets:textFieldMetadata:">
      -initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:mediaClock:mediaTrack:graphic:softButtons:customPresets:textFieldMetadata:
  </h3>
  
  <p>Undocumented</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithMainField1</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">mainField1</span> <span class="nf">mainField2</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">mainField2</span> <span class="nf">mainField3</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">mainField3</span> <span class="nf">mainField4</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">mainField4</span> <span class="nf">alignment</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span><span class="p">)</span><span class="nv">alignment</span> <span class="nf">statusBar</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">statusBar</span> <span class="nf">mediaClock</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">mediaClock</span> <span class="nf">mediaTrack</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">mediaTrack</span> <span class="nf">graphic</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">graphic</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">customPresets</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n">NSString</span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">customPresets</span> <span class="nf">textFieldMetadata</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLMetadataTags.html">SDLMetadataTags</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">metadata</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">mainField1</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">mainField2</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">mainField3</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">mainField4</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">alignment</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span><span class="p">?,</span> <span class="nv">statusBar</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">mediaClock</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">mediaTrack</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">graphic</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</a></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">customPresets</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?,</span> <span class="n">textFieldMetadata</span> <span class="nv">metadata</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLMetadataTags.html">SDLMetadataTags</a></span><span class="p">?)</span></code></pre>

  
  
  
  <h3 id="section-mainField1">
      mainField1
  </h3>
  
  <p>@abstract The text displayed in a single-line display, or in the upper display
line in a two-line display
@discussion The String value representing the text displayed in a
           single-line display, or in the upper display line in a
           two-line display
           <p>
           <b>Notes: </b>
           <ul>
           <li>If this parameter is omitted, the text of mainField1 does
           not change</li>
           <li>If this parameter is an empty string, the field will be
           cleared</li>
           </ul></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">NSString</span> <span class="o">*</span><span class="n">mainField1</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">mainField1</span><span class="p">:</span> <span class="nf">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-mainField2">
      mainField2
  </h3>
  
  <p>@abstract The text displayed on the second display line of a two-line display</p>

<p>@discussion The String value representing the text displayed on the second
            display line of a two-line display
            <p>
            <b>Notes: </b>
            <ul>
            <li>If this parameter is omitted, the text of mainField2 does
            not change</li>
            <li>If this parameter is an empty string, the field will be
            cleared</li>
            <li>If provided and the display is a single-line display, the
            parameter is ignored</li>
            <li>Maxlength = 500</li>
            </ul></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">NSString</span> <span class="o">*</span><span class="n">mainField2</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">mainField2</span><span class="p">:</span> <span class="nf">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-mainField3">
      mainField3
  </h3>
  
  <p>@abstract The text displayed on the first display line of the second page</p>

<p>@discussion The String value representing the text displayed on the first
            display line of the second page
            <p>
            <b>Notes: </b>
            <ul>
            <li>If this parameter is omitted, the text of mainField3 does
            not change</li>
            <li>If this parameter is an empty string, the field will be
            cleared</li>
            <li>If provided and the display is a single-line display, the
            parameter is ignored</li>
            <li>Maxlength = 500</li>
            </ul>
 @since SmartDeviceLink 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">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">NSString</span> <span class="o">*</span><span class="n">mainField3</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">mainField3</span><span class="p">:</span> <span class="nf">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-mainField4">
      mainField4
  </h3>
  
  <p>@abstract The text displayed on the second display line of the second page</p>

<p>@discussion The String value representing the text displayed on the second
            display line of the second page
            <p>
            <b>Notes: </b>
            <ul>
            <li>If this parameter is omitted, the text of mainField4 does
            not change</li>
            <li>If this parameter is an empty string, the field will be
            cleared</li>
            <li>If provided and the display is a single-line display, the
            parameter is ignored</li>
            <li>Maxlength = 500</li>
            </ul>
 @since SmartDeviceLink 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">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">NSString</span> <span class="o">*</span><span class="n">mainField4</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">mainField4</span><span class="p">:</span> <span class="nf">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-alignment">
      alignment
  </h3>
  
  <p>@abstract The alignment that Specifies how mainField1 and mainField2 text
 should be aligned on display</p>

<p>@discussion An Enumeration value
            <p>
            <b>Notes: </b>
            <ul>
            <li>Applies only to mainField1 and mainField2 provided on this
            call, not to what is already showing in display</li>
            <li>If this parameter is omitted, text in both mainField1 and
            mainField2 will be centered</li>
            <li>Has no effect with navigation display</li>
            </ul></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="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span> <span class="n">alignment</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">alignment</span><span class="p">:</span> <span class="nf">SDLTextAlignment</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-statusBar">
      statusBar
  </h3>
  
  <p>@abstract Text in the Status Bar</p>

<p>@discussion A String representing the text you want to add in the Status
            Bar
            <p>
            <b>Notes: </b><i>The status bar only exists on navigation
            displays</i><br/>
            <ul>
            <li>If this parameter is omitted, the status bar text will
            remain unchanged</li>
            <li>If this parameter is an empty string, the field will be
            cleared</li>
            <li>If provided and the display has no status bar, this
            parameter is ignored</li>
            </ul></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">NSString</span> <span class="o">*</span><span class="n">statusBar</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">statusBar</span><span class="p">:</span> <span class="nf">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-mediaClock">
      mediaClock
  </h3>
  
  <p>@abstract This property is deprecated use SetMediaClockTimer instead.
 <p> The value for the MediaClock field using a format described in the
 MediaClockFormat enumeration</p>

<p>@discussion A String value for the MediaClock
            <p>
            <b>Notes: </b><br/>
            <ul>
            <li>Must be properly formatted as described in the
            MediaClockFormat enumeration</li>
            <li>If a value of five spaces is provided, this will clear
            that field on the display (i.e. the media clock timer field
            will not display anything)</li>
            </ul></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">NSString</span> <span class="o">*</span><span class="n">mediaClock</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">mediaClock</span><span class="p">:</span> <span class="nf">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-mediaTrack">
      mediaTrack
  </h3>
  
  <p>@abstract The text in the track field</p>

<p>@discussion A String value disaplayed in the track field
            <p>
            <b>Notes: </b><br/>
            <ul>
            <li>If parameter is omitted, the track field remains unchanged</li>
            <li>If an empty string is provided, the field will be cleared</li>
            <li>This field is only valid for media applications on navigation displays</li>
            </ul></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">NSString</span> <span class="o">*</span><span class="n">mediaTrack</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">mediaTrack</span><span class="p">:</span> <span class="nf">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-graphic">
      graphic
  </h3>
  
  <p>@abstract An image to be shown on supported displays</p>

<p>@discussion The value representing the image shown on supported displays
            <p>
            <b>Notes: </b>If omitted on supported displays, the displayed
            graphic shall not change<br/>
 @since SmartDeviceLink 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">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">graphic</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">graphic</span><span class="p">:</span> <span class="nf">SDLImage</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-secondaryGraphic">
      secondaryGraphic
  </h3>
  
  <p>@abstract An image to be shown on supported displays</p>

<p>@discussion The value representing the image shown on supported displays
            <p>
            <b>Notes: </b>If omitted on supported displays, the displayed
            graphic shall not change<br/>
 @since SmartDeviceLink 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">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">secondaryGraphic</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">secondaryGraphic</span><span class="p">:</span> <span class="nf">SDLImage</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>@abstract The the Soft buttons defined by the App</p>

<p>@discussion A Vector value represemting the Soft buttons defined by the
            App
            <p>
            <b>Notes: </b><br/>
            <ul>
            <li>If omitted on supported displays, the currently displayed
            SoftButton values will not change</li>
            <li>Array Minsize: 0</li>
            <li>Array Maxsize: 8</li>
            </ul></p>

<p>@since SmartDeviceLink 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">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">&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-customPresets">
      customPresets
  </h3>
  
  <p>@abstract The Custom Presets defined by the App</p>

<p>@discussion A Vector value representing the Custom Presets defined by the
            App
            <p>
            <ul>
            <li>If omitted on supported displays, the presets will be shown as not defined</li>
            <li>Array Minsize: 0</li>
            <li>Array Maxsize: 6</li>
            </ul>
 @since SmartDeviceLink 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">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">&lt;</span><span class="n">NSString</span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">customPresets</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">customPresets</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-metadataTags">
      metadataTags
  </h3>
  
  <p>@abstract Text Field Metadata</p>

<p>@discussion A Vector value representing the Custom Presets defined by the
            App
            <p>
            App defined metadata information. See MetadataStruct. Uses mainField1, mainField2, mainField3, mainField4.
            If omitted on supported displays, the currently set metadata tags will not change.
            If any text field contains no tags or the none tag, the metadata tag for that textfield should be removed.
 @since SmartDeviceLink 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">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/SDLMetadataTags.html">SDLMetadataTags</a></span> <span class="o">*</span><span class="n">metadataTags</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">metadataTags</span><span class="p">:</span> <span class="nf">SDLMetadataTags</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>