Skip to content

Commit 54c2b3b

Browse files
nuclearacenuclearace
committed
update docs
1 parent 8be2df0 commit 54c2b3b

25 files changed

+197
-87
lines changed

Diff for: ‎docs/Classes.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -364,8 +364,8 @@ <h4>Declaration</h4>
364364
</article>
365365
</div>
366366
<section class="footer">
367-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-08)</p>
368-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
367+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
368+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
369369
</section>
370370
</body>
371371
</div>

Diff for: ‎docs/Classes/OnAckCallback.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ <h4>Parameters</h4>
213213
<td>
214214
<div>
215215
<p>The callback called when an ack is received, or when a timeout happens.
216-
To check for timeout, use <code>SocketAckStatus</code>&rsquo;s <code>noAck</code> case.</p>
216+
To check for timeout, use <code>SocketAckStatus</code>&lsquo;s <code>noAck</code> case.</p>
217217
</div>
218218
</td>
219219
</tr>
@@ -231,8 +231,8 @@ <h4>Parameters</h4>
231231
</article>
232232
</div>
233233
<section class="footer">
234-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-08)</p>
235-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
234+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
235+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
236236
</section>
237237
</body>
238238
</div>

Diff for: ‎docs/Classes/SocketAckEmitter.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -301,8 +301,8 @@ <h4>Parameters</h4>
301301
</article>
302302
</div>
303303
<section class="footer">
304-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-08)</p>
305-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
304+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
305+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
306306
</section>
307307
</body>
308308
</div>

Diff for: ‎docs/Classes/SocketAnyEvent.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -247,8 +247,8 @@ <h4>Declaration</h4>
247247
</article>
248248
</div>
249249
<section class="footer">
250-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-08)</p>
251-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
250+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
251+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
252252
</section>
253253
</body>
254254
</div>

Diff for: ‎docs/Classes/SocketClientManager.html

+16-16
Original file line numberDiff line numberDiff line change
@@ -176,58 +176,58 @@ <h3 class="section-name">Properties.</h3>
176176
<li class="item">
177177
<div>
178178
<code>
179-
<a name="/s:ZvC8SocketIO19SocketClientManager13sharedManagerS0_"></a>
180-
<a name="//apple_ref/swift/Variable/sharedManager" class="dashAnchor"></a>
181-
<a class="token" href="#/s:ZvC8SocketIO19SocketClientManager13sharedManagerS0_">sharedManager</a>
179+
<a name="/s:iC8SocketIO19SocketClientManager9subscriptFSSGSqCS_14SocketIOClient_"></a>
180+
<a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
181+
<a class="token" href="#/s:iC8SocketIO19SocketClientManager9subscriptFSSGSqCS_14SocketIOClient_">subscript(_:)</a>
182182
</code>
183183
</div>
184184
<div class="height-container">
185185
<div class="pointer-container"></div>
186186
<section class="section">
187187
<div class="pointer"></div>
188188
<div class="abstract">
189-
<p>The shared manager.</p>
189+
<p>Gets a socket by its name.</p>
190190

191191
</div>
192192
<div class="declaration">
193193
<h4>Declaration</h4>
194194
<div class="language">
195195
<p class="aside-title">Swift</p>
196-
<pre class="highlight"><code><span class="n">open</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">sharedManager</span> <span class="o">=</span> <span class="kt">SocketClientManager</span><span class="p">()</span></code></pre>
196+
<pre class="highlight"><code><span class="n">open</span> <span class="nf">subscript</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/SocketIOClient.html">SocketIOClient</a></span><span class="p">?</span></code></pre>
197197

