summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLPermissionManager.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Classes/SDLPermissionManager.html')
-rw-r--r--docs/Classes/SDLPermissionManager.html32
1 files changed, 9 insertions, 23 deletions
diff --git a/docs/Classes/SDLPermissionManager.html b/docs/Classes/SDLPermissionManager.html
index 608e88a4a..516db2a03 100644
--- a/docs/Classes/SDLPermissionManager.html
+++ b/docs/Classes/SDLPermissionManager.html
@@ -40,8 +40,7 @@
<h4>Parameters</h4>
<dl>
<dt>completionHandler</dt>
- <dd><p>The block to be called when the manager&rsquo;s setup is complete.</p>
-</dd>
+ <dd><p>The block to be called when the manager&rsquo;s setup is complete.</p></dd>
</dl>
<h3 id="section--stop">
@@ -82,13 +81,11 @@
<h4>Parameters</h4>
<dl>
<dt>rpcName</dt>
- <dd><p>The name of the RPC to be tested, for example, SDLShow</p>
-</dd>
+ <dd><p>The name of the RPC to be tested, for example, SDLShow</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>YES if the RPC is allowed at the current HMI level, NO if not</p>
-
</div>
<h3 id="section--groupStatusOfRPCs:">
@@ -112,13 +109,11 @@
<h4>Parameters</h4>
<dl>
<dt>rpcNames</dt>
- <dd><p>The RPCs to check</p>
-</dd>
+ <dd><p>The RPCs to check</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>AllAllowed if all of the permissions are allowed, AllDisallowed if all the permissions are disallowed, Any if some are allowed, and some are disallowed</p>
-
</div>
<h3 id="section--statusOfRPCs:">
@@ -135,20 +130,18 @@
<h4>Swift</h4>
- <pre class="highlight"><code><span class="kd">func</span> <span class="nf">status</span><span class="p">(</span><span class="n">ofRPCs</span> <span class="nv">rpcNames</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">NSNumber</span><span class="p">]</span></code></pre>
+ <pre class="highlight"><code><span class="kd">func</span> <span class="nf">status</span><span class="p">(</span><span class="n">ofRPCs</span> <span class="nv">rpcNames</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">NSNumber</span> </code></pre>
<h4>Parameters</h4>
<dl>
<dt>rpcNames</dt>
- <dd><p>An array of RPC names to check</p>
-</dd>
+ <dd><p>An array of RPC names to check</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A dictionary specifying if the passed in RPC names are currently allowed or not</p>
-
</div>
<h3 id="section--addObserverForRPCs:groupType:withHandler:">
@@ -156,13 +149,11 @@
</h3>
<p>Add an observer for specified RPC names, with a callback that will be called whenever the value changes, as well as immediately with the current status.</p>
-
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
<p>This block will be captured by the SDLPermissionsManager, be sure to use <a href="http://www.logicsector.com/ios/avoiding-objc-retain-cycles-with-weakself-and-strongself-the-easy-way/">weakself/strongself</a> if you are referencing self within your observer block.</p>
</div>
-
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
<p>The observer may be called before this method returns, do not attempt to remove the observer from within the observer. That could send <code>nil</code> to removeObserverForIdentifier:. If you want functionality like that, call groupStatusOfRPCs: instead.</p>
@@ -186,19 +177,15 @@
<h4>Parameters</h4>
<dl>
<dt>rpcNames</dt>
- <dd><p>The RPCs to be observed</p>
-</dd>
+ <dd><p>The RPCs to be observed</p></dd>
<dt>groupType</dt>
- <dd><p>Affects the times that the observer block will be called. If Any, any change to any RPC in rpcNames will cause the observer block to be called. If AllAllowed, the block will be called when: 1. Every RPC in rpcNames becomes allowed 2. The group of rpcNames goes from all being allowed to some or all being disallowed.</p>
-</dd>
+ <dd><p>Affects the times that the observer block will be called. If Any, any change to any RPC in rpcNames will cause the observer block to be called. If AllAllowed, the block will be called when: 1. Every RPC in rpcNames becomes allowed 2. The group of rpcNames goes from all being allowed to some or all being disallowed.</p></dd>
<dt>handler</dt>
- <dd><p>The block that will be called whenever permissions change.</p>
-</dd>
+ <dd><p>The block that will be called whenever permissions change.</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>An identifier that can be passed to removeObserverForIdentifer: to remove the observer</p>
-
</div>
<h3 id="section--removeAllObservers">
@@ -240,8 +227,7 @@
<h4>Parameters</h4>
<dl>
<dt>identifier</dt>
- <dd><p>The identifier specifying which observer to remove</p>
-</dd>
+ <dd><p>The identifier specifying which observer to remove</p></dd>
</dl>
</section>