Skip to content

Commit 1025c80

Browse files
nuclearacenuclearace
committed
update docs
1 parent 313032a commit 1025c80

38 files changed

+289
-73
lines changed

Diff for: ‎docs/12to13.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ <h2 id='what-to-call-connect-on' class='heading'>What to call connect on</h2>
274274
</article>
275275
</div>
276276
<section class="footer">
277-
<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-11-14)</p>
277+
<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-11-30)</p>
278278
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
279279
</section>
280280
</body>

Diff for: ‎docs/Classes.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ <h4>Declaration</h4>
446446
</article>
447447
</div>
448448
<section class="footer">
449-
<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-11-14)</p>
449+
<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-11-30)</p>
450450
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
451451
</section>
452452
</body>

Diff for: ‎docs/Classes/OnAckCallback.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ <h4>Parameters</h4>
272272
</article>
273273
</div>
274274
<section class="footer">
275-
<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-11-14)</p>
275+
<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-11-30)</p>
276276
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
277277
</section>
278278
</body>

Diff for: ‎docs/Classes/SSLSecurity.html

+19-1
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,13 @@ <h1>SSLSecurity</h1>
191191
<section class="section">
192192
<div class="section-content">
193193
<div class="task-group">
194+
<div class="task-name-container">
195+
<a name="/Properties"></a>
196+
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
197+
<a href="#/Properties">
198+
<h3 class="section-name">Properties</h3>
199+
</a>
200+
</div>
194201
<ul class="item-container">
195202
<li class="item">
196203
<div>
@@ -219,6 +226,17 @@ <h4>Declaration</h4>
219226
</section>
220227
</div>
221228
</li>
229+
</ul>
230+
</div>
231+
<div class="task-group">
232+
<div class="task-name-container">
233+
<a name="/Methods"></a>
234+
<a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
235+
<a href="#/Methods">
236+
<h3 class="section-name">Methods</h3>
237+
</a>
238+
</div>
239+
<ul class="item-container">
222240
<li class="item">
223241
<div>
224242
<code>
@@ -400,7 +418,7 @@ <h4>Return Value</h4>
400418
</article>
401419
</div>
402420
<section class="footer">
403-
<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-11-14)</p>
421+
<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-11-30)</p>
404422
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
405423
</section>
406424
</body>

Diff for: ‎docs/Classes/SocketAckEmitter.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -411,7 +411,7 @@ <h4>Parameters</h4>
411411
</article>
412412
</div>
413413
<section class="footer">
414-
<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-11-14)</p>
414+
<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-11-30)</p>
415415
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
416416
</section>
417417
</body>

Diff for: ‎docs/Classes/SocketAnyEvent.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ <h4>Declaration</h4>
288288
</article>
289289
</div>
290290
<section class="footer">
291-
<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-11-14)</p>
291+
<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-11-30)</p>
292292
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
293293
</section>
294294
</body>

Diff for: ‎docs/Classes/SocketEngine.html

+28-28
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,33 @@ <h4>Declaration</h4>
255255
</section>
256256
</div>
257257
</li>
258+
<li class="item">
259+
<div>
260+
<code>
261+
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)extraHeaders"></a>
262+
<a name="//apple_ref/swift/Property/extraHeaders" class="dashAnchor"></a>
263+
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)extraHeaders">extraHeaders</a>
264+
</code>
265+
</div>
266+
<div class="height-container">
267+
<div class="pointer-container"></div>
268+
<section class="section">
269+
<div class="pointer"></div>
270+
<div class="abstract">
271+
<p>A dictionary of extra http headers that will be set during connection.</p>
272+
273+
</div>
274+
<div class="declaration">
275+
<h4>Declaration</h4>
276+
<div class="language">
277+
<p class="aside-title">Swift</p>
278+
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">extraHeaders</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span> <span class="kt">String</span><span class="p">]?</span></code></pre>
279+
280+
</div>
281+
</div>
282+
</section>
283+
</div>
284+
</li>
258285
<li class="item">
259286
<div>
260287
<code>
@@ -452,33 +479,6 @@ <h4>Declaration</h4>
452479
</section>
453480
</div>
454481
</li>
455-
<li class="item">
456-
<div>
457-
<code>
458-
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)extraHeaders"></a>
459-
<a name="//apple_ref/swift/Property/extraHeaders" class="dashAnchor"></a>
460-
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)extraHeaders">extraHeaders</a>
461-
</code>
462-
</div>
463-
<div class="height-container">
464-
<div class="pointer-container"></div>
465-
<section class="section">
466-
<div class="pointer"></div>
467-
<div class="abstract">
468-
<p>A dictionary of extra http headers that will be set during connection.</p>
469-
470-
</div>
471-
<div class="declaration">
472-
<h4>Declaration</h4>
473-
<div class="language">
474-
<p class="aside-title">Swift</p>
475-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">extraHeaders</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span> <span class="kt">String</span><span class="p">]?</span></code></pre>
476-
477-
</div>
478-
</div>
479-
</section>
480-
</div>
481-
</li>
482482
<li class="item">
483483
<div>
484484
<code>
@@ -1496,7 +1496,7 @@ <h4>Declaration</h4>
14961496
</article>
14971497
</div>
14981498
<section class="footer">
1499-
<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-11-14)</p>
1499+
<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-11-30)</p>
15001500
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
15011501
</section>
15021502
</body>

Diff for: ‎docs/Classes/SocketIOClient.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1818,7 +1818,7 @@ <h4>Parameters</h4>
18181818
</article>
18191819
</div>
18201820
<section class="footer">
1821-
<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-11-14)</p>
1821+
<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-11-30)</p>
18221822
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
18231823
</section>
18241824
</body>

