Merge pull request #50 from Iterable/feature/mob-177-ddl-doc

[MOB-177] - Add deferred deep linking documentation

Author: tapashmajumder

README.md

@@ -248,16 +248,51 @@ func application(_ application: UIApplication, continue userActivity: NSUserActi
 	return [IterableAPI handleUniversalLink:userActivity.webpageURL];
 }
 ```
+
+### Deferred deep linking
+
+[Deferred deep linking](https://en.wikipedia.org/wiki/Deferred_deep_linking) allows a user who does not have a specific app installed to:
+
+ - Click on a deep link that would normally open content in that app.
+ - Install the app from the App Store.
+ - Open the app and immediately see the content referenced by the link.
+ 
+As the name implies, the deep link is _deferred_ until the app has been installed. 
+
+After tapping a deep link in an email from an Iterable campaign, users without the associated app will be directed to the App Store to install it. If the app uses the IterableSDK and has deferred deep linking enabled, the content associated with the deep link will load on first launch.
+
+#### Enabling deferred deep linking
+
+Set `IterableConfig.checkForDeferredDeeplink = true` to enable deferred deep linking for IterableSDK.
 	
-#### In-app messages
+### In-app messages
+
+If you are already using in-app messages with IterableSDK, please check out the [migration section](#Migrating-in-app-messages-from-the-previous-version-of-the-SDK). 
+
+In-app messages are handled via silent push messages from the server. When your application receives a silent push, you need to call IterableSDK in your AppDelegate as in the following code:
+
+*Swift*
+
+```swift
+// In AppDelegate.swift
+func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
+    IterableAppIntegration.application(application, didReceiveRemoteNotification: userInfo, fetchCompletionHandler: completionHandler)
+}
+```
 
-If you are already using in-app messages with IterableSDK, please check out the [migration section](#Migrating-in-app-messages-from-previous-version-of-SDK).
+*Objective-C*
+
+```objc
+- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler {
+    [IterableAppIntegration application:application didReceiveRemoteNotification:userInfo fetchCompletionHandler:completionHandler];
+}
+```
 
-##### Default behavior
+#### Default behavior
 
 By default, when an in-app message arrives from the server, the SDK automatically shows it if the app is in the foreground. If an in-app message is already showing when the new message arrives, the new in-app message will be shown 30 seconds after the currently displayed in-app message closes ([see how to change this default value below](#Changing-the-display-interval-between-in-app-messages)). Once an in-app message is shown, it will be "consumed" from the server queue and removed from the local queue as well. There is no need to write any code to get this default behavior. 
 
-##### Overriding whether to show or skip a particular in-app message
+#### Overriding whether to show or skip a particular in-app message
 
 An incoming in-app message triggers a call to the `onNew` method of `IterableConfig.inAppDelegate` (an object of type `IterableInAppDelegate`). To override the default behavior, set `IterableConfig.inAppDelegate` to a custom class that overrides the `onNew` method. `onNew` should return `.show` to show the incoming in-app message or `.skip` to skip showing it.
 
@@ -302,7 +337,7 @@ config.inAppDelegate = self; // or other class implementing the protocol
 [IterableAPI initializeWithApiKey:@"YOUR API KEY" launchOptions:launchOptions config:config];
 ```
 
-##### Getting the local queue of in-app messages
+#### Getting the local queue of in-app messages
 Until they are consumed by the app, all in-app messages that arrive from the server are stored in a local queue. To access that local queue, use the read-only `IterableAPI.inAppManager` property (which conforms to the `InAppManager` protocol). By default, all in-app messages in the local queue will be consumed and removed from this queue. To keep in-app messages around after they are shown, override the default behavior (as described above).
 	
 *Swift*
@@ -333,7 +368,7 @@ NSArray *messages = [IterableAPI.inAppManager getMessages];
 
 ```	
 
-##### When user clicks a button/link in the in-app message
+#### When user clicks a button/link in the in-app message
 
 Button/link clicks from in-app are handled similar to deep links from notifications and emails. Please see those sections above. If the in-app message's clicked button/link's `href` contains a URL (which is usually the case), tapping that button/link will call the `handle` method of `IterableConfig.urlDelegate` (an object of type `IterableURLDelegate`), if one is set. By default if this delegate is not set, tapping the button/link will open Safari with the `href` of the clicked button/link.
 	
@@ -347,11 +382,11 @@ config.urlDelegate = YourCustomUrlDelegate()
 config.customActionDelegate = YourCustomActionDelegate()
 ```
 
-##### Changing the display interval between in-app messages
+#### Changing the display interval between in-app messages
 
 To customize the time delay between successive in-app messages (default value of 30 seconds), set `IterableConfig.inAppDisplayInterval` to an appropriate value (in seconds). 
 
-##### Migrating in-app messages from the previous version of the SDK
+#### Migrating in-app messages from the previous version of the SDK
 
 If you are already using in-app messages, then you will have to make the following changes to your code:
 
@@ -360,21 +395,21 @@ If you are already using in-app messages, then you will have to make the followi
 3. Remove calls to 'IterableAPI.getInAppMessages()' and use `IterableAPI.inAppManager.getInAppMessages()` instead.
 
 
-#### Tracking custom events
+### Tracking custom events
 
 Custom events can be tracked using `IterableAPI.track(event:...)` calls.
 
-#### Updating user fields
+### Updating user fields
 
 User fields can be modified using `IterableAPI.updateUser` call. You also have `updateEmail` and `updateSubscriptions` methods.
 
