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
|
<h1>SDLNavigationServiceData Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section--initWithTimestamp:">-initWithTimestamp:</a></li>
<li><a href="#section--initWithTimestamp:origin:destination:destinationETA:instructions:nextInstructionETA:nextInstructionDistance:nextInstructionDistanceScale:prompt:">-initWithTimestamp:origin:destination:destinationETA:instructions:nextInstructionETA:nextInstructionDistance:nextInstructionDistanceScale:prompt:</a></li>
<li><a href="#section-timestamp">timestamp</a></li>
<li><a href="#section-origin">origin</a></li>
<li><a href="#section-destination">destination</a></li>
<li><a href="#section-destinationETA">destinationETA</a></li>
<li><a href="#section-instructions">instructions</a></li>
<li><a href="#section-nextInstructionETA">nextInstructionETA</a></li>
<li><a href="#section-nextInstructionDistance">nextInstructionDistance</a></li>
<li><a href="#section-nextInstructionDistanceScale">nextInstructionDistanceScale</a></li>
<li><a href="#section-prompt">prompt</a></li>
</ul>
<h3>Overview</h3>
<p>Undocumented</p>
<section class="section task-group-section">
<h3 id="section--initWithTimestamp:">
-initWithTimestamp:
</h3>
<p>Convenience init for required parameters.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTimestamp</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLDateTime.html">SDLDateTime</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">timestamp</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">timestamp</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDateTime.html">SDLDateTime</a></span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>timestamp</dt>
<dd><p>Timestamp of when the data was generated</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A SDLNavigationServiceData object</p>
</div>
<h3 id="section--initWithTimestamp:origin:destination:destinationETA:instructions:nextInstructionETA:nextInstructionDistance:nextInstructionDistanceScale:prompt:">
-initWithTimestamp:origin:destination:destinationETA:instructions:nextInstructionETA:nextInstructionDistance:nextInstructionDistanceScale:prompt:
</h3>
<p>Convenience init for all parameters.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span>
<span class="nf">initWithTimestamp</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLDateTime.html">SDLDateTime</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">timestamp</span>
<span class="nf">origin</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">origin</span>
<span class="nf">destination</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">destination</span>
<span class="nf">destinationETA</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLDateTime.html">SDLDateTime</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">destinationETA</span>
<span class="nf">instructions</span><span class="p">:</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/SDLNavigationInstruction.html">SDLNavigationInstruction</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span>
<span class="n"><a href="../Classes/SDLNavigationServiceData.html#/c:objc(cs)SDLNavigationServiceData(py)instructions">instructions</a></span>
<span class="n"><a href="../Classes/SDLNavigationServiceData.html#/c:objc(cs)SDLNavigationServiceData(py)nextInstructionETA">nextInstructionETA</a></span><span class="o">:</span><span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLDateTime.html">SDLDateTime</a></span> <span class="o">*</span><span class="p">)</span><span class="n"><a href="../Classes/SDLNavigationServiceData.html#/c:objc(cs)SDLNavigationServiceData(py)nextInstructionETA">nextInstructionETA</a></span>
<span class="n"><a href="../Classes/SDLNavigationServiceData.html#/c:objc(cs)SDLNavigationServiceData(py)nextInstructionDistance">nextInstructionDistance</a></span><span class="o">:</span><span class="p">(</span><span class="kt">float</span><span class="p">)</span><span class="n"><a href="../Classes/SDLNavigationServiceData.html#/c:objc(cs)SDLNavigationServiceData(py)nextInstructionDistance">nextInstructionDistance</a></span>
<span class="n"><a href="../Classes/SDLNavigationServiceData.html#/c:objc(cs)SDLNavigationServiceData(py)nextInstructionDistanceScale">nextInstructionDistanceScale</a></span><span class="o">:</span><span class="p">(</span><span class="kt">float</span><span class="p">)</span><span class="n"><a href="../Classes/SDLNavigationServiceData.html#/c:objc(cs)SDLNavigationServiceData(py)nextInstructionDistanceScale">nextInstructionDistanceScale</a></span>
<span class="n"><a href="../Classes/SDLNavigationServiceData.html#/c:objc(cs)SDLNavigationServiceData(py)prompt">prompt</a></span><span class="o">:</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="n"><a href="../Classes/SDLNavigationServiceData.html#/c:objc(cs)SDLNavigationServiceData(py)prompt">prompt</a></span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">timestamp</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDateTime.html">SDLDateTime</a></span><span class="p">,</span> <span class="nv">origin</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLocationDetails.html">SDLLocationDetails</a></span><span class="p">?,</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLocationDetails.html">SDLLocationDetails</a></span><span class="p">?,</span> <span class="nv">destinationETA</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDateTime.html">SDLDateTime</a></span><span class="p">?,</span> <span class="nv">instructions</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLNavigationInstruction.html">SDLNavigationInstruction</a></span><span class="p">]?,</span> <span class="nv">nextInstructionETA</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDateTime.html">SDLDateTime</a></span><span class="p">?,</span> <span class="nv">nextInstructionDistance</span><span class="p">:</span> <span class="kt">Float</span><span class="p">,</span> <span class="nv">nextInstructionDistanceScale</span><span class="p">:</span> <span class="kt">Float</span><span class="p">,</span> <span class="nv">prompt</span><span class="p">:</span> <span class="kt">String</span><span class="p">?)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>timestamp</dt>
<dd><p>Timestamp of when the data was generated</p></dd>
<dt>origin</dt>
<dd><p>The start location</p></dd>
<dt>destination</dt>
<dd><p>The final destination location</p></dd>
<dt>destinationETA</dt>
<dd><p>The estimated time of arrival at the final destination location</p></dd>
<dt>instructions</dt>
<dd><p>Array ordered with all remaining instructions</p></dd>
<dt>nextInstructionETA</dt>
<dd><p>The estimated time of arrival at the next destination</p></dd>
<dt>nextInstructionDistance</dt>
<dd><p>The distance to this instruction from current location</p></dd>
<dt>nextInstructionDistanceScale</dt>
<dd><p>Distance till next maneuver (starting from) from previous maneuver</p></dd>
<dt>prompt</dt>
<dd><p>This is a prompt message that should be conveyed to the user through either display or voice (TTS)</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A SDLNavigationServiceData object</p>
</div>
<h3 id="section-timestamp">
timestamp
</h3>
<p>This is the timestamp of when the data was generated. This is to ensure any time or distance given in the data can accurately be adjusted if necessary.</p>
<p>SDLDateTime, Required</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"><a href="../Classes/SDLDateTime.html">SDLDateTime</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">timestamp</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">timestamp</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDateTime.html">SDLDateTime</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-origin">
origin
</h3>
<p>The start location.</p>
<p>SDLLocationDetails, 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/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*</span><span class="n">origin</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">origin</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLocationDetails.html">SDLLocationDetails</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-destination">
destination
</h3>
<p>The final destination location.</p>
<p>SDLLocationDetails, 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/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*</span><span class="n">destination</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLocationDetails.html">SDLLocationDetails</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-destinationETA">
destinationETA
</h3>
<p>The estimated time of arrival at the final destination location.</p>
<p>SDLDateTime, 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/SDLDateTime.html">SDLDateTime</a></span> <span class="o">*</span><span class="n">destinationETA</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">destinationETA</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDateTime.html">SDLDateTime</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-instructions">
instructions
</h3>
<p>This array should be ordered with all remaining instructions. The start of this array should always contain the next instruction.</p>
<p>Array of SDLNavigationInstruction, 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">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLNavigationInstruction.html">SDLNavigationInstruction</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">instructions</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">instructions</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLNavigationInstruction.html">SDLNavigationInstruction</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-nextInstructionETA">
nextInstructionETA
</h3>
<p>The estimated time of arrival at the next destination.</p>
<p>SDLDateTime, 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/SDLDateTime.html">SDLDateTime</a></span> <span class="o">*</span><span class="n">nextInstructionETA</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">nextInstructionETA</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDateTime.html">SDLDateTime</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-nextInstructionDistance">
nextInstructionDistance
</h3>
<p>The distance to this instruction from current location. This should only be updated ever .1 unit of distance. For more accuracy the consumer can use the GPS location of itself and the next instruction.</p>
<p>Float, 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">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">nextInstructionDistance</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">nextInstructionDistance</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-nextInstructionDistanceScale">
nextInstructionDistanceScale
</h3>
<p>Distance till next maneuver (starting from) from previous maneuver.</p>
<p>Float, 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">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">nextInstructionDistanceScale</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">nextInstructionDistanceScale</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-prompt">
prompt
</h3>
<p>This is a prompt message that should be conveyed to the user through either display or voice (TTS). This param will change often as it should represent the following: approaching instruction, post instruction, alerts that affect the current navigation session, etc.</p>
<p>String, 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">NSString</span> <span class="o">*</span><span class="n">prompt</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">prompt</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>
</section>
|
