From 96ce620f69e567d520804e54655005e0b2be7c16 Mon Sep 17 00:00:00 2001 From: Erik Little Date: Tue, 14 Nov 2017 07:22:17 -0500 Subject: [PATCH] update docs --- docs/12to13.html | 2 +- docs/Classes.html | 2 +- docs/Classes/OnAckCallback.html | 2 +- docs/Classes/SSLSecurity.html | 2 +- docs/Classes/SocketAckEmitter.html | 2 +- docs/Classes/SocketAnyEvent.html | 2 +- docs/Classes/SocketEngine.html | 2 +- docs/Classes/SocketIOClient.html | 2 +- docs/Classes/SocketManager.html | 20 ++++++++++++++++++- docs/Enums.html | 2 +- docs/Enums/SocketAckStatus.html | 2 +- docs/Enums/SocketClientEvent.html | 2 +- docs/Enums/SocketEnginePacketType.html | 2 +- docs/Enums/SocketIOClientOption.html | 2 +- docs/Enums/SocketIOStatus.html | 2 +- docs/Enums/SocketParsableError.html | 2 +- docs/Guides.html | 2 +- docs/Protocols.html | 2 +- docs/Protocols/ConfigSettable.html | 2 +- docs/Protocols/SocketData.html | 2 +- docs/Protocols/SocketDataBufferable.html | 2 +- docs/Protocols/SocketEngineClient.html | 2 +- docs/Protocols/SocketEnginePollable.html | 2 +- docs/Protocols/SocketEngineSpec.html | 2 +- docs/Protocols/SocketEngineWebsocket.html | 2 +- docs/Protocols/SocketIOClientSpec.html | 2 +- docs/Protocols/SocketLogger.html | 2 +- docs/Protocols/SocketManagerSpec.html | 2 +- docs/Protocols/SocketParsable.html | 2 +- docs/Structs.html | 2 +- docs/Structs/SocketEventHandler.html | 2 +- docs/Structs/SocketIOClientConfiguration.html | 2 +- docs/Structs/SocketPacket.html | 2 +- docs/Structs/SocketPacket/PacketType.html | 2 +- docs/Typealiases.html | 2 +- docs/faq.html | 2 +- docs/index.html | 6 +++--- 37 files changed, 57 insertions(+), 39 deletions(-) diff --git a/docs/12to13.html b/docs/12to13.html index 4acabbe..5c7a610 100644 --- a/docs/12to13.html +++ b/docs/12to13.html @@ -274,7 +274,7 @@ and a connect event fired.

-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Classes.html b/docs/Classes.html index a6fa116..00718c7 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -446,7 +446,7 @@ or call one of the disconnectSocket methods on this class.

-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Classes/OnAckCallback.html b/docs/Classes/OnAckCallback.html index aa96d7b..973b83a 100644 --- a/docs/Classes/OnAckCallback.html +++ b/docs/Classes/OnAckCallback.html @@ -272,7 +272,7 @@ Example:

-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Classes/SSLSecurity.html b/docs/Classes/SSLSecurity.html index a32584a..1033710 100644 --- a/docs/Classes/SSLSecurity.html +++ b/docs/Classes/SSLSecurity.html @@ -400,7 +400,7 @@ validation

