Merge pull request #1 from cbajapan/documentation

Preparing for official 4.0.0 release
cbajapan · Apr 4, 2022 · 517f726 · 517f726
2 parents c883d3d + 5435877
commit 517f726
Show file tree

Hide file tree

Showing 89 changed files with 2,457 additions and 39 deletions.
diff --git a/Package.swift b/Package.swift
@@ -5,23 +5,22 @@ import PackageDescription
 
 let package = Package(
     name: "swift-fcsdk-ios",
+    platforms: [.iOS(.v13), .macOS(.v11)],
     products: [
         .library(
-            name: "SwiftFCSDKiOS",
+            name: "FCSDKiOS",
             type: .static,
             targets: ["SwiftFCSDKiOS"]),
     ],
-    dependencies: [
-    ],
+    dependencies: [],
     targets: [
         .target(
             name: "SwiftFCSDKiOS",
             dependencies: [
                 "FCSDKiOS",
                 "CBARealTime"
             ]),
-        .binaryTarget(name: "FCSDKiOS", url: "https://swift-sdk.s3.us-east-2.amazonaws.com/client_sdk/FCSDKiOS-4.0.0-rc.1.2.10.xcframework.zip", checksum: "a9bb46ecd7be832a4a2e8a7e8d4d0b03514dfd76c52a73d591de0af4e9ed2b6a"),
+        .binaryTarget(name: "FCSDKiOS", url: "https://swift-sdk.s3.us-east-2.amazonaws.com/client_sdk/FCSDKiOS-4.0.0.xcframework.zip", checksum: "618c1564e91c468d4fed64c9e6c6be6e9f56de201078c665a41a6b9963bd7e98"),
         .binaryTarget(name: "CBARealTime", url: "https://swift-sdk.s3.us-east-2.amazonaws.com/real_time/CBARealTime-m95-1.0.1.xcframework.zip", checksum: "b40b7d5b08dbe11f18d60779ffb0cd6576e8e45069d22d81b016a23db88a9633")
     ]
-
 )
diff --git a/Sources/SwiftFCSDKiOS/SwiftFCSDKiOS.docc/AED.md b/Sources/SwiftFCSDKiOS/SwiftFCSDKiOS.docc/AED.md
@@ -1,5 +1,6 @@
 # AED
 The application initially accesses the API via a single object called ACBUC, from which other objects can be retrieved. ACBUC has an attribute named aed, which is the starting point for all **Application Event Distribution** operations.
+
 ## Overview
 
 To create an AED application, you need to:
@@ -12,6 +13,16 @@ To create an AED application, you need to:
 
 4.   Disconnect from the topic when you no longer want to receive AED notifications.
 
+#### FCSDK Technology used in AED
+<doc:ACBClientAED>
+
+<doc:ACBTopic>
+
+<doc:ACBTopicDelegate>
+
+<doc:AedData>
+
+<doc:TopicData>
 
 ## Creating and Connecting to a Topic
 
@@ -113,3 +124,41 @@ If it is successful, the delegate receives a didSendMessageSuccessfullyWithMessa
 ### didReceiveMessage
 
 The delegate will receive a didReceiveMessage callback whenever any connected client (including itself) sends a message to the topic. The only parameter is the message parameter (containing the text of the sent message).