-#### Disabling push notifications to a device
+### Disabling push notifications to a device
 
 When a user logs out, you typically want to disable push notifications to that user/device. This can be accomplished by calling `disableDeviceForCurrentUser`. Please note that it will only attempt to disable the device if you have previously called `registerToken`.
 
 In order to re-enable push notifcations to that device, simply call `registerToken` as usual when the user logs back in.
 
-#### Uninstall tracking
+### Uninstall tracking
 
 Iterable will track uninstalls with no additional work by you. 
 

sample-apps/objc-sample-app/objc-sample-app.xcodeproj/project.pbxproj

@@ -270,7 +270,7 @@
 		AC90809E20E308D1004BC146 /* Project object */ = {
 			isa = PBXProject;
 			attributes = {
-				LastUpgradeCheck = 0940;
+				LastUpgradeCheck = 1010;
 				ORGANIZATIONNAME = Iterable;
 				TargetAttributes = {
 					AC9080A520E308D1004BC146 = {
@@ -554,6 +554,7 @@
 			isa = XCBuildConfiguration;
 			baseConfigurationReference = 75A967E379FC6270DFE2E36D /* Pods-objc-sample-app.debug.xcconfig */;
 			buildSettings = {
+				ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CODE_SIGN_ENTITLEMENTS = "objc-sample-app/objc-sample-app.entitlements";
 				CODE_SIGN_STYLE = Automatic;
@@ -573,6 +574,7 @@
 			isa = XCBuildConfiguration;
 			baseConfigurationReference = DDFF7C4DDD2898BE48245488 /* Pods-objc-sample-app.release.xcconfig */;
 			buildSettings = {
+				ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CODE_SIGN_ENTITLEMENTS = "objc-sample-app/objc-sample-app.entitlements";
 				CODE_SIGN_STYLE = Automatic;

sample-apps/objc-sample-app/objc-sample-app/AppDelegate.m

@@ -91,9 +91,14 @@ - (void)applicationWillTerminate:(UIApplication *)application {
     // Called when the application is about to terminate. Save data if appropriate. See also applicationDidEnterBackground:.
 }
 
+#pragma mark - Silent Push
+- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler {
+    [IterableAppIntegration application:application didReceiveRemoteNotification:userInfo fetchCompletionHandler:completionHandler];
+}
+
 #pragma mark - Url handling
-- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray * _Nullable))restorationHandler {
-    
+- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>> * _Nullable))restorationHandler {
+
     //ITBL:
     NSURL *url = userActivity.webpageURL;
     if (url == nil) {

sample-apps/objc-sample-app/objc-sample-app/Base.lproj/Main.storyboard

@@ -1,11 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="14113" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES" initialViewController="hgQ-gs-Z8D">
+<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="14460.31" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES" initialViewController="hgQ-gs-Z8D">
     <device id="retina4_7" orientation="portrait">
         <adaptation id="fullscreen"/>
     </device>
     <dependencies>
         <deployment identifier="iOS"/>
-        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="14088"/>
+        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="14460.20"/>
         <capability name="Safe area layout guides" minToolsVersion="9.0"/>
         <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
     </dependencies>
@@ -80,7 +80,7 @@
                             <stackView opaque="NO" contentMode="scaleToFill" axis="vertical" spacing="10" translatesAutoresizingMaskIntoConstraints="NO" id="f7k-qy-qxC">
                                 <rect key="frame" x="62.5" y="183" width="250" height="365.5"/>
                                 <subviews>
-                                    <label opaque="NO" userInteractionEnabled="NO" contentMode="left" horizontalHuggingPriority="251" verticalHuggingPriority="251" text="Label" textAlignment="center" lineBreakMode="tailTruncation" baselineAdjustment="alignBaselines" adjustsFontForContentSizeCategory="YES" adjustsFontSizeToFit="NO" translatesAutoresizingMaskIntoConstraints="NO" id="E6e-e6-ohw">
+                                    <label opaque="NO" userInteractionEnabled="NO" contentMode="left" horizontalHuggingPriority="251" verticalHuggingPriority="251" text="Label" textAlignment="center" lineBreakMode="tailTruncation" baselineAdjustment="alignBaselines" adjustsFontSizeToFit="NO" translatesAutoresizingMaskIntoConstraints="NO" id="E6e-e6-ohw">
                                         <rect key="frame" x="0.0" y="0.0" width="250" height="20.5"/>
                                         <fontDescription key="fontDescription" type="system" weight="thin" pointSize="17"/>
                                         <nil key="textColor"/>
@@ -186,7 +186,7 @@
                         <viewLayoutGuide key="safeArea" id="mdt-39-bbJ"/>
                     </view>
                     <navigationItem key="navigationItem" id="5BQ-Vo-KB0">
-                        <barButtonItem key="rightBarButtonItem" style="plain" systemItem="done" id="OQ7-S8-j6B">
+                        <barButtonItem key="rightBarButtonItem" style="done" systemItem="done" id="OQ7-S8-j6B">
                             <connections>
                                 <action selector="doneButtonTapped:" destination="e0v-rS-htn" id="Wsh-gP-9al"/>
                             </connections>

sample-apps/swift-sample-app/swift-sample-app/AppDelegate.swift

@@ -84,6 +84,12 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         // Called when the application is about to terminate. Save data if appropriate. See also applicationDidEnterBackground:.
     }
 
+    // MARK: Silent Push for in-app
+    func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
+        IterableAppIntegration.application(application, didReceiveRemoteNotification: userInfo, fetchCompletionHandler: completionHandler)
+    }
+
+    
     // MARK: Deep link
     func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([Any]?) -> Void) -> Bool {
         guard let url = userActivity.webpageURL else {