198198
</div>
199199
</div>
200+
<div>
201+
<h4>Return Value</h4>
202+
<p>The socket, if one had the given name.</p>
203+
</div>
200204
</section>
201205
</div>
202206
</li>
203207
<li class="item">
204208
<div>
205209
<code>
206-
<a name="/s:iC8SocketIO19SocketClientManager9subscriptFSSGSqCS_14SocketIOClient_"></a>
207-
<a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
208-
<a class="token" href="#/s:iC8SocketIO19SocketClientManager9subscriptFSSGSqCS_14SocketIOClient_">subscript(_:)</a>
210+
<a name="/s:ZvC8SocketIO19SocketClientManager13sharedManagerS0_"></a>
211+
<a name="//apple_ref/swift/Variable/sharedManager" class="dashAnchor"></a>
212+
<a class="token" href="#/s:ZvC8SocketIO19SocketClientManager13sharedManagerS0_">sharedManager</a>
209213
</code>
210214
</div>
211215
<div class="height-container">
212216
<div class="pointer-container"></div>
213217
<section class="section">
214218
<div class="pointer"></div>
215219
<div class="abstract">
216-
<p>Gets a socket by its name.</p>
220+
<p>The shared manager.</p>
217221

218222
</div>
219223
<div class="declaration">
220224
<h4>Declaration</h4>
221225
<div class="language">
222226
<p class="aside-title">Swift</p>
223-
<pre class="highlight"><code><span class="n">open</span> <span class="nf">subscript</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/SocketIOClient.html">SocketIOClient</a></span><span class="p">?</span></code></pre>
227+
<pre class="highlight"><code><span class="n">open</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">sharedManager</span> <span class="o">=</span> <span class="kt">SocketClientManager</span><span class="p">()</span></code></pre>
224228

225229
</div>
226230
</div>
227-
<div>
228-
<h4>Return Value</h4>
229-
<p>The socket, if one had the given name.</p>
230-
</div>
231231
</section>
232232
</div>
233233
</li>
@@ -435,8 +435,8 @@ <h4>Declaration</h4>
435435
</article>
436436
</div>
437437
<section class="footer">
438-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-08)</p>
439-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
438+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
439+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
440440
</section>
441441
</body>
442442
</div>

Diff for: ‎docs/Classes/SocketEngine.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -1425,8 +1425,8 @@ <h4>Declaration</h4>
14251425
</article>
14261426
</div>
14271427
<section class="footer">
1428-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-08)</p>
1429-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
1428+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
1429+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
14301430
</section>
14311431
</body>
14321432
</div>

Diff for: ‎docs/Classes/SocketIOClient.html