+
+
+## Available FCSDK Objects
+<doc:ACBUCObject>
+
+<doc:ACBUCDelegate>
+
+<doc:ACBUCOptions>
+
+<doc:ACBAudioDevice>
+
+<doc:ACBAudioDeviceManager>
+
+<doc:ACBClientAED>
+
+<doc:ACBClientCall>
+
+<doc:ACBClientCallDelegate>
+
+<doc:ACBClientCallErrorCode>
+
+<doc:ACBClientCallProvisionalResponse>
+
+<doc:ACBClientCallStatus>
+
+<doc:ACBClientPhone>
+
+<doc:ACBMediaDirection>
+
+<doc:ACBTopic>
+
+<doc:ACBVideoCapture>
+
+<doc:AedData>
+
+<doc:TopicData>
+
+<doc:Constants>
diff --git a/Sources/SwiftFCSDKiOS/SwiftFCSDKiOS.docc/Authentication.md b/Sources/SwiftFCSDKiOS/SwiftFCSDKiOS.docc/Authentication.md
@@ -262,3 +262,39 @@ struct Authentication: View {
 }
 ```
 
+## Available FCSDK Objects
+<doc:ACBUCObject>
+
+<doc:ACBUCDelegate>
+
+<doc:ACBUCOptions>
+
+<doc:ACBAudioDevice>
+
+<doc:ACBAudioDeviceManager>
+
+<doc:ACBClientAED>
+
+<doc:ACBClientCall>
+
+<doc:ACBClientCallDelegate>
+
+<doc:ACBClientCallErrorCode>
+
+<doc:ACBClientCallProvisionalResponse>
+
+<doc:ACBClientCallStatus>
+
+<doc:ACBClientPhone>
+
+<doc:ACBMediaDirection>
+
+<doc:ACBTopic>
+
+<doc:ACBVideoCapture>
+
+<doc:AedData>
+
+<doc:TopicData>
+
+<doc:Constants>
diff --git a/Sources/SwiftFCSDKiOS/SwiftFCSDKiOS.docc/CreatingSession.md b/Sources/SwiftFCSDKiOS/SwiftFCSDKiOS.docc/CreatingSession.md
@@ -1,13 +1,27 @@
 # Create a ACBUC Session
 
-Here we will create our FCSDK Session in order to start using the SDK.
+Here we will create our FCSDK Session in order to start using the SDK. ACBUC is the entry point for FCSDK clients. One very important factor is that after we authenticate our User, the server sends back a SessionID in the response. We need this SessionID in order to create our Session Object (ACBUC Object). First we will show you the properties and methods available to you and then we will show you how you can use them.
 
-### ACBUC is the entry point for FCSDK clients. One very important factor is that after we authenticate our User, the server sends back a SessionID in the response. We need this SessionID in order to create our Session Object (ACBUC Object). So, without further ado, let's do that. 
+#### The ACBUC Object
+These properties and methods are what is publicly available to you for creating an application.
+
+<doc:ACBUCObject>
+
+#### The ACBUCDelegate
+You will need to conform to ACBUCDelegate in order to be notified of FCSDK behavior.
+
+<doc:ACBUCDelegate>
+
+#### ACBUCOptions 
+These are ACBUCOptions. For most applications you do not need to be concerned with applying options.
+
+<doc:ACBUCOptions>
 
-Inside of our Login Request Method, where we receive the response, we want to do something with that response.
 
 ## Handle Response Object
 
+Now that you have been able to review the technology needed to create an FCSDK application, we can start creating a session. Inside of our Login Request Method, where we receive the response, we want to do something with that response.
+
 ```swift
 class AuthenticationService: NSObject, ObservableObject {
 
@@ -51,7 +65,8 @@ self.connectedToSocket = self.acbuc?.connection != nil
 // Initialize the ACBUC Object with our SessionID and set the Delegate
      self.acbuc = ACBUC.uc(withConfiguration: sessionid, delegate: self)
 
-// Tell the object if the network is reachable or not
+// Tell the object if the network is reachable or not. 
+// This is needed in order to successfully register a session and set the ACBUCDelegate.
      self.acbuc?.setNetworkReachable(networkStatus)
 
 // Tell the object if we accept any certificate from the server
@@ -76,3 +91,40 @@ self.connectedToSocket = self.acbuc?.connection != nil
     }
 }
 ```
+
+## Available FCSDK Objects
+<doc:ACBUCObject>
+
+<doc:ACBUCDelegate>
+
+<doc:ACBUCOptions>
+
+<doc:ACBAudioDevice>
+
+<doc:ACBAudioDeviceManager>
+
+<doc:ACBClientAED>
+
+<doc:ACBClientCall>
+
+<doc:ACBClientCallDelegate>
+
+<doc:ACBClientCallErrorCode>
+
+<doc:ACBClientCallProvisionalResponse>
+
+<doc:ACBClientCallStatus>
+
+<doc:ACBClientPhone>
+
+<doc:ACBMediaDirection>
+
+<doc:ACBTopic>
+
+<doc:ACBVideoCapture>
+
+<doc:AedData>
+
+<doc:TopicData>
+
+<doc:Constants>