release: SDK 3.0.0

Author: ThomasMengelatte

LICENSE.thirdparty

@@ -23,4 +23,29 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
---------
+--------
+
+Flight-School/AnyCodable
+The MIT License (MIT)
+
+Copyright 2018 Read Evaluate Press, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+--------

Package.swift

@@ -18,8 +18,8 @@ let package = Package(
     targets: [
         .binaryTarget(
             name: "Batch",
-            url: "https://download.batch.com/sdk/ios/spm/BatchSDK-ios_spm-xcframework-2.1.0.zip",
-            checksum: "7e91b40df3e2ce23ebf3b3589771770a9038042a8ccda6785be25e6b9c60307f"
+            url: "https://download.batch.com/sdk/ios/spm/BatchSDK-ios_spm-xcframework-3.0.0.zip",
+            checksum: "6a85b851bc483fdccbf4d5b9ee916637ad20bae3ad2cb47f437f56cf2af20d7f"
         )
     ]
 )

Sources/Batch.xcodeproj/project.pbxproj

@@ -5,6 +5,22 @@
    <BuildAction
       parallelizeBuildables = "YES"
       buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "501C88F02DA5637900C48E6E"
+               BuildableName = "UITestAppUITests.xctest"
+               BlueprintName = "UITestAppUITests"
+               ReferencedContainer = "container:../UITestApp/UITestApp.xcodeproj">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
    </BuildAction>
    <TestAction
       buildConfiguration = "Debug"
@@ -47,6 +63,15 @@
       savedToolIdentifier = ""
       useCustomWorkingDirectory = "NO"
       debugDocumentVersioning = "YES">
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "501C88F02DA5637900C48E6E"
+            BuildableName = "UITestAppUITests.xctest"
+            BlueprintName = "UITestAppUITests"
+            ReferencedContainer = "container:../UITestApp/UITestApp.xcodeproj">
+         </BuildableReference>
+      </MacroExpansion>
    </ProfileAction>
    <AnalyzeAction
       buildConfiguration = "Debug">

Sources/Batch.xcodeproj/xcshareddata/xcschemes/BatchTests.xcscheme

