summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLSendLocation.html
blob: cdb7f88c4a8a44fbd0dbbf249d41827dbebccffc (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
<h1>SDLSendLocation Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithAddress:addressLines:locationName:locationDescription:phoneNumber:image:deliveryMode:timeStamp:">-initWithAddress:addressLines:locationName:locationDescription:phoneNumber:image:deliveryMode:timeStamp:</a></li>
  <li><a href="#section--initWithLongitude:latitude:locationName:locationDescription:address:phoneNumber:image:">-initWithLongitude:latitude:locationName:locationDescription:address:phoneNumber:image:</a></li>
  <li><a href="#section--initWithLongitude:latitude:locationName:locationDescription:displayAddressLines:phoneNumber:image:deliveryMode:timeStamp:address:">-initWithLongitude:latitude:locationName:locationDescription:displayAddressLines:phoneNumber:image:deliveryMode:timeStamp:address:</a></li>
  <li><a href="#section-longitudeDegrees">longitudeDegrees</a></li>
  <li><a href="#section-latitudeDegrees">latitudeDegrees</a></li>
  <li><a href="#section-locationName">locationName</a></li>
  <li><a href="#section-locationDescription">locationDescription</a></li>
  <li><a href="#section-addressLines">addressLines</a></li>
  <li><a href="#section-phoneNumber">phoneNumber</a></li>
  <li><a href="#section-locationImage">locationImage</a></li>
  <li><a href="#section-deliveryMode">deliveryMode</a></li>
  <li><a href="#section-timeStamp">timeStamp</a></li>
  <li><a href="#section-address">address</a></li>
</ul>

<h3>Overview</h3>

<p>Undocumented</p>


<section class="section task-group-section">
  <h3 id="section--initWithAddress:addressLines:locationName:locationDescription:phoneNumber:image:deliveryMode:timeStamp:">
      -initWithAddress:addressLines:locationName:locationDescription:phoneNumber:image:deliveryMode:timeStamp:
  </h3>
  
  <p>Create a <code>SendLocation</code> request with an address object, without Lat/Long coordinates.</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">initWithAddress</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLOasisAddress.html">SDLOasisAddress</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">address</span>
                           <span class="nf">addressLines</span><span class="p">:</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">addressLines</span>
                           <span class="nf">locationName</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">locationName</span>
                    <span class="nf">locationDescription</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">locationDescription</span>
                            <span class="nf">phoneNumber</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">phoneNumber</span>
                                  <span class="nf">image</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">image</span>
                           <span class="nf">deliveryMode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLDeliveryMode.h@T@SDLDeliveryMode">SDLDeliveryMode</a></span><span class="p">)</span><span class="nv">deliveryMode</span>
                              <span class="nf">timeStamp</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">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">address</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOasisAddress.html">SDLOasisAddress</a></span><span class="p">,</span> <span class="nv">addressLines</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?,</span> <span class="nv">locationName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">locationDescription</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">phoneNumber</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">image</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</a></span><span class="p">?,</span> <span class="nv">deliveryMode</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLDeliveryMode.h@T@SDLDeliveryMode">SDLDeliveryMode</a></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>address</dt>
      <dd><p>The address information to be passed to the nav system for determining the route</p></dd>
      <dt>addressLines</dt>
      <dd><p>The user-facing address</p></dd>
      <dt>locationName</dt>
      <dd><p>The user-facing name of the location</p></dd>
      <dt>locationDescription</dt>
      <dd><p>The user-facing description of the location</p></dd>
      <dt>phoneNumber</dt>
      <dd><p>The phone number for the location; the user could use this to call the location</p></dd>
      <dt>image</dt>
      <dd><p>A user-facing image for the location</p></dd>
      <dt>deliveryMode</dt>
      <dd><p>How the location should be sent to the nav system</p></dd>
      <dt>timeStamp</dt>
      <dd><p>The estimated arrival time for the location (this will also likely be calculated by the nav system later, and may be different than your estimate). This is used to show the user approximately how long it would take to navigate here</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>A <code>SendLocation</code> object</p>
  </div>
  
  <h3 id="section--initWithLongitude:latitude:locationName:locationDescription:address:phoneNumber:image:">
      -initWithLongitude:latitude:locationName:locationDescription:address:phoneNumber:image:
  </h3>
  
  <p>Create a <code>SendLocation</code> request with Lat/Long coordinate, not an address object</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">initWithLongitude</span><span class="p">:(</span><span class="kt">double</span><span class="p">)</span><span class="nv">longitude</span>
               <span class="nf">latitude</span><span class="p">:(</span><span class="kt">double</span><span class="p">)</span><span class="nv">latitude</span>
           <span class="nf">locationName</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">locationName</span>
    <span class="nf">locationDescription</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">locationDescription</span>
                <span class="nf">address</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">address</span>
            <span class="nf">phoneNumber</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">phoneNumber</span>
                  <span class="nf">image</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">image</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">longitude</span><span class="p">:</span> <span class="kt">Double</span><span class="p">,</span> <span class="nv">latitude</span><span class="p">:</span> <span class="kt">Double</span><span class="p">,</span> <span class="nv">locationName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">locationDescription</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">address</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?,</span> <span class="nv">phoneNumber</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">image</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</a></span><span class="p">?)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>longitude</dt>
      <dd><p>The longitudinal coordinate of the location</p></dd>
      <dt>latitude</dt>
      <dd><p>The latitudinal coordinate of the location</p></dd>
      <dt>locationName</dt>
      <dd><p>The user-facing name of the location</p></dd>
      <dt>locationDescription</dt>
      <dd><p>The user-facing description of the location</p></dd>
      <dt>address</dt>
      <dd><p>The user-facing address</p></dd>
      <dt>phoneNumber</dt>
      <dd><p>The phone number for the location; the user could use this to call the location</p></dd>
      <dt>image</dt>
      <dd><p>A user-facing image for the location</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>A <code>SendLocation</code> object</p>
  </div>
  
  <h3 id="section--initWithLongitude:latitude:locationName:locationDescription:displayAddressLines:phoneNumber:image:deliveryMode:timeStamp:address:">
      -initWithLongitude:latitude:locationName:locationDescription:displayAddressLines:phoneNumber:image:deliveryMode:timeStamp:address:
  </h3>
  
  <p>Create a <code>SendLocation</code> request with Lat/Long coordinate and an address object and let the nav system decide how to parse it</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">initWithLongitude</span><span class="p">:(</span><span class="kt">double</span><span class="p">)</span><span class="nv">longitude</span>
               <span class="nf">latitude</span><span class="p">:(</span><span class="kt">double</span><span class="p">)</span><span class="nv">latitude</span>
           <span class="nf">locationName</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">locationName</span>
    <span class="nf">locationDescription</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">locationDescription</span>
    <span class="nf">displayAddressLines</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">displayAddressLines</span>
            <span class="nf">phoneNumber</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">phoneNumber</span>
                  <span class="nf">image</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">image</span>
           <span class="nf">deliveryMode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLDeliveryMode.h@T@SDLDeliveryMode">SDLDeliveryMode</a></span><span class="p">)</span><span class="nv">deliveryMode</span>
              <span class="nf">timeStamp</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">timeStamp</span>
                <span class="nf">address</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLOasisAddress.html">SDLOasisAddress</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">address</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">longitude</span><span class="p">:</span> <span class="kt">Double</span><span class="p">,</span> <span class="nv">latitude</span><span class="p">:</span> <span class="kt">Double</span><span class="p">,</span> <span class="nv">locationName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">locationDescription</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">displayAddressLines</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?,</span> <span class="nv">phoneNumber</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">image</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</a></span><span class="p">?,</span> <span class="nv">deliveryMode</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLDeliveryMode.h@T@SDLDeliveryMode">SDLDeliveryMode</a></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">address</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOasisAddress.html">SDLOasisAddress</a></span><span class="p">?)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>longitude</dt>
      <dd><p>The longitudinal coordinate of the location</p></dd>
      <dt>latitude</dt>
      <dd><p>The latitudinal coordinate of the location</p></dd>
      <dt>locationName</dt>
      <dd><p>The user-facing name of the location</p></dd>
      <dt>locationDescription</dt>
      <dd><p>The user-facing description of the location</p></dd>
      <dt>displayAddressLines</dt>
      <dd><p>The user-facing address</p></dd>
      <dt>phoneNumber</dt>
      <dd><p>The phone number for the location; the user could use this to call the location</p></dd>
      <dt>image</dt>
      <dd><p>A user-facing image for the location</p></dd>
      <dt>deliveryMode</dt>
      <dd><p>How the location should be sent to the nav system</p></dd>
      <dt>timeStamp</dt>
      <dd><p>The estimated arrival time for the location (this will also likely be calculated by the nav system later, and may be different than your estimate). This is used to show the user approximately how long it would take to navigate here</p></dd>
      <dt>address</dt>
      <dd><p>The address information to be passed to the nav system for determining the route</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>A <code>SendLocation</code> object</p>
  </div>
  
  <h3 id="section-longitudeDegrees">
      longitudeDegrees
  </h3>
  
  <p>The longitudinal coordinate of the location. Either the latitude / longitude OR the <code><a href="../Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)address">address</a></code> must be provided.</p>

<p>Float, Optional, -180.0 - 180.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">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">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">longitudeDegrees</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">longitudeDegrees</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</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-latitudeDegrees">
      latitudeDegrees
  </h3>
  
  <p>The latitudinal coordinate of the location. Either the latitude / longitude OR the <code><a href="../Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)address">address</a></code> must be provided.</p>

<p>Float, Optional, -90.0 - 90.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">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">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">latitudeDegrees</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">latitudeDegrees</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</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-locationName">
      locationName
  </h3>
  
  <p>Name / title of intended location</p>

<p>Optional, Maxlength = 500 char</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">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">NSString</span> <span class="o">*</span><span class="n">locationName</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">locationName</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-locationDescription">
      locationDescription
  </h3>
  
  <p>Description of the intended location / establishment</p>

<p>Optional, MaxLength = 500 char</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">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">NSString</span> <span class="o">*</span><span class="n">locationDescription</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">locationDescription</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-addressLines">
      addressLines
  </h3>
  
  <p>Location address for display purposes only.</p>

<p>Contains String, Optional, Max Array Length = 4, Max String Length = 500</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">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">NSArray</span><span class="o">&lt;</span><span class="n">NSString</span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">addressLines</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">addressLines</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-phoneNumber">
      phoneNumber
  </h3>
  
  <p>Phone number of intended location / establishment</p>

<p>Optional, Max Length = 500</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">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">NSString</span> <span class="o">*</span><span class="n">phoneNumber</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">phoneNumber</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-locationImage">
      locationImage
  </h3>
  
  <p>Image / icon of intended location</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">locationImage</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">locationImage</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-deliveryMode">
      deliveryMode
  </h3>
  
  <p>Mode in which the sendLocation request is sent</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="../Type Definitions.html#/c:SDLDeliveryMode.h@T@SDLDeliveryMode">SDLDeliveryMode</a></span> <span class="n">deliveryMode</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">deliveryMode</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLDeliveryMode.h@T@SDLDeliveryMode">SDLDeliveryMode</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-timeStamp">
      timeStamp
  </h3>
  
  <p>Arrival time of Location. If multiple SendLocations are sent, this will be used for sorting as well.</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/SDLDateTime.html">SDLDateTime</a></span> <span class="o">*</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="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-address">
      address
  </h3>
  
  <p>Address to be used for setting destination. Either the latitude / longitude OR the <code>address</code> must be provided.</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/SDLOasisAddress.html">SDLOasisAddress</a></span> <span class="o">*</span><span class="n">address</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">address</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOasisAddress.html">SDLOasisAddress</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>