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
|
<h1>SDLShowConstantTBT Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section--initWithNavigationText1:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distanceToManeuver:distanceToManeuverScale:maneuverComplete:softButtons:">-initWithNavigationText1:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distanceToManeuver:distanceToManeuverScale:maneuverComplete:softButtons:</a></li>
<li><a href="#section-navigationText1">navigationText1</a></li>
<li><a href="#section-navigationText2">navigationText2</a></li>
<li><a href="#section-eta">eta</a></li>
<li><a href="#section-timeToDestination">timeToDestination</a></li>
<li><a href="#section-totalDistance">totalDistance</a></li>
<li><a href="#section-turnIcon">turnIcon</a></li>
<li><a href="#section-nextTurnIcon">nextTurnIcon</a></li>
<li><a href="#section-distanceToManeuver">distanceToManeuver</a></li>
<li><a href="#section-distanceToManeuverScale">distanceToManeuverScale</a></li>
<li><a href="#section-maneuverComplete">maneuverComplete</a></li>
<li><a href="#section-softButtons">softButtons</a></li>
</ul>
<h3>Overview</h3>
<p>This RPC is used to update the user with navigation information for the constantly shown screen (base screen), but also for the alert maneuver screen.</p>
<p>@since SmartDeviceLink 2.0</p>
<section class="section task-group-section">
<h3 id="section--initWithNavigationText1:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distanceToManeuver:distanceToManeuverScale:maneuverComplete:softButtons:">
-initWithNavigationText1:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distanceToManeuver:distanceToManeuverScale:maneuverComplete:softButtons:
</h3>
<p>Convenience init to create navigation directions</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">initWithNavigationText1</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">navigationText1</span>
<span class="nf">navigationText2</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">navigationText2</span>
<span class="nf">eta</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">eta</span>
<span class="nf">timeToDestination</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">timeToDestination</span>
<span class="nf">totalDistance</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">totalDistance</span>
<span class="nf">turnIcon</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">turnIcon</span>
<span class="nf">nextTurnIcon</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">nextTurnIcon</span>
<span class="nf">distanceToManeuver</span><span class="p">:(</span><span class="kt">double</span><span class="p">)</span><span class="nv">distanceToManeuver</span>
<span class="nf">distanceToManeuverScale</span><span class="p">:(</span><span class="kt">double</span><span class="p">)</span><span class="nv">distanceToManeuverScale</span>
<span class="nf">maneuverComplete</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">maneuverComplete</span>
<span class="nf">softButtons</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/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">softButtons</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">navigationText1</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">navigationText2</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">eta</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">timeToDestination</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">totalDistance</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">turnIcon</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</a></span><span class="p">?,</span> <span class="nv">nextTurnIcon</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</a></span><span class="p">?,</span> <span class="nv">distanceToManeuver</span><span class="p">:</span> <span class="kt">Double</span><span class="p">,</span> <span class="nv">distanceToManeuverScale</span><span class="p">:</span> <span class="kt">Double</span><span class="p">,</span> <span class="nv">maneuverComplete</span><span class="p">:</span> <span class="kt">Bool</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></code></pre>
<h4>Parameters</h4>
<dl>
<dt>navigationText1</dt>
<dd><p>The first line of text in a multi-line overlay screen</p></dd>
<dt>navigationText2</dt>
<dd><p>The second line of text in a multi-line overlay screen</p></dd>
<dt>eta</dt>
<dd><p>Estimated Time of Arrival time at final destination</p></dd>
<dt>timeToDestination</dt>
<dd><p>The amount of time needed to reach the final destination</p></dd>
<dt>totalDistance</dt>
<dd><p>The distance to the final destination</p></dd>
<dt>turnIcon</dt>
<dd><p>An icon to show with the turn description</p></dd>
<dt>nextTurnIcon</dt>
<dd><p>An icon to show with the next turn description</p></dd>
<dt>distanceToManeuver</dt>
<dd><p>Distance (in meters) until next maneuver.</p></dd>
<dt>distanceToManeuverScale</dt>
<dd><p>Distance (in meters) from previous maneuver to next maneuver.</p></dd>
<dt>maneuverComplete</dt>
<dd><p>If and when a maneuver has completed while an AlertManeuver is active, the app must send this value set to TRUE in order to clear the AlertManeuver overlay. If omitted the value will be assumed as FALSE</p></dd>
<dt>softButtons</dt>
<dd><p>Three dynamic SoftButtons available (first SoftButton is fixed to “Turns”)</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>An SDLShowConstantTBT object</p>
</div>
<h3 id="section-navigationText1">
navigationText1
</h3>
<p>The first line of text in a multi-line overlay screen.</p>
<p>Optional, Max length 500 chars</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">navigationText1</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">navigationText1</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-navigationText2">
navigationText2
</h3>
<p>The second line of text in a multi-line overlay screen.</p>
<p>Optional, 1 - 500 chars</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">navigationText2</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">navigationText2</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-eta">
eta
</h3>
<p>Estimated Time of Arrival time at final destination</p>
<p>Optional, 1 - 500 chars</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">eta</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">eta</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-timeToDestination">
timeToDestination
</h3>
<p>The amount of time needed to reach the final destination</p>
<p>Optional, 1 - 500 chars</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">timeToDestination</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">timeToDestination</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-totalDistance">
totalDistance
</h3>
<p>The distance to the final destination</p>
<p>Optional, 1 - 500 chars</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">totalDistance</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">totalDistance</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-turnIcon">
turnIcon
</h3>
<p>An icon to show with the turn description</p>
<p>Optional</p>
<div class="aside aside-see">
<p class="aside-title">See</p>
SDLImage
</div>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">turnIcon</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">turnIcon</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>
<h3 id="section-nextTurnIcon">
nextTurnIcon
</h3>
<p>An icon to show with the next turn description</p>
<p>Optional</p>
<div class="aside aside-see">
<p class="aside-title">See</p>
SDLImage
</div>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">nextTurnIcon</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">nextTurnIcon</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>
<h3 id="section-distanceToManeuver">
distanceToManeuver
</h3>
<p>Distance (in meters) until next maneuver. May be used to calculate progress bar.</p>
<p>Optional, Float, 0 - 1,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">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">distanceToManeuver</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">distanceToManeuver</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</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-distanceToManeuverScale">
distanceToManeuverScale
</h3>
<p>Distance (in meters) from previous maneuver to next maneuver. May be used to calculate progress bar.</p>
<p>Optional, Float, 0 - 1,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">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">distanceToManeuverScale</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">distanceToManeuverScale</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</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-maneuverComplete">
maneuverComplete
</h3>
<p>If and when a maneuver has completed while an AlertManeuver is active, the app must send this value set to TRUE in order to clear the AlertManeuver overlay. If omitted the value will be assumed as FALSE.</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">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">maneuverComplete</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">maneuverComplete</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-softButtons">
softButtons
</h3>
<p>Three dynamic SoftButtons available (first SoftButton is fixed to “Turns”). If omitted on supported displays, the currently displayed SoftButton values will not change.</p>
<p>Optional, Array length 0 - 3</p>
<div class="aside aside-see">
<p class="aside-title">See</p>
SDLSoftButton
</div>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*></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>
</section>
|