Diff for: ‎docs/Classes/SocketManager.html

+57-4
Original file line numberDiff line numberDiff line change
@@ -388,9 +388,9 @@ <h4>Declaration</h4>
388388
<li class="item">
389389
<div>
390390
<code>
391-
<a name="/s:8SocketIO0A7ManagerC4nspss10DictionaryVySSAA0A8IOClientCGv"></a>
391+
<a name="/c:@M@SocketIO@objc(cs)SocketManager(py)nsps"></a>
392392
<a name="//apple_ref/swift/Property/nsps" class="dashAnchor"></a>
393-
<a class="token" href="#/s:8SocketIO0A7ManagerC4nspss10DictionaryVySSAA0A8IOClientCGv">nsps</a>
393+
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(py)nsps">nsps</a>
394394
</code>
395395
</div>
396396
<div class="height-container">
@@ -923,7 +923,7 @@ <h4>Parameters</h4>
923923
<section class="section">
924924
<div class="pointer"></div>
925925
<div class="abstract">
926-
<p>Sends a client event to all sockets in <code><a href="../Classes/SocketManager.html#/s:8SocketIO0A7ManagerC4nspss10DictionaryVySSAA0A8IOClientCGv">nsps</a></code></p>
926+
<p>Sends a client event to all sockets in <code><a href="../Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)nsps">nsps</a></code></p>
927927

928928
</div>
929929
<div class="declaration">
@@ -1387,6 +1387,59 @@ <h4>Declaration</h4>
13871387
</section>
13881388
</div>
13891389
</li>
1390+
<li class="item">
1391+
<div>
1392+
<code>
1393+
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)removeSocket:"></a>
1394+
<a name="//apple_ref/swift/Method/removeSocket(_:)" class="dashAnchor"></a>
1395+
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)removeSocket:">removeSocket(_:)</a>
1396+
</code>
1397+
</div>
1398+
<div class="height-container">
1399+
<div class="pointer-container"></div>
1400+
<section class="section">
1401+
<div class="pointer"></div>
1402+
<div class="abstract">
1403+
<p>Removes the socket from the manager&rsquo;s control. One of the disconnect methods should be called before calling this
1404+
method.</p>
1405+
1406+
<p>After calling this method the socket should no longer be considered usable.</p>
1407+
1408+
</div>
1409+
<div class="declaration">
1410+
<h4>Declaration</h4>
1411+
<div class="language">
1412+
<p class="aside-title">Swift</p>
1413+
<pre class="highlight"><code><span class="n">open</span> <span class="kd">func</span> <span class="nf">removeSocket</span><span class="p">(</span><span class="n">_</span> <span class="nv">socket</span><span class="p">:</span> <span class="kt"><a href="../Classes/SocketIOClient.html">SocketIOClient</a></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>
1414+
1415+
</div>
1416+
</div>
1417+
<div>
1418+
<h4>Parameters</h4>
1419+
<table class="graybox">
1420+
<tbody>
1421+
<tr>
1422+
<td>
1423+
<code>
1424+
<em>socket</em>
1425+
</code>
1426+
</td>
1427+
<td>
1428+
<div>
1429+
<p>The socket to remove.</p>
1430+
</div>
1431+
</td>
1432+
</tr>
1433+
</tbody>
1434+
</table>
1435+
</div>
1436+
<div>
1437+
<h4>Return Value</h4>
1438+
<p>The socket removed, if it was owned by the manager.</p>
1439+
</div>
1440+
</section>
1441+
</div>
1442+
</li>
13901443
<li class="item">
13911444
<div>
13921445
<code>
@@ -1480,7 +1533,7 @@ <h4>Return Value</h4>
14801533
</article>
14811534
</div>
14821535
<section class="footer">
1483-
<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-11-14)</p>
1536+
<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-11-30)</p>
14841537
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
14851538
</section>
14861539
</body>

Diff for: ‎docs/Enums.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ <h4>Declaration</h4>
381381
</article>
382382
</div>
383383
<section class="footer">
384-
<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-11-14)</p>
384+
<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-11-30)</p>
385385
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
386386
</section>
387387
</body>

Diff for: ‎docs/Enums/SocketAckStatus.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ <h4>Declaration</h4>
227227
</article>
228228
</div>
229229
<section class="footer">
230-
<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-11-14)</p>
230+
<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-11-30)</p>
231231
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
232232
</section>
233233
</body>

Diff for: ‎docs/Enums/SocketClientEvent.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -492,7 +492,7 @@ <h4>Declaration</h4>
492492
</article>
493493
</div>
494494
<section class="footer">
495-
<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-11-14)</p>
495+
<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-11-30)</p>
496496
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
497497
</section>
498498
</body>

Diff for: ‎docs/Enums/SocketEnginePacketType.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ <h4>Declaration</h4>
413413
</article>
414414
</div>
415415
<section class="footer">
416-
<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-11-14)</p>
416+
<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-11-30)</p>
417417
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
418418
</section>
419419
</body>

Diff for: ‎docs/Enums/SocketIOClientOption.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -868,7 +868,7 @@ <h4>Return Value</h4>
868868
</article>
869869
</div>
870870
<section class="footer">
871-
<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-11-14)</p>
871+
<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-11-30)</p>
872872
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
873873
</section>
874874
</body>

Diff for: ‎docs/Enums/SocketIOStatus.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ <h4>Declaration</h4>
387387
</article>
388388
</div>
389389
<section class="footer">
390-
<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-11-14)</p>
390+
<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-11-30)</p>
391391
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
392392
</section>
393393
</body>

0 commit comments

Comments
 (0)