Merge pull request #264 from Iterable/MOB-1032

roninopf · web-flow · commit aecc74ab31b3 · 2020-02-24T13:57:57.000-08:00
[MOB-1032] update docs
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,19 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 6.2.0
+#### Added
+- Moved Mobile Inbox support to GA (no longer in beta), and:
+    - Added support for various ways to customize the default interface for a mobile inbox
+    - Added a sample project that demonstrates how to customize the default interface for a mobile inbox
+    - Added tracking for inbox sessions (when the inbox is visible in the app) and inbox message impressions (when a individual message's item is visible in the mobile inbox message list)
+- Added support for Swift Package Manager
+
+#### Deprecated
+Please see each method's source code documentation for details.
+- `IterableAPI.track(inAppOpen messageId: String)`
+- `IterableAPI.track(inAppClick messageId: String, buttonURL: String)`
+
 ## 6.1.5
 #### Fixed
 - Fixed in-apps where display types that were not `fullScreen` were not displaying properly or becoming unresponsive.
@@ -14,49 +27,45 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## 6.1.3
 #### Changed
 - Converted a log message variable to be interpreted as an UTF8 String (thanks, chunkyguy!)
-- Enabled BUILD_LIBRARY_FOR_DISTRIBUTION for better compatibility across development environments
+- Enabled `BUILD_LIBRARY_FOR_DISTRIBUTION` for better compatibility across development environments
 
 ## 6.2.0-beta1
 #### Added
-- [Mobile inbox](https://github.com/Iterable/swift-sdk/tree/inbox#mobile-inbox)
-- [Mobile Inbox related events](https://github.com/Iterable/swift-sdk/tree/inbox#mobile-inbox-events-and-the-events-lifecycle)
+- [Mobile Inbox](https://github.com/Iterable/swift-sdk/#mobile-inbox)
+- [Mobile Inbox related events](https://github.com/Iterable/swift-sdk/#mobile-inbox-events-and-the-events-lifecycle)
 
 #### Removed
 - `IterableAPI.spawnInAppNotification(_:)`
-	- In-app messages are automatically shown by SDK now. Please check our [migration guide](https://github.com/iterable/swift-sdk/#migrating-in-app-messages-from-the-previous-version-of-the-sdk).
+    - In-app messages are automatically shown by SDK now. Please check our [migration guide](https://github.com/iterable/swift-sdk/#migrating-in-app-messages-from-the-previous-version-of-the-sdk).
 - `IterableAPI.get(inAppMessages:)`
-	- Use `IterableAPI.inAppManager.getMessages()` instead
+    - Use `IterableAPI.inAppManager.getMessages()` instead
 
 #### Changed
  - There is no need to set `IterableConfig.pushIntegrationName` for new projects.
 
 #### Deprecated
 Please see method documentation for details about how to replace them.
-
 - `IterableAPI.inAppConsume(messageId:)`
 - `IterableAPI.showSystemNotification(..)`
 - `IterableAPI.getAndTrack(deeplink:callbackBlock:)`
 
-#### Fixed
-- nothing yet
-
 ## 6.1.2
 #### Fixed
 - Fixed a bug in token to hex conversion code.
 
 ## 6.1.1
 #### Changed
-- Use WKWebView instead of deprecated class UIWebView.
-- Migrated all Objective C code to Swift.
+- Use `WKWebView` instead of deprecated class `UIWebView`.
+- Migrated all Objective-C code to Swift.
 
 ## 6.2.0-dev1
 #### Added
 - Inbox
-	- Brand new inbox functionality. Please see documentation for more details.
+    - Brand new inbox functionality. Please see documentation for more details.
 
 ## 6.1.0
 #### Changed
-- In this version we have changed the way we use in-app notifications. In-app messages are now being sent asynchronously and your code can control the order and time in which an in-app notification will be shown. There is no need to poll for new in-app messages. Please refer to the **in-app messages** section of README file for how to use in-app messages. If you are already using in-app messages, please refer to [migration guide](https://github.com/iterable/swift-sdk##migrating-from-a-version-prior-to-610) section of README file.
+- In this version we have changed the way we use in-app notifications. In-app messages are now being sent asynchronously and your code can control the order and time in which an in-app notification will be shown. There is no need to poll for new in-app messages. Please refer to the **in-app messages** section of README file for how to use in-app messages. If you are already using in-app messages, please refer to [migration guide](https://github.com/iterable/swift-sdk#migrating-from-a-version-prior-to-610) section of README file.
 
 ## 6.1.0-beta4
 #### Changed
@@ -70,22 +79,22 @@ Please see method documentation for details about how to replace them.
 ## 6.1.0-beta2
 #### Added
 - Support for `action://your-custom-action-name` URL scheme for calling custom actions 
-	- For example, to have `IterableCustomActionDelegate` call a custom `buyCoffee` action when a user taps on an in-app message's **Buy** button.
+    - For example, to have `IterableCustomActionDelegate` call a custom `buyCoffee` action when a user taps on an in-app message's **Buy** button.
 - Support for reserved `itbl://sdk-custom-action` scheme for SDK internal actions.
-	- URL scheme `itbl://sdk-custom-action` is reserved for internal SDK actions. Do not use it for custom actions. 
-	- For example, future versions of the SDK may allow buttons to call href `itbl://delete` to delete an in-app message.
+    - URL scheme `itbl://sdk-custom-action` is reserved for internal SDK actions. Do not use it for custom actions. 
+    - For example, future versions of the SDK may allow buttons to call href `itbl://delete` to delete an in-app message.
 
 #### Fixed
 - Carthage support with Xcode 10.2
-- XCode 10.2 Warnings
+- Xcode 10.2 Warnings
 - URL Query parameters encoding bug
 
 ## 6.1.0-beta1
 #### Added
 - We have improved the in-app messaging implementation significantly. 
-	- The SDK now maintains a local queue and keep it in sync with the server-side queue automatically.
-	- Iterable servers now notify apps via silent push messages whenever the in-app message queue is updated.
-	- In-app messages are shown by default whenever they arrive.
+    - The SDK now maintains a local queue and keep it in sync with the server-side queue automatically.
+    - Iterable servers now notify apps via silent push messages whenever the in-app message queue is updated.
+    - In-app messages are shown by default whenever they arrive.
 - It should be straightforward to migrate to the new implementation. There are, however, some breaking changes. Please see [migration guide](https://github.com/iterable/swift-sdk#Migrating-in-app-messages-from-the-previous-version-of-the-SDK) for more details.
 
 #### Removed
@@ -133,17 +142,3 @@ Please see method documentation for details about how to replace them.
 
 #### Fixed
 - Fixed issue that affects clients who are upgrading from Objective C Iterable SDK to Swift SDK. If you have attribution info stored in the previous Objective C SDK, it was not being deserialized in Swift SDK.
-
-## [Unreleased]
-#### Added
-- nothing yet
-
-#### Removed
-- nothing yet
-
-#### Changed
-- nothing yet
-
-#### Fixed
-- nothing yet
-
diff --git a/Iterable-iOS-AppExtensions.podspec b/Iterable-iOS-AppExtensions.podspec
@@ -17,7 +17,7 @@ Pod::Spec.new do |s|
 
   s.name         = "Iterable-iOS-AppExtensions"
   s.module_name  = "IterableAppExtensions"
-  s.version      = "6.2.0-beta1"
+  s.version      = "6.2.0"
   s.summary      = "App Extensions for Iterable SDK"
 
   s.description  = <<-DESC
@@ -48,9 +48,7 @@ Pod::Spec.new do |s|
   #
 
   s.author      = { "Tapash Majumder" => "tapash@iterable.com",
-                    "Victor Babenko" => "victor@iterable.com",
-                    "Jay Kim" => "jay.kim@iterable.com",
-                    "David Truong" => "dt@iterable.com" }
+                    "Jay Kim" => "jay.kim@iterable.com" }
 
   # ――― Platform Specifics ――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
   #
diff --git a/Iterable-iOS-SDK.podspec b/Iterable-iOS-SDK.podspec
@@ -17,7 +17,7 @@ Pod::Spec.new do |s|
 
   s.name         = "Iterable-iOS-SDK"
   s.module_name  = "IterableSDK"
-  s.version      = "6.2.0-beta1"
+  s.version      = "6.2.0"
   s.summary      = "Iterable's official SDK for iOS"
 
   s.description  = <<-DESC
@@ -48,9 +48,7 @@ Pod::Spec.new do |s|
   #
 
   s.author       = { "Tapash Majumder" => "tapash@iterable.com",
-                     "Victor Babenko" => "victor@iterable.com",
-                     "Jay Kim" => "jay.kim@iterable.com",
-                     "David Truong" => "dt@iterable.com" }
+                     "Jay Kim" => "jay.kim@iterable.com" }
 
   # ――― Platform Specifics ――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
   #
diff --git a/README.md b/README.md
@@ -7,10 +7,10 @@
 
 - [Installation](#installation)
 - [Installing with a dependency manager](#installing-with-a-dependency-manager)
-    - [Carthage](#carthage)
+    - [Swift Package Manager](#swift-package-manager)
     - [CocoaPods](#cocoapods)
+    - [Carthage](#carthage)
     - [Manual Installation](#manual-installation)
-    - [Beta versions](#beta-versions)
 - [Migrating from a version prior to 6.1.0](#migrating-from-a-version-prior-to-610)
 - [Sample projects](#sample-projects)
 - [Configuring the SDK](#configuring-the-sdk)
@@ -34,68 +34,29 @@ The Iterable iOS SDK is a Swift implementation of an iOS client for Iterable, fo
 
 Before starting with the SDK, you will need to set up Iterable push notifications for your app.
 
-For more information, read Iterable's [Setting up iOS Push Notifications](https://support.iterable.com/hc/articles/115000315806-Setting-Up-iOS-Push-Notifications) guide.
+For more information, read Iterable's [Setting up iOS Push Notifications](https://support.iterable.com/hc/articles/115000315806) guide.
 
 ## Installation
 
-To install this SDK, use [Carthage](https://github.com/Carthage/Carthage), 
-[CocoaPods](https://cocoapods.org/), or install it manually.
-
-### Carthage
-
-To use Carthage to install the SDK, first [install Carthage](https://github.com/Carthage/Carthage#installing-carthage). 
-Then, follow these steps:
-
-1. If it does not yet exist, create a file named **Cartfile** in the same 
-directory as your Xcode project.
-
-2. Edit **Cartfile**, adding the following line:
-
-    ```
-    github "Iterable/swift-sdk" ~> 6.1.4
-    ```
-
-3. In the terminal, in the same directory as your **Cartfile**, run the 
-following command:
-
-    ```
-    carthage update
-    ```
-
-4. In Xcode, navigate to the **Build Phases** section for your app's target.
-Click the **+** icon and select **New Run Script Phase**. A **Run Script** 
-section will appear.
-
-5. In the **Run Script** section, below the **Shell** input, add the 
-following command: 
+To install this SDK, use [Carthage](https://github.com/Carthage/Carthage), [CocoaPods](https://cocoapods.org/), [Swift Package Manager](https://swift.org/package-manager/) (through Xcode or command line), or install it manually.
 
-    ```
-    /usr/local/bin/carthage copy-frameworks
-    ```
-6. In the **Input Files** section, click **+** and add the following path:
+### Swift Package Manager
 
-    ```
-    $(SRCROOT)/Carthage/Build/iOS/IterableSDK.framework
-    ```
+In Xcode 11, Apple integrated the Swift Package Manager into Xcode—an
+intuitive, easy way to add dependencies to your project.
 
-7. In the **Output Files** section, add the path to the copied framework:
+1. To include Iterable's SDK, navigate in Xcode to **File** >
+**Swift Packages** > **Add Package Dependency**.
 
-    ```
-    $(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/IterableSDK.framework
-    ```
+2. Enter `https://github.com/iterable/swift-sdk` as the package repository URL.
 
-8. Add **&lt;Xcode project directory&gt;/Carthage/Build/iOS/IterableSDK.framework** 
-to your Xcode project by dragging it into the Xcode Project Navigator.
-When prompted by Xcode, add the framework to your app's target.
+3. Select the version of the SDK you'd like to install (the default settings
+will be set to the latest stable version).
 
-9. If your app will be using push notifications that contain media
-attachments (images, etc.), repeat steps 6 through 8, substituting
-**IterableAppExtensions.framework** for **IterableSDK.framework**. In step 8, 
-add **IterableAppExtensions.framework** to your project's Notification
-Service Extension target (instead of the app target).
+4. Select **IterableSDK**. If necessary for your use case, also select
+**IterableAppExtensions**.
 
-For more information, take a look at the [Carthage](https://github.com/Carthage/Carthage)
-documentation.
+5. Click **Finish**.
 
 ### CocoaPods 
 
@@ -154,6 +115,63 @@ extensions, if necessary):
 For more information, take a look at the [CocoaPods](https://cocoapods.org/)
 documentation.
 
+### Carthage
+
+To use Carthage to install the SDK, first [install Carthage](https://github.com/Carthage/Carthage#installing-carthage). 
+Then, follow these steps:
+
+1. If it does not yet exist, create a file named **Cartfile** in the same 
+directory as your Xcode project.
+
+2. Edit **Cartfile**, adding the following line:
+
+    ```
+    github "Iterable/swift-sdk" ~> 6.2.0
+    ```
+
+3. In the terminal, in the same directory as your **Cartfile**, run the 
+following command:
+
+    ```
+    carthage update
+    ```
+
+4. In Xcode, navigate to the **Build Phases** section for your app's target.
+Click the **+** icon and select **New Run Script Phase**. A **Run Script** 
+section will appear.
+
+5. In the **Run Script** section, below the **Shell** input, add the 
+following command: 
+
+    ```
+    /usr/local/bin/carthage copy-frameworks
+    ```
+
+6. In the **Input Files** section, click **+** and add the following path:
+
+    ```
+    $(SRCROOT)/Carthage/Build/iOS/IterableSDK.framework
+    ```
+
+7. In the **Output Files** section, add the path to the copied framework:
+
+    ```
+    $(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/IterableSDK.framework
+    ```
+
+8. Add **&lt;Xcode project directory&gt;/Carthage/Build/iOS/IterableSDK.framework** 
+to your Xcode project by dragging it into the Xcode Project Navigator.
+When prompted by Xcode, add the framework to your app's target.
+
+9. If your app will be using push notifications that contain media
+attachments (images, etc.), repeat steps 6 through 8, substituting
+**IterableAppExtensions.framework** for **IterableSDK.framework**. In step 8, 
+add **IterableAppExtensions.framework** to your project's Notification
+Service Extension target (instead of the app target).
+
+For more information, take a look at the [Carthage](https://github.com/Carthage/Carthage)
+documentation.
+
 ### Manual installation
 
 Attached to the release, you will find two framework bundles: 
@@ -579,7 +597,7 @@ func handle(iterableURL url: URL, inContext context: IterableActionContext) -> B
 #### Email deep links
     
 For Universal Links to work with email link rewriting, 
-[set up an **apple-app-site-association** file](https://support.iterable.com/hc/articles/115000440206-Setting-up-iOS-Universal-Links)
+[set up an **apple-app-site-association** file](https://support.iterable.com/hc/articles/115000440206)
 in your Iterable project.
 
 When a user clicks a link in an email, the SDK will call the
@@ -808,11 +826,16 @@ Iterable will track uninstalls with no additional work by you.
 
 To do this, Iterable sends a silent push notification some time (currently, 12 hours) after a campaign has been sent. Based on this silent push notification, if Iterable receives feedback that the device token is no longer valid, it assigns an uninstall to the device based on the prior campaign. Similarly, if a "real" campaign uncovers an invalid device token, it will also check for a prior (within 12 hours) campaign to mark as the cause for the uninstall. If there was no recent campaign, Iterable still tracks the uninstall, but does not attribute it to a campaign.
 
-> &#x26A0; Apple has changed the way device tokens expire, so they may take up to 8 days to detect if they are invalid. This does mean that uninstall tracking may not be accurately attributable to campaigns sent within that period of time.
+> &#x26A0; **IMPORTANT**
+> Apple has changed the way device tokens expire, so they may take up to 8 days to detect if they are invalid. This does mean that uninstall tracking may not be accurately attributable to campaigns sent within that period of time.
 
 ## Additional information
 
-For more information, read Iterable's [Mobile Developer Guides](https://support.iterable.com/hc/categories/360002288712)
+For more information, take a look at:
+
+- Iterable's [iOS SDK Release Notes](https://support.iterable.com/hc/articles/360027798391)
+- Iterable's [Setting Up iOS Push Notifications](https://support.iterable.com/hc/articles/115000315806) guide
+- Iterable's [Push Notification Setup FAQs](http://support.iterable.com/hc/articles/206791196)
 
 ## License
 
diff --git a/swift-sdk/Internal/InAppDisplayer.swift b/swift-sdk/Internal/InAppDisplayer.swift
@@ -74,6 +74,7 @@ class InAppDisplayer: InAppDisplayerProtocol {
         return .shown(createResult.futureClickedURL)
     }
     
+    // deprecated - will be removed in version 6.3.x or above
     static func showSystemNotification(withTitle title: String,
                                        body: String,
                                        buttonLeft: String?,
diff --git a/swift-sdk/IterableAPI.swift b/swift-sdk/IterableAPI.swift

Original file line number	Diff line number	Diff line change
`@@ -74,6 +74,7 @@ class InAppDisplayer: InAppDisplayerProtocol {`
`74`	`74`	`return .shown(createResult.futureClickedURL)`
`75`	`75`	`}`
`76`	`76`
	`77`	`+ // deprecated - will be removed in version 6.3.x or above`
`77`	`78`	`static func showSystemNotification(withTitle title: String,`
`78`	`79`	`body: String,`
`79`	`80`	`buttonLeft: String?,`