From 817f36e80bfe3eda1a9fe2720011c6cace5ebd91 Mon Sep 17 00:00:00 2001 From: Erik Little Date: Mon, 24 Jul 2017 07:18:00 -0400 Subject: [PATCH] update docs --- README.md | 8 +- docs/Classes.html | 121 +- docs/Classes/OnAckCallback.html | 55 +- docs/Classes/SSLCert.html | 308 ----- docs/Classes/SSLSecurity.html | 401 ------- docs/Classes/SocketAckEmitter.html | 53 +- docs/Classes/SocketAnyEvent.html | 53 +- docs/Classes/SocketClientManager.html | 81 +- docs/Classes/SocketEngine.html | 71 +- docs/Classes/SocketIOClient.html | 53 +- docs/Classes/WebSocket.html | 1043 ----------------- docs/Classes/WebSocket/CloseCode.html | 388 ------ docs/Classes/WebSocket/HTTPMethod.html | 319 ----- docs/Classes/WebSocket/OpCode.html | 342 ------ docs/Classes/WebSocket/WSResponse.html | 284 ----- docs/Enums.html | 53 +- docs/Enums/SocketAckStatus.html | 53 +- docs/Enums/SocketClientEvent.html | 53 +- docs/Enums/SocketEnginePacketType.html | 53 +- docs/Enums/SocketIOClientOption.html | 59 +- docs/Enums/SocketIOClientStatus.html | 53 +- docs/Global Variables.html | 264 ----- docs/Protocols.html | 143 +-- docs/Protocols/SSLTrustValidator.html | 227 ---- docs/Protocols/SocketData.html | 53 +- docs/Protocols/SocketEngineClient.html | 53 +- docs/Protocols/SocketEnginePollable.html | 53 +- docs/Protocols/SocketEngineSpec.html | 59 +- docs/Protocols/SocketEngineWebsocket.html | 67 +- docs/Protocols/SocketLogger.html | 53 +- docs/Protocols/WebSocketAdvancedDelegate.html | 322 ----- docs/Protocols/WebSocketDelegate.html | 284 ----- docs/Protocols/WebSocketPongDelegate.html | 227 ---- docs/Structs.html | 53 +- docs/Structs/SocketIOClientConfiguration.html | 93 +- docs/Typealiases.html | 53 +- docs/badge.svg | 2 +- docs/index.html | 67 +- docs/search.json | 2 +- 39 files changed, 140 insertions(+), 5839 deletions(-) delete mode 100644 docs/Classes/SSLCert.html delete mode 100644 docs/Classes/SSLSecurity.html delete mode 100644 docs/Classes/WebSocket.html delete mode 100644 docs/Classes/WebSocket/CloseCode.html delete mode 100644 docs/Classes/WebSocket/HTTPMethod.html delete mode 100644 docs/Classes/WebSocket/OpCode.html delete mode 100644 docs/Classes/WebSocket/WSResponse.html delete mode 100644 docs/Global Variables.html delete mode 100644 docs/Protocols/SSLTrustValidator.html delete mode 100644 docs/Protocols/WebSocketAdvancedDelegate.html delete mode 100644 docs/Protocols/WebSocketDelegate.html delete mode 100644 docs/Protocols/WebSocketPongDelegate.html diff --git a/README.md b/README.md index e9170169..efda7f3a 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ import PackageDescription let package = Package( name: "YourSocketIOProject", dependencies: [ - .Package(url: "https://github.com/socketio/socket.io-client-swift", majorVersion: 10) + .Package(url: "https://github.com/socketio/socket.io-client-swift", majorVersion: 11) ] ) ``` @@ -88,7 +88,7 @@ Then import `import SocketIO`. ### Carthage Add this line to your `Cartfile`: ``` -github "socketio/socket.io-client-swift" ~> 10.2.0 # Or latest version +github "socketio/socket.io-client-swift" ~> 11.0.0 # Or latest version ``` Run `carthage update --platform ios,macosx`. @@ -100,7 +100,7 @@ Create `Podfile` and add `pod 'Socket.IO-Client-Swift'`: use_frameworks! target 'YourApp' do - pod 'Socket.IO-Client-Swift', '~> 10.2.0' # Or latest version + pod 'Socket.IO-Client-Swift', '~> 11.0.0' # Or latest version end ``` @@ -128,7 +128,7 @@ Objective-C: Add this line to your `Seedfile`: ``` -github "socketio/socket.io-client-swift", "v10.2.0", :files => "Source/*.swift" # Or latest version +github "socketio/socket.io-client-swift", "v11.0.0", :files => "Source/*.swift" # Or latest version ``` Run `seed install`. diff --git a/docs/Classes.html b/docs/Classes.html index ac551fe0..f556d56c 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -22,7 +22,7 @@ SocketIO Docs - (77% documented) + (100% documented)

