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

<h3>Section Contents</h3>

<ul>
  <li><a href="#section-rpcName">rpcName</a></li>
  <li><a href="#section-rpcAllowed">rpcAllowed</a></li>
  <li><a href="#section-rpcParameters">rpcParameters</a></li>
  <li><a href="#section--initWithRPCName:isRPCAllowed:rpcParameters:">-initWithRPCName:isRPCAllowed:rpcParameters:</a></li>
</ul>

<h3>Overview</h3>

<p>An object containing the result status of a permission element request</p>


<section class="section task-group-section">
  <h3 id="section-rpcName">
      rpcName
  </h3>
  
  <p>Name of the individual RPC.</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">readonly</span><span class="p">)</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLRPCFunctionNames.h@T@SDLRPCFunctionName">SDLRPCFunctionName</a></span> <span class="n">_Nonnull</span> <span class="n">rpcName</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">rpcName</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLRPCFunctionNames.h@T@SDLRPCFunctionName">SDLRPCFunctionName</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-rpcAllowed">
      rpcAllowed
  </h3>
  
  <p>Whether or not the RPC is allowed.</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">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isRPCAllowed</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">rpcAllowed</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">isRPCAllowed</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-rpcParameters">
      rpcParameters
  </h3>
  
  <p>Holds a dictionary of RPC parameters and objects of an NSNumber<BOOL> specifying if that RPC parameter is currently allowed</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">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSDictionary</span><span class="o">&lt;</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">NSNumber</span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">rpcParameters</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">rpcParameters</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</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="p">}</span></code></pre>

  
  
  
  <h3 id="section--initWithRPCName:isRPCAllowed:rpcParameters:">
      -initWithRPCName:isRPCAllowed:rpcParameters:
  </h3>
  
  <p>Initializes a SDLRPCPermissionStatus 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">initWithRPCName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLRPCFunctionNames.h@T@SDLRPCFunctionName">SDLRPCFunctionName</a></span><span class="p">)</span><span class="nv">rpcName</span>
                           <span class="nf">isRPCAllowed</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">isRPCAllowed</span>
                          <span class="nf">rpcParameters</span><span class="p">:</span>
                              <span class="p">(</span><span class="n">nullable</span> <span class="n">NSDictionary</span><span class="o">&lt;</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">NSNumber</span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span>
                                  <span class="n"><a href="../Classes/SDLRPCPermissionStatus.html#/c:objc(cs)SDLRPCPermissionStatus(py)rpcParameters">rpcParameters</a></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">rpcName</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLRPCFunctionNames.h@T@SDLRPCFunctionName">SDLRPCFunctionName</a></span><span class="p">,</span> <span class="nv">isRPCAllowed</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">rpcParameters</span><span class="p">:</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>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>rpcName</dt>
      <dd><p>The name of the RPC.</p></dd>
      <dt>isRPCAllowed</dt>
      <dd><p>The permission status for the RPC.</p></dd>
      <dt>rpcParameters</dt>
      <dd><p>A dictionary of RPC parameters and objects of an NSNumber<BOOL> specifying if that RPC parameter is currently allowed</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An instance of the SDLRPCPermissionStatus class.</p>
  </div>
  
</section>