Skip to content

Commit f2ab06f

Browse files
nuclearacenuclearace
committed
update docs
1 parent 62eeba6 commit f2ab06f

33 files changed

+120
-111
lines changed

‎docs/Classes.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -465,8 +465,8 @@ <h4>Declaration</h4>
465465
</article>
466466
</div>
467467
<section class="footer">
468-
<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-05-07)</p>
469-
<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>
468+
<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-05-15)</p>
469+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
470470
</section>
471471
</body>
472472
</div>

‎docs/Classes/OnAckCallback.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ <h4>Parameters</h4>
248248
<td>
249249
<div>
250250
<p>The callback called when an ack is received, or when a timeout happens.
251-
To check for timeout, use <code>SocketAckStatus</code>&lsquo;s <code>noAck</code> case.</p>
251+
To check for timeout, use <code>SocketAckStatus</code>&rsquo;s <code>noAck</code> case.</p>
252252
</div>
253253
</td>
254254
</tr>
@@ -266,8 +266,8 @@ <h4>Parameters</h4>
266266
</article>
267267
</div>
268268
<section class="footer">
269-
<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-05-07)</p>
270-
<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>
269+
<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-05-15)</p>
270+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
271271
</section>
272272
</body>
273273
</div>

‎docs/Classes/SSLCert.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -288,8 +288,8 @@ <h4>Return Value</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-05-07)</p>
292-
<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>
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-05-15)</p>
292+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
293293
</section>
294294
</body>
295295
</div>

‎docs/Classes/SSLSecurity.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -381,8 +381,8 @@ <h4>Return Value</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-05-07)</p>
385-
<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>
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-05-15)</p>
385+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
386386
</section>
387387
</body>
388388
</div>

‎docs/Classes/SocketAckEmitter.html‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,9 @@ <h3 class="section-name">Methods</h3>
248248
<div class="abstract">
249249
<p>Call to ack receiving this event.</p>
250250

251+
<p>If an error occurs trying to transform <code>items</code> into their socket representation, a <code><a href="../Enums/SocketClientEvent.html#/s:FO8SocketIO17SocketClientEvent5errorFMS0_S0_">SocketClientEvent.error</a></code>
252+
will be emitted. The structure of the error data is <code>[ackNum, items, theError]</code></p>
253+
251254
</div>
252255
<div class="declaration">
253256
<h4>Declaration</h4>
@@ -333,8 +336,8 @@ <h4>Parameters</h4>
333336
</article>
334337
</div>
335338
<section class="footer">
336-
<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-05-07)</p>
337-
<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>
339+
<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-05-15)</p>
340+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
338341
</section>
339342
</body>
340343
</div>

‎docs/Classes/SocketAnyEvent.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282,8 +282,8 @@ <h4>Declaration</h4>
282282
</article>
283283
</div>
284284
<section class="footer">
285-
<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-05-07)</p>
286-
<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>
285+
<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-05-15)</p>
286+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
287287
</section>
288288
</body>
289289
</div>

‎docs/Classes/SocketClientManager.html‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -211,58 +211,58 @@ <h3 class="section-name">Properties.</h3>
211211
<li class="item">
212212
<div>
213213
<code>
214-
<a name="/s:iC8SocketIO19SocketClientManager9subscriptFSSGSqCS_14SocketIOClient_"></a>
215-
<a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
216-
<a class="token" href="#/s:iC8SocketIO19SocketClientManager9subscriptFSSGSqCS_14SocketIOClient_">subscript(_:)</a>
214+
<a name="/s:ZvC8SocketIO19SocketClientManager13sharedManagerS0_"></a>
215+
<a name="//apple_ref/swift/Variable/sharedManager" class="dashAnchor"></a>
216+
<a class="token" href="#/s:ZvC8SocketIO19SocketClientManager13sharedManagerS0_">sharedManager</a>
217217
</code>
218218
</div>
219219
<div class="height-container">
220220
<div class="pointer-container"></div>
221221
<section class="section">
222222
<div class="pointer"></div>
223223
<div class="abstract">
224-
<p>Gets a socket by its name.</p>
224+
<p>The shared manager.</p>
225225

226226
</div>
227227
<div class="declaration">
228228
<h4>Declaration</h4>
229229
<div class="language">
230230
<p class="aside-title">Swift</p>
231-
<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>
231+
<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>
232232

