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

<h3>Section Contents</h3>

<ul>
  <li><a href="#section-allocatedModules">allocatedModules</a></li>
  <li><a href="#section-freeModules">freeModules</a></li>
  <li><a href="#section-allowed">allowed</a></li>
</ul>

<h3>Overview</h3>

<p>OnRCStatus notifications to all registered mobile applications and the HMI whenever
 (1) SDL allocates a module to an application or
 (2) it de-allocates a module from an application, or
 (3) an application registers with SDL</p>


<section class="section task-group-section">
  <h3 id="section-allocatedModules">
      allocatedModules
  </h3>
  
  <p>@abstract Contains a list (zero or more) of module types that
 are allocated to the application.</p>

<p>Required, Array of SDLModuleData, Array size 0 - 100</p>
<div class="aside aside-see">
    <p class="aside-title">See</p>
    SDLPermissionItem

</div>

  
  
  <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">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLModuleData.html">SDLModuleData</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">allocatedModules</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">allocatedModules</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLModuleData.html">SDLModuleData</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-freeModules">
      freeModules
  </h3>
  
  <p>@abstract Contains a list (zero or more) of module types that are free to access for the application.</p>

<p>Required, Array of SDLModuleData, Array size 0 - 100</p>
<div class="aside aside-see">
    <p class="aside-title">See</p>
    SDLPermissionItem

</div>

  
  
  <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">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLModuleData.html">SDLModuleData</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">freeModules</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">freeModules</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLModuleData.html">SDLModuleData</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-allowed">
      allowed
  </h3>
  
  <p>Issued by SDL to notify the application about remote control status change on SDL
If <q>true</q> - RC is allowed; if <q>false</q> - RC is disallowed.</p>

<p>optional, Boolean, default Value = false</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">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">allowed</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">allowed</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)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>

  
  
  
</section>