@@ -62,14 +62,15 @@ typedef NS_OPTIONS(NSUInteger, BatchMigration) {
 
 /// Start Batch.
 ///
-/// You should call this method in `application:didFinishLaunchingWithOptions:` of your `UIApplicationDelegate`
+/// You should synchronously call this method in `application:didFinishLaunchingWithOptions:` of your
+/// `UIApplicationDelegate`
 ///
 /// - Note: This is the method that triggers the hooking or your Application to automatically handle some lifecycle
 /// events. If you run into issues, you can try moving this method before other SDK initializations, or call
 /// ``Batch/BatchPush/disableAutomaticIntegration`` before this method, and follow the "Manual Integration" advanced.
 /// - Parameters:
 ///    - key: Your APP's API Key, LIVE or DEV. You can find it on your dashboard.
-+ (void)startWithAPIKey:(NSString *_Nonnull)key;
++ (void)startWithAPIKey:(NSString *_Nonnull)key NS_SWIFT_UI_ACTOR;
 
 /// Set if Batch should send its logs to a custom object of yours.
 ///
@@ -84,7 +85,7 @@ typedef NS_OPTIONS(NSUInteger, BatchMigration) {
 /// implementation more easily. If you want to make it accessible in production, you should hide it in a hard to
 /// reproduce sequence.
 /// - Note: Should be presented modally.
-+ (UIViewController *_Nullable)makeDebugViewController;
++ (UIViewController *_Nullable)makeDebugViewController NS_SWIFT_UI_ACTOR;
 
 /// Toogle whether internal logs should be logged or not.
 ///

Sources/Batch/BatchCore.h

@@ -9,9 +9,21 @@
 #import <Foundation/Foundation.h>
 
 #import <Batch/BatchActions.h>
+#import <Batch/BatchMessagingCloseReason.h>
 
 @class BatchInAppMessage, BatchMessage, BatchPushMessage, BatchMessageAction;
 
+@protocol BatchInAppDelegate <NSObject>
+
+@optional
+
+/// Called when an In-App message should be presented to the user.
+///
+/// - Parameter message: In-App message to show.
+- (void)batchInAppMessageReady:(BatchInAppMessage *_Nonnull)message NS_SWIFT_NAME(batchInAppMessageReady(message:));
+
+@end
+
 /// Implement this protocol if you want to be notified of what happens to the messaging view (for example, perform some
 /// analytics on show/hide).
 @protocol BatchMessagingDelegate <NSObject>
@@ -23,18 +35,6 @@
 /// - Parameter messageIdentifier: Analytics message identifier string. Can be nil.
 - (void)batchMessageDidAppear:(NSString *_Nullable)messageIdentifier;
 
-/// Called when the message view was dismissed by a user interaction (close button tap, swipe gesture...)
-///
-/// - Parameter messageIdentifier: Analytics message identifier string. Can be nil.
-- (void)batchMessageWasCancelledByUserAction:(NSString *_Nullable)messageIdentifier
-    NS_SWIFT_NAME(batchMessageWasCancelledByUserAction(_:));
-
-/// Called when the message view was dismissed automatically after the auto closing countdown.
-///
-/// - Parameter messageIdentifier: Analytics message identifier string. Can be nil.
-- (void)batchMessageWasCancelledByAutoclose:(NSString *_Nullable)messageIdentifier
-    NS_SWIFT_NAME(batchMessageWasCancelledByAutoclose(_:));
-
 /// Called when Batch needs to present a message in automatic mode.
 ///
 /// Implement this method if you need to specify the view controller that will present Batch content.
@@ -52,41 +52,19 @@
 ///   - action: Action that will be performed. Fields can be nil if the action was only to dismiss the message on tap.
 ///     __DO NOT__ run the action yourself: the SDK will automatically do it.
 ///   - identifier: Analytics message identifier string. Can be nil.
-///   - index: Index of the action/CTA. If the action comes from the "global tap action", the index
-///     will be ``BatchMessageGlobalActionIndex`` If the index is greater than or equal to zero,
+///   - ctaIdentifier: Identifier of the action/CTA. If the action comes from the "global tap action", the identifier
+///     will be ``BatchMessageGlobalActionIndex``,
 ///     you can cast the action to ``BatchMessageCTA``
 - (void)batchMessageDidTriggerAction:(BatchMessageAction *_Nonnull)action
                    messageIdentifier:(NSString *_Nullable)identifier
-                         actionIndex:(NSInteger)index;
+                       ctaIdentifier:(NSString *_Nonnull)ctaIdentifier;
 
 /// Called when the message view disappeared from the screen.
 ///
-/// - Parameter messageIdentifier: Analytics message identifier string. Can be nil.
-- (void)batchMessageDidDisappear:(NSString *_Nullable)messageIdentifier;
-
-/// Called when an In-App message should be presented to the user.
-///
-/// - Parameter message: In-App message to show.
-- (void)batchInAppMessageReady:(nonnull BatchInAppMessage *)message NS_SWIFT_NAME(batchInAppMessageReady(message:));
-
-/// Called when the message view was closed because of an error.
-///
-/// - Parameter messageIdentifier: Analytics message identifier string. Can be nil.
-- (void)batchMessageWasCancelledByError:(NSString *_Nullable)messageIdentifier
-    NS_SWIFT_NAME(batchMessageWasCancelledByError(_:));
-
-/// Called when the WebView message view will be dismissed due to the user navigating away or triggering an action
-/// (using the Javascript SDK).
-///
 /// - Parameters:
-///   - action: Action that will be performed. Fields can be nil if the action was only to dismiss the message on
-///     tap. __DO NOT__ run the action yourself: the SDK will automatically do it. Can be nil.
-///   - messageIdentifier: Analytics message identifier string. Can be nil.
-///   - analyticsIdentifier: Click analytic identifier. Matches the `analyticsID` parameter of the Javascript call,
-///     or the `batchAnalyticsID` query parameter of a link.
-- (void)batchWebViewMessageDidTriggerAction:(BatchMessageAction *_Nullable)action
-                          messageIdentifier:(NSString *_Nullable)messageIdentifier
-                        analyticsIdentifier:(NSString *_Nullable)analyticsIdentifier;
+///  - messageIdentifier: Analytics message identifier string. Can be nil.
+///  - reason: Enum for the different reasons why an In-App message can be closed
+- (void)batchMessageDidDisappear:(NSString *_Nullable)messageIdentifier reason:(BatchMessagingCloseReason)reason;
 
 @end
 
@@ -97,6 +75,9 @@
 /// handling In-App messages manually.
 @property (class, nullable) id<BatchMessagingDelegate> delegate;
 
+/// Sets Batch's In-App delegate. The delegate is used for handling In-App messages manually
+@property (class, nullable) id<BatchInAppDelegate> inAppDelegate;
+
 /// Toggles whether Batch should change the shared `AVAudioSession` configuration by itelf.
 ///
 /// It is used to avoid stopping the user's music when displaying a video inapp,
@@ -107,7 +88,8 @@
 /// Default: true
 ///
 /// In-App messaging is not affected by this. If you want to manually display the In-App message, call
-/// ``BatchMessaging/setDelegate:`` with a delegate that implement ``BatchMessagingDelegate/batchInAppMessageReady:``.
+/// ``BatchMessaging/setDelegate:`` with a delegate that implement
+/// ``BatchInAppDelegate/batchInAppMessageReady:``.
 /// - Note: If automatic mode is enabled, manual integration methods will not work.
 @property (class) BOOL automaticMode;