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

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithSendLocation:waypoints:">-initWithSendLocation:waypoints:</a></li>
  <li><a href="#section-sendLocationEnabled">sendLocationEnabled</a></li>
  <li><a href="#section-getWayPointsEnabled">getWayPointsEnabled</a></li>
</ul>

<h3>Overview</h3>

<p>Extended capabilities for an onboard navigation system</p>


<section class="section task-group-section">
  <h3 id="section--initWithSendLocation:waypoints:">
      -initWithSendLocation:waypoints:
  </h3>
  
  <p>Convenience init with 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">initWithSendLocation</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">sendLocationEnabled</span>
                                   <span class="nf">waypoints</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">waypointsEnabled</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="n">sendLocation</span> <span class="nv">sendLocationEnabled</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="n">waypoints</span> <span class="nv">waypointsEnabled</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>sendLocationEnabled</dt>
      <dd><p>Whether or not the SendLocation RPC is enabled</p></dd>
      <dt>waypointsEnabled</dt>
      <dd><p>Whether SDLNavigationInstruction.hor not Waypoint related RPCs are enabled</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An SDLNavigationCapability object</p>
  </div>
  
  <h3 id="section-sendLocationEnabled">
      sendLocationEnabled
  </h3>
  
  <p>Whether or not the SendLocation RPC is enabled.</p>

<p>Boolean, 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">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">*</span><span class="n">sendLocationEnabled</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">sendLocationEnabled</span><span class="p">:</span> <span class="kt">NSNumber</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-getWayPointsEnabled">
      getWayPointsEnabled
  </h3>
  
  <p>Whether or not Waypoint related RPCs are enabled.</p>

<p>Boolean, 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">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">*</span><span class="n">getWayPointsEnabled</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">getWayPointsEnabled</span><span class="p">:</span> <span class="kt">NSNumber</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>