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

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithType:">-initWithType:</a></li>
  <li><a href="#section-waypointType">waypointType</a></li>
</ul>

<h3>Overview</h3>

<p>This RPC allows you to get navigation waypoint data</p>

<p>@since RPC 4.1</p>


<section class="section task-group-section">
  <h3 id="section--initWithType:">
      -initWithType:
  </h3>
  
  <p>Convenience init to get waypoints.</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">initWithType</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLWayPointType.h@T@SDLWayPointType">SDLWayPointType</a></span><span class="p">)</span><span class="nv">type</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">type</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLWayPointType.h@T@SDLWayPointType">SDLWayPointType</a></span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>type</dt>
      <dd><p>To request for either the destination only or for all waypoints including destination</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An SDLGetWayPoints object</p>
  </div>
  
  <h3 id="section-waypointType">
      waypointType
  </h3>
  
  <p>To request for either the destination
 only or for all waypoints including destination</p>

<p>Required</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"><a href="../Type%20Definitions.html#/c:SDLWayPointType.h@T@SDLWayPointType">SDLWayPointType</a></span> <span class="n">waypointType</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">waypointType</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLWayPointType.h@T@SDLWayPointType">SDLWayPointType</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>