+112-2
Original file line numberDiff line numberDiff line change
@@ -1247,6 +1247,54 @@ <h4>Parameters</h4>
12471247
</section>
12481248
</div>
12491249
</li>
1250+
<li class="item">
1251+
<div>
1252+
<code>
1253+
<a name="/s:FC8SocketIO14SocketIOClient3offFT11clientEventOS_17SocketClientEvent_T_"></a>
1254+
<a name="//apple_ref/swift/Method/off(clientEvent:)" class="dashAnchor"></a>
1255+
<a class="token" href="#/s:FC8SocketIO14SocketIOClient3offFT11clientEventOS_17SocketClientEvent_T_">off(clientEvent:)</a>
1256+
</code>
1257+
</div>
1258+
<div class="height-container">
1259+
<div class="pointer-container"></div>
1260+
<section class="section">
1261+
<div class="pointer"></div>
1262+
<div class="abstract">
1263+
<p>Removes handler(s) for a client event.</p>
1264+
1265+
<p>If you wish to remove a client event handler, call the <code><a href="../Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient3offFT2idV10Foundation4UUID_T_">off(id:)</a></code> with the UUID received from its <code>on</code> call.</p>
1266+
1267+
</div>
1268+
<div class="declaration">
1269+
<h4>Declaration</h4>
1270+
<div class="language">
1271+
<p class="aside-title">Swift</p>
1272+
<pre class="highlight"><code><span class="n">open</span> <span class="kd">func</span> <span class="nf">off</span><span class="p">(</span><span class="n">clientEvent</span> <span class="nv">event</span><span class="p">:</span> <span class="kt"><a href="../Enums/SocketClientEvent.html">SocketClientEvent</a></span><span class="p">)</span></code></pre>
1273+
1274+
</div>
1275+
</div>
1276+
<div>
1277+
<h4>Parameters</h4>
1278+
<table class="graybox">
1279+
<tbody>
1280+
<tr>
1281+
<td>
1282+
<code>
1283+
<em>clientEvent</em>
1284+
</code>
1285+
</td>
1286+
<td>
1287+
<div>
1288+
<p>The event to remove handlers for.</p>
1289+
</div>
1290+
</td>
1291+
</tr>
1292+
</tbody>
1293+
</table>
1294+
</div>
1295+
</section>
1296+
</div>
1297+
</li>
12501298
<li class="item">
12511299
<div>
12521300
<code>
@@ -1473,6 +1521,68 @@ <h4>Return Value</h4>
14731521
</section>
14741522
</div>
14751523
</li>
1524+
<li class="item">
1525+
<div>
1526+
<code>
1527+
<a name="/s:FC8SocketIO14SocketIOClient4onceFT11clientEventOS_17SocketClientEvent8callbackFTGSaP__CS_16SocketAckEmitter_T__V10Foundation4UUID"></a>
1528+
<a name="//apple_ref/swift/Method/once(clientEvent:callback:)" class="dashAnchor"></a>
1529+
<a class="token" href="#/s:FC8SocketIO14SocketIOClient4onceFT11clientEventOS_17SocketClientEvent8callbackFTGSaP__CS_16SocketAckEmitter_T__V10Foundation4UUID">once(clientEvent:callback:)</a>
1530+
</code>
1531+
</div>
1532+
<div class="height-container">
1533+
<div class="pointer-container"></div>
1534+
<section class="section">
1535+
<div class="pointer"></div>
1536+
<div class="abstract">
1537+
<p>Adds a single-use handler for a client event.</p>
1538+
1539+
</div>
1540+
<div class="declaration">
1541+
<h4>Declaration</h4>
1542+
<div class="language">
1543+
<p class="aside-title">Swift</p>
1544+
<pre class="highlight"><code><span class="n">open</span> <span class="kd">func</span> <span class="nf">once</span><span class="p">(</span><span class="n">clientEvent</span> <span class="nv">event</span><span class="p">:</span> <span class="kt"><a href="../Enums/SocketClientEvent.html">SocketClientEvent</a></span><span class="p">,</span> <span class="nv">callback</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Typealiases.html#/s:8SocketIO14NormalCallback">NormalCallback</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">UUID</span></code></pre>
1545+
1546+
</div>
1547+
</div>
1548+
<div>
1549+
<h4>Parameters</h4>
1550+
<table class="graybox">
1551+
<tbody>
1552+
<tr>
1553+
<td>
1554+
<code>
1555+
<em>clientEvent</em>
1556+
</code>
1557+
</td>
1558+
<td>
1559+
<div>
1560+
<p>The event for this handler.</p>
1561+
</div>
1562+
</td>
1563+
</tr>
1564+
<tr>
1565+
<td>
1566+
<code>
1567+
<em>callback</em>
1568+
</code>
1569+
</td>
1570+
<td>
1571+
<div>
1572+
<p>The callback that will execute when this event is received.</p>
1573+
</div>
1574+
</td>
1575+
</tr>
1576+
</tbody>
1577+
</table>
1578+
</div>
1579+
<div>
1580+
<h4>Return Value</h4>
1581+
<p>A unique id for the handler that can be used to remove it.</p>
1582+
</div>
1583+
</section>
1584+
</div>
1585+
</li>
14761586
<li class="item">
14771587
<div>
14781588
<code>
@@ -1738,8 +1848,8 @@ <h4>Declaration</h4>
17381848
</article>
17391849
</div>
17401850
<section class="footer">
1741-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-08)</p>
1742-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
1851+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
1852+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
17431853
</section>
17441854
</body>
17451855
</div>

Diff for: ‎docs/Enums.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -308,8 +308,8 @@ <h4>Declaration</h4>
308308
</article>
309309
</div>
310310
<section class="footer">
311-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-08)</p>
312-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
311+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
312+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
313313
</section>
314314
</body>
315315
</div>

0 commit comments

Comments
 (0)