Skip to content

Commit 89b866a

Browse files
committed
update docs and bump version
1 parent 0013e7f commit 89b866a

39 files changed

+52
-46
lines changed

Diff for: README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Then import `import SocketIO`.
9292
### Carthage
9393
Add this line to your `Cartfile`:
9494
```
95-
github "socketio/socket.io-client-swift" ~> 10.1.0 # Or latest version
95+
github "socketio/socket.io-client-swift" ~> 10.2.0 # Or latest version
9696
```
9797

9898
Run `carthage update --platform ios,macosx`.
@@ -104,7 +104,7 @@ Create `Podfile` and add `pod 'Socket.IO-Client-Swift'`:
104104
use_frameworks!
105105

106106
target 'YourApp' do
107-
pod 'Socket.IO-Client-Swift', '~> 10.1.0' # Or latest version
107+
pod 'Socket.IO-Client-Swift', '~> 10.2.0' # Or latest version
108108
end
109109
```
110110

@@ -132,7 +132,7 @@ Objective-C:
132132
Add this line to your `Seedfile`:
133133

134134
```
135-
github "socketio/socket.io-client-swift", "v10.1.0", :files => "Source/*.swift" # Or latest version
135+
github "socketio/socket.io-client-swift", "v10.2.0", :files => "Source/*.swift" # Or latest version
136136
```
137137

138138
Run `seed install`.

Diff for: Socket.IO-Client-Swift.podspec

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Pod::Spec.new do |s|
22
s.name = "Socket.IO-Client-Swift"
33
s.module_name = "SocketIO"
4-
s.version = "10.1.0"
4+
s.version = "10.2.0"
55
s.summary = "Socket.IO-client for iOS and OS X"
66
s.description = <<-DESC
77
Socket.IO-client for iOS and OS X.
@@ -14,7 +14,7 @@ Pod::Spec.new do |s|
1414
s.ios.deployment_target = '8.0'
1515
s.osx.deployment_target = '10.10'
1616
s.tvos.deployment_target = '9.0'
17-
s.source = { :git => "https://github.com/socketio/socket.io-client-swift.git", :tag => 'v10.1.0' }
17+
s.source = { :git => "https://github.com/socketio/socket.io-client-swift.git", :tag => 'v10.2.0' }
1818
s.source_files = "Source/**/*.swift"
1919
s.libraries = 'z'
2020
s.preserve_paths = 'zlib/*'

Diff for: docs/Classes.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -479,7 +479,7 @@ <h4>Declaration</h4>
479479
</article>
480480
</div>
481481
<section class="footer">
482-
<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-07-02)</p>
482+
<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-07-04)</p>
483483
<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>
484484
</section>
485485
</body>

Diff for: docs/Classes/OnAckCallback.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -214,9 +214,9 @@ <h3 class="section-name">Methods</h3>
214214
<li class="item">
215215
<div>
216216
<code>
217-
<a name="/s:FC8SocketIO13OnAckCallback9timingOutFT5afterSi8callbackFGSaP__T__T_"></a>
217+
<a name="/s:FC8SocketIO13OnAckCallback9timingOutFT5afterSd8callbackFGSaP__T__T_"></a>
218218
<a name="//apple_ref/swift/Method/timingOut(after:callback:)" class="dashAnchor"></a>
219-
<a class="token" href="#/s:FC8SocketIO13OnAckCallback9timingOutFT5afterSi8callbackFGSaP__T__T_">timingOut(after:callback:)</a>
219+
<a class="token" href="#/s:FC8SocketIO13OnAckCallback9timingOutFT5afterSd8callbackFGSaP__T__T_">timingOut(after:callback:)</a>
220220
</code>
221221
</div>
222222
<div class="height-container">
@@ -231,7 +231,7 @@ <h3 class="section-name">Methods</h3>
231231
<h4>Declaration</h4>
232232
<div class="language">
233233
<p class="aside-title">Swift</p>
234-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">timingOut</span><span class="p">(</span><span class="n">after</span> <span class="nv">seconds</span><span class="p">:</span> <span class="kt">Int</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:8SocketIO11AckCallback">AckCallback</a></span><span class="p">)</span></code></pre>
234+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">timingOut</span><span class="p">(</span><span class="n">after</span> <span class="nv">seconds</span><span class="p">:</span> <span class="kt">Double</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:8SocketIO11AckCallback">AckCallback</a></span><span class="p">)</span></code></pre>
235235

236236
</div>
237237
</div>
@@ -278,7 +278,7 @@ <h4>Parameters</h4>
278278
</article>
279279
</div>
280280
<section class="footer">
281-
<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-07-02)</p>
281+
<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-07-04)</p>
282282
<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>
283283
</section>
284284
</body>

Diff for: docs/Classes/SSLCert.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ <h4>Return Value</h4>
300300
</article>
301301
</div>
302302
<section class="footer">
303-
<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-07-02)</p>
303+
<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-07-04)</p>
304304
<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>
305305
</section>
306306
</body>

Diff for: docs/Classes/SSLSecurity.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,7 @@ <h4>Return Value</h4>
393393
</article>
394394
</div>
395395
<section class="footer">
396-
<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-07-02)</p>
396+
<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-07-04)</p>
397397
<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>
398398
</section>
399399
</body>

Diff for: docs/Classes/SocketAckEmitter.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@ <h4>Parameters</h4>
348348
</article>
349349
</div>
350350
<section class="footer">
351-
<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-07-02)</p>
351+
<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-07-04)</p>
352352
<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>
353353
</section>
354354
</body>

Diff for: docs/Classes/SocketAnyEvent.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ <h4>Declaration</h4>
294294
</article>
295295
</div>
296296
<section class="footer">
297-
<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-07-02)</p>
297+
<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-07-04)</p>
298298
<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>
299299
</section>
300300
</body>

Diff for: docs/Classes/SocketClientManager.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -482,7 +482,7 @@ <h4>Declaration</h4>
482482
</article>
483483
</div>
484484
<section class="footer">
485-
<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-07-02)</p>
485+
<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-07-04)</p>
486486
<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>
487487
</section>
488488
</body>

Diff for: docs/Classes/SocketEngine.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1472,7 +1472,7 @@ <h4>Declaration</h4>
14721472
</article>
14731473
</div>
14741474
<section class="footer">
1475-
<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-07-02)</p>
1475+
<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-07-04)</p>
14761476
<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>
14771477
</section>
14781478
</body>

Diff for: docs/Classes/SocketIOClient.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1785,7 +1785,7 @@ <h4>Declaration</h4>
17851785
</article>
17861786
</div>
17871787
<section class="footer">
1788-
<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-07-02)</p>
1788+
<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-07-04)</p>
17891789
<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>
17901790
</section>
17911791
</body>

Diff for: docs/Classes/WebSocket.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1035,7 +1035,7 @@ <h4>Declaration</h4>
10351035
</article>
10361036
</div>
10371037
<section class="footer">
1038-
<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-07-02)</p>
1038+
<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-07-04)</p>
10391039
<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>
10401040
</section>
10411041
</body>

Diff for: docs/Classes/WebSocket/CloseCode.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -380,7 +380,7 @@ <h1>CloseCode</h1>
380380
</article>
381381
</div>
382382
<section class="footer">
383-
<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-07-02)</p>
383+
<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-07-04)</p>
384384
<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>
385385
</section>
386386
</body>

Diff for: docs/Classes/WebSocket/HTTPMethod.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ <h1>HTTPMethod</h1>
311311
</article>
312312
</div>
313313
<section class="footer">
314-
<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-07-02)</p>
314+
<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-07-04)</p>
315315
<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>
316316
</section>
317317
</body>

Diff for: docs/Classes/WebSocket/OpCode.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ <h1>OpCode</h1>
334334
</article>
335335
</div>
336336
<section class="footer">
337-
<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-07-02)</p>
337+
<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-07-04)</p>
338338
<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>
339339
</section>
340340
</body>

Diff for: docs/Classes/WebSocket/WSResponse.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ <h1>WSResponse</h1>
276276
</article>
277277
</div>
278278
<section class="footer">
279-
<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-07-02)</p>
279+
<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-07-04)</p>
280280
<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>
281281
</section>
282282
</body>

Diff for: docs/Enums.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@ <h4>Declaration</h4>
355355
</article>
356356
</div>
357357
<section class="footer">
358-
<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-07-02)</p>
358+
<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-07-04)</p>
359359
<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>
360360
</section>
361361
</body>

Diff for: docs/Enums/SocketAckStatus.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ <h4>Declaration</h4>
233233
</article>
234234
</div>
235235
<section class="footer">
236-
<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-07-02)</p>
236+
<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-07-04)</p>
237237
<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>
238238
</section>
239239
</body>

Diff for: docs/Enums/SocketClientEvent.html

+8-2
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,13 @@ <h1>SocketClientEvent</h1>
211211
<section class="section">
212212
<div class="pointer"></div>
213213
<div class="abstract">
214-
<p>Emitted when the client connects. This is also called on a successful reconnection.</p>
214+
<p>Emitted when the client connects. This is also called on a successful reconnection. A connect event gets one
215+
data item: the namespace that was connected to.</p>
216+
<pre class="highlight swift"><code><span class="n">socket</span><span class="o">.</span><span class="nf">on</span><span class="p">(</span><span class="nv">clientEvent</span><span class="p">:</span> <span class="o">.</span><span class="n">connect</span><span class="p">)</span> <span class="p">{</span><span class="n">data</span><span class="p">,</span> <span class="n">ack</span> <span class="k">in</span>
217+
<span class="k">guard</span> <span class="k">let</span> <span class="nv">nsp</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">as?</span> <span class="kt">String</span> <span class="k">else</span> <span class="p">{</span> <span class="k">return</span> <span class="p">}</span>
218+
<span class="c1">// Some logic using the nsp</span>
219+
<span class="p">}</span>
220+
</code></pre>
215221

216222
</div>
217223
<div class="declaration">
@@ -388,7 +394,7 @@ <h4>Declaration</h4>
388394
</article>
389395
</div>
390396
<section class="footer">
391-
<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-07-02)</p>
397+
<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-07-04)</p>
392398
<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>
393399
</section>
394400
</body>

Diff for: docs/Enums/SocketEnginePacketType.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -419,7 +419,7 @@ <h4>Declaration</h4>
419419
</article>
420420
</div>
421421
<section class="footer">
422-
<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-07-02)</p>
422+
<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-07-04)</p>
423423
<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>
424424
</section>
425425
</body>

Diff for: docs/Enums/SocketIOClientOption.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -969,7 +969,7 @@ <h4>Return Value</h4>
969969
</article>
970970
</div>
971971
<section class="footer">
972-
<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-07-02)</p>
972+
<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-07-04)</p>
973973
<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>
974974
</section>
975975
</body>

Diff for: docs/Enums/SocketIOClientStatus.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ <h4>Declaration</h4>
326326
</article>
327327
</div>
328328
<section class="footer">
329-
<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-07-02)</p>
329+
<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-07-04)</p>
330330
<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>
331331
</section>
332332
</body>

0 commit comments

Comments
 (0)