blob: c983316257d1992dc3ef98fddd71b50e0315307f (
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
<h1>SDLRPCMessage Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section--initWithName:">-initWithName:</a></li>
<li><a href="#section--getFunctionName">-getFunctionName</a></li>
<li><a href="#section--setFunctionName:">-setFunctionName:</a></li>
<li><a href="#section--getParameters:">-getParameters:</a></li>
<li><a href="#section--setParameters:value:">-setParameters:value:</a></li>
<li><a href="#section-bulkData">bulkData</a></li>
<li><a href="#section-name">name</a></li>
<li><a href="#section-parameters">parameters</a></li>
<li><a href="#section-messageType">messageType</a></li>
</ul>
<h3>Overview</h3>
<p>Parent class of all RPC messages.</p>
<p>Contains basic information about an RPC message.</p>
<section class="section task-group-section">
<h3 id="section--initWithName:">
-initWithName:
</h3>
<p>Convenience init</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">initWithName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</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">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>name</dt>
<dd><p>The name of the message</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A SDLRPCMessage object</p>
</div>
<h3 id="section--getFunctionName">
-getFunctionName
</h3>
<p>Returns the function name.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="n">getFunctionName</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">getFunctionName</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span><span class="p">?</span></code></pre>
<div>
<h4>Return Value</h4>
<p>The function name</p>
</div>
<h3 id="section--setFunctionName:">
-setFunctionName:
</h3>
<p>Sets the function name.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">setFunctionName</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">setFunctionName</span><span class="p">(</span><span class="n">_</span> <span class="nv">functionName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>functionName</dt>
<dd><p>The function name</p></dd>
</dl>
<h3 id="section--getParameters:">
-getParameters:
</h3>
<p>Returns the value associated with the provided key. If the key does not exist, null is returned.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSObject</span> <span class="o">*</span><span class="p">)</span><span class="nf">getParameters</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">getParameters</span><span class="p">(</span><span class="n">_</span> <span class="nv">functionName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">NSObject</span><span class="p">?</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>functionName</dt>
<dd><p>The key name</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>The value associated with the function name</p>
</div>
<h3 id="section--setParameters:value:">
-setParameters:value:
</h3>
<p>Sets a key-value pair using the function name as the key.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">setParameters</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span>
<span class="nf">value</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSObject</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">setParameters</span><span class="p">(</span><span class="n">_</span> <span class="nv">functionName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">?)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>functionName</dt>
<dd><p>The name for the key</p></dd>
<dt>value</dt>
<dd><p>The value associated with the function name</p></dd>
</dl>
<h3 id="section-bulkData">
bulkData
</h3>
<p>The data in the message</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">NSData</span> <span class="o">*</span><span class="n">bulkData</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">bulkData</span><span class="p">:</span> <span class="kt">Data</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-name">
name
</h3>
<p>The name of the message</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">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">name</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<h3 id="section-parameters">
parameters
</h3>
<p>The JSON-RPC parameters</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">NSMutableDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">parameters</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">parameters</span><span class="p">:</span> <span class="kt">NSMutableDictionary</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<h3 id="section-messageType">
messageType
</h3>
<p>The type of data in the message</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">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">messageType</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">messageType</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</section>
|