-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Classes/SocketAckEmitter.html b/docs/Classes/SocketAckEmitter.html index 29d2894..811264e 100644 --- a/docs/Classes/SocketAckEmitter.html +++ b/docs/Classes/SocketAckEmitter.html @@ -411,7 +411,7 @@ will be emitted. The structure of the error data is [ackNum, items, theErr
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Classes/SocketAnyEvent.html b/docs/Classes/SocketAnyEvent.html index 6a5dd46..81a3082 100644 --- a/docs/Classes/SocketAnyEvent.html +++ b/docs/Classes/SocketAnyEvent.html @@ -288,7 +288,7 @@
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Classes/SocketEngine.html b/docs/Classes/SocketEngine.html index d1f2b68..efef5b6 100644 --- a/docs/Classes/SocketEngine.html +++ b/docs/Classes/SocketEngine.html @@ -1496,7 +1496,7 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Classes/SocketIOClient.html b/docs/Classes/SocketIOClient.html index 73020dc..a74a6a5 100644 --- a/docs/Classes/SocketIOClient.html +++ b/docs/Classes/SocketIOClient.html @@ -1818,7 +1818,7 @@ Called when the manager detects a broken connection, or when a manual reconnect
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Classes/SocketManager.html b/docs/Classes/SocketManager.html index 76de52d..980abef 100644 --- a/docs/Classes/SocketManager.html +++ b/docs/Classes/SocketManager.html @@ -207,6 +207,13 @@ or call one of the disconnectSocket methods on this class.

+
+ + + +

Properties

+ +
  • @@ -518,6 +525,17 @@ So this should ideally be an array of one packet waiting for data.

+ + +
+
+ + + +

Initializers

+ +
+
  • @@ -1462,7 +1480,7 @@ Or call -

    © 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

    +

    © 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

    Generated by jazzy ♪♫ v0.9.0, a Realm project.

    diff --git a/docs/Enums.html b/docs/Enums.html index 18aa29e..bf2557b 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -381,7 +381,7 @@
    -

    © 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

    +

    © 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

    Generated by jazzy ♪♫ v0.9.0, a Realm project.

    diff --git a/docs/Enums/SocketAckStatus.html b/docs/Enums/SocketAckStatus.html index 7a188ec..41ace9c 100644 --- a/docs/Enums/SocketAckStatus.html +++ b/docs/Enums/SocketAckStatus.html @@ -227,7 +227,7 @@
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Enums/SocketClientEvent.html b/docs/Enums/SocketClientEvent.html index fd344b2..f6340b2 100644 --- a/docs/Enums/SocketClientEvent.html +++ b/docs/Enums/SocketClientEvent.html @@ -492,7 +492,7 @@ data item: the namespace that was connected to.

-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Enums/SocketEnginePacketType.html b/docs/Enums/SocketEnginePacketType.html index da38648..438b0cd 100644 --- a/docs/Enums/SocketEnginePacketType.html +++ b/docs/Enums/SocketEnginePacketType.html @@ -413,7 +413,7 @@
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Enums/SocketIOClientOption.html b/docs/Enums/SocketIOClientOption.html index faff207..5c30f06 100644 --- a/docs/Enums/SocketIOClientOption.html +++ b/docs/Enums/SocketIOClientOption.html @@ -868,7 +868,7 @@ over when reconnects happen.

-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Enums/SocketIOStatus.html b/docs/Enums/SocketIOStatus.html index 0aab9d6..7328f09 100644 --- a/docs/Enums/SocketIOStatus.html +++ b/docs/Enums/SocketIOStatus.html @@ -387,7 +387,7 @@
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Enums/SocketParsableError.html b/docs/Enums/SocketParsableError.html index 791ff94..a466e79 100644 --- a/docs/Enums/SocketParsableError.html +++ b/docs/Enums/SocketParsableError.html @@ -289,7 +289,7 @@
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Guides.html b/docs/Guides.html index a51dc43..64de2fb 100644 --- a/docs/Guides.html +++ b/docs/Guides.html @@ -189,7 +189,7 @@
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Protocols.html b/docs/Protocols.html index 19fa12f..2f5e6f8 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -566,7 +566,7 @@ or call one of the disconnectSocket methods on this class.

-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Protocols/ConfigSettable.html b/docs/Protocols/ConfigSettable.html index 210e54d..23d0b33 100644 --- a/docs/Protocols/ConfigSettable.html +++ b/docs/Protocols/ConfigSettable.html @@ -246,7 +246,7 @@
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Protocols/SocketData.html b/docs/Protocols/SocketData.html index c061279..1641c0b 100644 --- a/docs/Protocols/SocketData.html +++ b/docs/Protocols/SocketData.html @@ -255,7 +255,7 @@
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Protocols/SocketDataBufferable.html b/docs/Protocols/SocketDataBufferable.html index fab1d0a..2d2eea8 100644 --- a/docs/Protocols/SocketDataBufferable.html +++ b/docs/Protocols/SocketDataBufferable.html @@ -232,7 +232,7 @@ So this should ideally be an array of one packet waiting for data.

-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Protocols/SocketEngineClient.html b/docs/Protocols/SocketEngineClient.html index 9944f33..01119e0 100644 --- a/docs/Protocols/SocketEngineClient.html +++ b/docs/Protocols/SocketEngineClient.html @@ -491,7 +491,7 @@
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Protocols/SocketEnginePollable.html b/docs/Protocols/SocketEnginePollable.html index 271421f..4a8fba3 100644 --- a/docs/Protocols/SocketEnginePollable.html +++ b/docs/Protocols/SocketEnginePollable.html @@ -500,7 +500,7 @@ disconnect us.

-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Protocols/SocketEngineSpec.html b/docs/Protocols/SocketEngineSpec.html index 9dfad97..0c75977 100644 --- a/docs/Protocols/SocketEngineSpec.html +++ b/docs/Protocols/SocketEngineSpec.html @@ -1118,7 +1118,7 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Protocols/SocketEngineWebsocket.html b/docs/Protocols/SocketEngineWebsocket.html index 2adc8b1..7c8825f 100644 --- a/docs/Protocols/SocketEngineWebsocket.html +++ b/docs/Protocols/SocketEngineWebsocket.html @@ -353,7 +353,7 @@
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Protocols/SocketIOClientSpec.html b/docs/Protocols/SocketIOClientSpec.html index 0f27ebf..41eea75 100644 --- a/docs/Protocols/SocketIOClientSpec.html +++ b/docs/Protocols/SocketIOClientSpec.html @@ -1614,7 +1614,7 @@ Called when the manager detects a broken connection, or when a manual reconnect
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Protocols/SocketLogger.html b/docs/Protocols/SocketLogger.html index abcc051..73c2e0b 100644 --- a/docs/Protocols/SocketLogger.html +++ b/docs/Protocols/SocketLogger.html @@ -401,7 +401,7 @@
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Protocols/SocketManagerSpec.html b/docs/Protocols/SocketManagerSpec.html index e02e19a..ba330ce 100644 --- a/docs/Protocols/SocketManagerSpec.html +++ b/docs/Protocols/SocketManagerSpec.html @@ -832,7 +832,7 @@ Or call -

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Protocols/SocketParsable.html b/docs/Protocols/SocketParsable.html index bcf8d68..7f117a9 100644 --- a/docs/Protocols/SocketParsable.html +++ b/docs/Protocols/SocketParsable.html @@ -327,7 +327,7 @@ into the correct placeholder.

-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Structs.html b/docs/Structs.html index 7591aa4..b428d50 100644 --- a/docs/Structs.html +++ b/docs/Structs.html @@ -285,7 +285,7 @@
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Structs/SocketEventHandler.html b/docs/Structs/SocketEventHandler.html index 996ebf6..ad89f9d 100644 --- a/docs/Structs/SocketEventHandler.html +++ b/docs/Structs/SocketEventHandler.html @@ -369,7 +369,7 @@
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Structs/SocketIOClientConfiguration.html b/docs/Structs/SocketIOClientConfiguration.html index aa8d496..110b386 100644 --- a/docs/Structs/SocketIOClientConfiguration.html +++ b/docs/Structs/SocketIOClientConfiguration.html @@ -648,7 +648,7 @@
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Structs/SocketPacket.html b/docs/Structs/SocketPacket.html index 0777cb1..46dc9b8 100644 --- a/docs/Structs/SocketPacket.html +++ b/docs/Structs/SocketPacket.html @@ -492,7 +492,7 @@ event type packets.

-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Structs/SocketPacket/PacketType.html b/docs/Structs/SocketPacket/PacketType.html index 1a3967d..4eeccc9 100644 --- a/docs/Structs/SocketPacket/PacketType.html +++ b/docs/Structs/SocketPacket/PacketType.html @@ -413,7 +413,7 @@
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/Typealiases.html b/docs/Typealiases.html index 30863bb..1e60e2d 100644 --- a/docs/Typealiases.html +++ b/docs/Typealiases.html @@ -247,7 +247,7 @@
-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/faq.html b/docs/faq.html index 59bd761..9f3eb9a 100644 --- a/docs/faq.html +++ b/docs/faq.html @@ -223,7 +223,7 @@ will be released, along with the socket, and its memory reclaimed.

-

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

Generated by jazzy ♪♫ v0.9.0, a Realm project.

diff --git a/docs/index.html b/docs/index.html index 2e3629d..225583e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -272,7 +272,7 @@ SocketIOClient* socket = manager.defaultSocket;

Carthage

Add this line to your Cartfile:

-
github "socketio/socket.io-client-swift" ~> 13.0.0 # Or latest version
+
github "socketio/socket.io-client-swift" ~> 13.0.0
 

 
 
Run carthage update --platform ios,macosx.

@@ -284,7 +284,7 @@ SocketIOClient* socket = manager.defaultSocket;
 
use_frameworks!
 
 target 'YourApp' do
-    pod 'Socket.IO-Client-Swift', '~> 13.0.0' # Or latest version
+    pod 'Socket.IO-Client-Swift', '~> 13.0.0'
 end
 

 
@@ -325,7 +325,7 @@ SocketIOClient* socket = manager.defaultSocket;
       
     
     

-      
© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+      
© 2017 Erik. All rights reserved. (Last updated: 2017-11-14)

       
Generated by jazzy ♪♫ v0.9.0, a Realm project.