233233
</div>
234234
</div>
235-
<div>
236-
<h4>Return Value</h4>
237-
<p>The socket, if one had the given name.</p>
238-
</div>
239235
</section>
240236
</div>
241237
</li>
242238
<li class="item">
243239
<div>
244240
<code>
245-
<a name="/s:ZvC8SocketIO19SocketClientManager13sharedManagerS0_"></a>
246-
<a name="//apple_ref/swift/Variable/sharedManager" class="dashAnchor"></a>
247-
<a class="token" href="#/s:ZvC8SocketIO19SocketClientManager13sharedManagerS0_">sharedManager</a>
241+
<a name="/s:iC8SocketIO19SocketClientManager9subscriptFSSGSqCS_14SocketIOClient_"></a>
242+
<a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
243+
<a class="token" href="#/s:iC8SocketIO19SocketClientManager9subscriptFSSGSqCS_14SocketIOClient_">subscript(_:)</a>
248244
</code>
249245
</div>
250246
<div class="height-container">
251247
<div class="pointer-container"></div>
252248
<section class="section">
253249
<div class="pointer"></div>
254250
<div class="abstract">
255-
<p>The shared manager.</p>
251+
<p>Gets a socket by its name.</p>
256252

257253
</div>
258254
<div class="declaration">
259255
<h4>Declaration</h4>
260256
<div class="language">
261257
<p class="aside-title">Swift</p>
262-
<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>
258+
<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>
263259

264260
</div>
265261
</div>
262+
<div>
263+
<h4>Return Value</h4>
264+
<p>The socket, if one had the given name.</p>
265+
</div>
266266
</section>
267267
</div>
268268
</li>
@@ -470,8 +470,8 @@ <h4>Declaration</h4>
470470
</article>
471471
</div>
472472
<section class="footer">
473-
<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-05-07)</p>
474-
<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>
473+
<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-05-15)</p>
474+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
475475
</section>
476476
</body>
477477
</div>

‎docs/Classes/SocketEngine.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1461,8 +1461,8 @@ <h4>Declaration</h4>
14611461
</article>
14621462
</div>
14631463
<section class="footer">
1464-
<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-05-07)</p>
1465-
<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>
1464+
<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-05-15)</p>
1465+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
14661466
</section>
14671467
</body>
14681468
</div>

‎docs/Classes/SocketIOClient.html‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -733,6 +733,9 @@ <h4>Declaration</h4>
733733
<div class="abstract">
734734
<p>Send an event to the server, with optional data items.</p>
735735

736+
<p>If an error occurs trying to transform <code>items</code> into their socket representation, a <code><a href="../Enums/SocketClientEvent.html#/s:FO8SocketIO17SocketClientEvent5errorFMS0_S0_">SocketClientEvent.error</a></code>
737+
will be emitted. The structure of the error data is <code>[eventName, items, theError]</code></p>
738+
736739
</div>
737740
<div class="declaration">
738741
<h4>Declaration</h4>
@@ -852,6 +855,9 @@ <h4>Parameters</h4>
852855
<p><strong>NOTE</strong>: It is up to the server send an ack back, just calling this method does not mean the server will ack.
853856
Check that your server&rsquo;s api will ack the event being sent.</p>
854857

858+
<p>If an error occurs trying to transform <code>items</code> into their socket representation, a <code><a href="../Enums/SocketClientEvent.html#/s:FO8SocketIO17SocketClientEvent5errorFMS0_S0_">SocketClientEvent.error</a></code>
859+
will be emitted. The structure of the error data is <code>[eventName, items, theError]</code></p>
860+
855861
<p>Example:</p>
856862
<pre class="highlight swift"><code><span class="n">socket</span><span class="o">.</span><span class="nf">emitWithAck</span><span class="p">(</span><span class="s">"myEvent"</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="nf">timingOut</span><span class="p">(</span><span class="nv">after</span><span class="p">:</span> <span class="mi">1</span><span class="p">)</span> <span class="p">{</span><span class="n">data</span> <span class="k">in</span>
857863
<span class="o">...</span>
@@ -1286,7 +1292,7 @@ <h4>Parameters</h4>
12861292
<div class="abstract">
12871293
<p>Removes handler(s) based on an event name.</p>
12881294

1289-
<p>If you wish to remove a specific event, call the <code>off(if:)</code> with the UUID received from its <code>on</code> call.</p>
1295+
<p>If you wish to remove a specific event, 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>
12901296

12911297
</div>
12921298
<div class="declaration">
@@ -1762,8 +1768,8 @@ <h4>Declaration</h4>
17621768
</article>
17631769
</div>
17641770
<section class="footer">
1765-
<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-05-07)</p>
1766-
<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>
1771+
<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-05-15)</p>
1772+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
17671773
</section>
17681774
</body>
17691775
</div>

‎docs/Classes/WebSocket.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -906,8 +906,8 @@ <h4>Declaration</h4>
906906
</article>
907907
</div>
908908
<section class="footer">
909-
<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-05-07)</p>
910-
<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>
909+
<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-05-15)</p>
910+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
911911
</section>
912912
</body>
913913
</div>

0 commit comments

Comments
 (0)