@@ -49,12 +49,6 @@

- - @@ -70,35 +64,6 @@ - - - - - - - - -
- -
-
- -
diff --git a/docs/Classes/OnAckCallback.html b/docs/Classes/OnAckCallback.html index ead33783..4fc0ffaa 100644 --- a/docs/Classes/OnAckCallback.html +++ b/docs/Classes/OnAckCallback.html @@ -23,7 +23,7 @@ SocketIO Docs - (77% documented) + (100% documented)

@@ -50,12 +50,6 @@

- - @@ -71,35 +65,6 @@ - - - - - - - - - - @@ -71,35 +65,6 @@ - - - - - - - - - - @@ -71,35 +65,6 @@ - - - - - - - - - - @@ -71,35 +65,6 @@ - - - - - - - -
  • - - - subscript(_:) + + + sharedManager
    @@ -233,30 +186,26 @@

    Properties.

    -

    Gets a socket by its name.

    +

    The shared manager.

    Declaration

    Swift

    -
    open subscript(string: String) -> SocketIOClient?
    +
    open static let sharedManager = SocketClientManager()
    -
    -

    Return Value

    -

    The socket, if one had the given name.

    -
  • - - - sharedManager + + + subscript(_:)
    @@ -264,17 +213,21 @@

    Return Value

    -

    The shared manager.

    +

    Gets a socket by its name.

    Declaration

    Swift

    -
    open static let sharedManager = SocketClientManager()
    +
    open subscript(string: String) -> SocketIOClient?
    +
    +

    Return Value

    +

    The socket, if one had the given name.

    +
  • @@ -482,8 +435,8 @@

    Declaration

    diff --git a/docs/Classes/SocketEngine.html b/docs/Classes/SocketEngine.html index 6a45fcd4..452497f6 100644 --- a/docs/Classes/SocketEngine.html +++ b/docs/Classes/SocketEngine.html @@ -23,7 +23,7 @@ SocketIO Docs - (77% documented) + (100% documented)

    @@ -50,12 +50,6 @@

    - - @@ -71,35 +65,6 @@ - - - - - - - -
  • - + - ws + ws
    @@ -830,7 +783,7 @@

    Declaration

    Declaration

    Swift

    -
    public private(set) var ws: WebSocket?
    +
    public private(set) var ws: WebSocket?
    @@ -1375,9 +1328,9 @@

    Starscream delegate conformance

  • - + - websocketDidConnect(socket:) + websocketDidConnect(socket:)
    @@ -1392,7 +1345,7 @@

    Starscream delegate conformance

    Declaration

    Swift

    -
    public func websocketDidConnect(socket: WebSocket)
    +
    public func websocketDidConnect(socket: WebSocket)
    @@ -1402,9 +1355,9 @@

    Declaration

  • - + - websocketDidDisconnect(socket:error:) + websocketDidDisconnect(socket:error:)
    @@ -1419,7 +1372,7 @@

    Declaration

    Declaration

    Swift

    -
    public func websocketDidDisconnect(socket: WebSocket, error: NSError?)
    +
    public func websocketDidDisconnect(socket: WebSocket, error: NSError?)
    @@ -1472,8 +1425,8 @@

    Declaration

    diff --git a/docs/Classes/SocketIOClient.html b/docs/Classes/SocketIOClient.html index c29b447f..1ed30e3f 100644 --- a/docs/Classes/SocketIOClient.html +++ b/docs/Classes/SocketIOClient.html @@ -23,7 +23,7 @@ SocketIO Docs - (77% documented) + (100% documented)

    @@ -50,12 +50,6 @@

  • - - @@ -71,35 +65,6 @@ - - - - - - - - - - @@ -70,35 +64,6 @@ - - - - - - - - - - @@ -71,35 +65,6 @@ - - - - - - - - - - @@ -71,35 +65,6 @@ - - - - - - - - - - @@ -71,35 +65,6 @@ - - - - - - - - - - @@ -71,35 +65,6 @@ - - - - - - - -
  • - + - security + security
    @@ -749,7 +702,7 @@

    Declaration

    Declaration

    Swift

    -
    case security(SSLSecurity)
    +
    case security(SSLSecurity)
    @@ -969,8 +922,8 @@

    Return Value

    diff --git a/docs/Enums/SocketIOClientStatus.html b/docs/Enums/SocketIOClientStatus.html index 026a5c51..ef760ed2 100644 --- a/docs/Enums/SocketIOClientStatus.html +++ b/docs/Enums/SocketIOClientStatus.html @@ -23,7 +23,7 @@ SocketIO Docs - (77% documented) + (100% documented)

    @@ -50,12 +50,6 @@

  • - - @@ -71,35 +65,6 @@ - - - - - - - - - - @@ -70,35 +64,6 @@ - - - - - - - - -
    - -
    -
    - -
    diff --git a/docs/Protocols/SSLTrustValidator.html b/docs/Protocols/SSLTrustValidator.html deleted file mode 100644 index e160a7f9..00000000 --- a/docs/Protocols/SSLTrustValidator.html +++ /dev/null @@ -1,227 +0,0 @@ - - - - SSLTrustValidator Protocol Reference - - - - - - - - - - - - - - - - -
    -

    - - SocketIO Docs - - (77% documented) -

    - -

    -

    - -
    -

    - - -
    - - - -
    - -
    - -
    -
    -

    SSLTrustValidator

    -

    Undocumented

    - -
    -
    - -
    -
    -
    - -
    -
    -
    - -
    -
    - - - - diff --git a/docs/Protocols/SocketData.html b/docs/Protocols/SocketData.html index b6b4c837..1e6a346b 100644 --- a/docs/Protocols/SocketData.html +++ b/docs/Protocols/SocketData.html @@ -23,7 +23,7 @@ SocketIO Docs - (77% documented) + (100% documented)

    @@ -50,12 +50,6 @@

    - - @@ -71,35 +65,6 @@ - - - - - - - - - - @@ -71,35 +65,6 @@ - - - - - - - - - - @@ -71,35 +65,6 @@ - - - - - - - - - - @@ -71,35 +65,6 @@ - - - - - - - -
  • - + - ws + ws
    @@ -677,7 +630,7 @@

    Declaration

    Declaration

    Swift

    -
    var ws: WebSocket?
    +
    var ws: WebSocket?
    @@ -1097,8 +1050,8 @@

    Parameters

    diff --git a/docs/Protocols/SocketEngineWebsocket.html b/docs/Protocols/SocketEngineWebsocket.html index f8e75d11..6acc624a 100644 --- a/docs/Protocols/SocketEngineWebsocket.html +++ b/docs/Protocols/SocketEngineWebsocket.html @@ -23,7 +23,7 @@ SocketIO Docs - (77% documented) + (100% documented)

    @@ -50,12 +50,6 @@

  • - - @@ -71,35 +65,6 @@ - - - - - - - -
  • - + - websocketDidReceiveMessage(socket:text:) + websocketDidReceiveMessage(socket:text:) Extension method @@ -314,7 +267,7 @@

    Starscream delegate methods

    Declaration

    Swift

    -
    public func websocketDidReceiveMessage(socket: WebSocket, text: String)
    +
    public func websocketDidReceiveMessage(socket: WebSocket, text: String)
    @@ -324,9 +277,9 @@

    Declaration

  • - + - websocketDidReceiveData(socket:data:) + websocketDidReceiveData(socket:data:) Extension method @@ -344,7 +297,7 @@

    Declaration

    Declaration

    Swift

    -
    public func websocketDidReceiveData(socket: WebSocket, data: Data)
    +
    public func websocketDidReceiveData(socket: WebSocket, data: Data)
    @@ -359,8 +312,8 @@

    Declaration

    diff --git a/docs/Protocols/SocketLogger.html b/docs/Protocols/SocketLogger.html index a1f0ec76..4cc2c358 100644 --- a/docs/Protocols/SocketLogger.html +++ b/docs/Protocols/SocketLogger.html @@ -23,7 +23,7 @@ SocketIO Docs - (77% documented) + (100% documented)

    @@ -50,12 +50,6 @@

  • - - @@ -71,35 +65,6 @@ - - - - - - - - - - @@ -70,35 +64,6 @@ - - - - - - - - - - @@ -71,35 +65,6 @@ - - - - - - - -
  • - - - Iterator + + + Element
    @@ -218,14 +171,14 @@

    Typealiases

    -

    Iterator type.

    +

    Type of element stored.

    Declaration

    Swift

    -
    public typealias Iterator = Array<SocketIOClientOption>.Iterator
    +
    public typealias Element = SocketIOClientOption
    @@ -235,9 +188,9 @@

    Declaration

  • - - - Element + + + Index
    @@ -245,14 +198,14 @@

    Declaration

    -

    Type of element stored.

    +

    Index type.

    Declaration

    Swift

    -
    public typealias Element = SocketIOClientOption
    +
    public typealias Index = Array<SocketIOClientOption>.Index
    @@ -262,9 +215,9 @@

    Declaration

  • - - - SubSequence + + + Iterator
    @@ -272,14 +225,14 @@

    Declaration

    -

    SubSequence type.

    +

    Iterator type.

    Declaration

    Swift

    -
    public typealias SubSequence =  Array<SocketIOClientOption>.SubSequence
    +
    public typealias Iterator = Array<SocketIOClientOption>.Iterator
    @@ -289,9 +242,9 @@

    Declaration

  • - - - Index + + + SubSequence
    @@ -299,14 +252,14 @@

    Declaration

    -

    Index type.

    +

    SubSequence type.

    Declaration

    Swift

    -
    public typealias Index = Array<SocketIOClientOption>.Index
    +
    public typealias SubSequence =  Array<SocketIOClientOption>.SubSequence
    @@ -654,8 +607,8 @@

    Parameters

  • diff --git a/docs/Typealiases.html b/docs/Typealiases.html index 610c1211..8c82ecb8 100644 --- a/docs/Typealiases.html +++ b/docs/Typealiases.html @@ -22,7 +22,7 @@ SocketIO Docs - (77% documented) + (100% documented)

    @@ -49,12 +49,6 @@

  • - - @@ -70,35 +64,6 @@ - - - - - - -
  • -
    diff --git a/docs/badge.svg b/docs/badge.svg index d11b760b..2606d804 100644 --- a/docs/badge.svg +++ b/docs/badge.svg @@ -1 +1 @@ -documentationdocumentation77%77% \ No newline at end of file +documentationdocumentation100%100% \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index a96e718b..c974b2a6 100644 --- a/docs/index.html +++ b/docs/index.html @@ -22,7 +22,7 @@ SocketIO Docs - (77% documented) + (100% documented)

    @@ -49,12 +49,6 @@

  • - - @@ -70,35 +64,6 @@ - - - - - - - -