SDK changelog

This is a major release, please see our migration guide for more info on how to update your current Batch implementation.

Batch requires Xcode 15.3 and iOS 13.0 or higher

Linking

• Dropped support for iOS 12 and lower.
• Batch is now distributed as a dynamic framework. You can now safely link Batch between multiple framework targets!
• Batch is now a mergeable dynamic library. The additional metadata induced by this feature makes the XCFramework distribution heavier, but has no effect in the final size of Batch in your app once compiled.

visionOS

This version introduced the visionOS support but some features are still unsupported like:

• In-App messaging and mobile landings are unavailable.
• In-App rating is not supported on visionOS due to an OS limitation.

Core

All deprecated APIs in the SDK v1 have been removed and some others have been renamed/reworked to feel Swift native.

• The Batch module has been renamed to BatchSDK.
• Batch has dropped the support for IDFA. You can no longer set an advertising id to Batch and all related APIs have been removed.
• Removed deprecated method setUseIDFA which was a no-op.
• Removed method setLoggerDelegate, which has been replaced by the loggerDelegate property.
• Removed method setAssociatedDomains, which has been replaced by the associatedDomains property.
• Removed method isOptedOut, which has been replaced by the isOptedOut property.
• Removed method isRunningInDevelopmentMode with no equivalent.
• Removed method handleURL with no equivalent.
• Removed method setUseAdvancedDeviceInformation, you should now use the added updateAutomaticDataCollectionAPI.
• Renamed method debugViewController to makeDebugViewController.
• Removed warning about unconfigured App Groups.
• Added setDisabledMigrations(migrations:)to explicitly disable profile's data migrations when running the SDK V2 for the first time when your app belongs to a project.
• Added updateAutomaticDataCollection(editor:) to fine-tune the data sent by the SDK since Batch will not resolve the user's location/region and will not send the device type by default.

Push

• Removed deprecated method setupPush, which was a no-op.
• Removed the ability to register notification categories using Batch. Please use the system API.
  • Removed deprecated method registerForRemoteNotifications.
  • Removed deprecated method registerForRemoteNotificationsWithCategories.
  • Removed method setNotificationsCategories.
• Removed deprecated method handleNotification.
• Removed method handleNotification:actionIdentifier.
• Removed method enableAutomaticDeeplinkHandling, which has been replaced by the enableAutomaticDeeplinkHandling property.
• Removed method lastKnownPushToken, which has been replaced by the lastKnownPushToken property.
• Added async variants of BatchPush.requestNotificationAuthorization() and requestProvisionalNotificationAuthorization(). In non async Swift code and Objective-C, they are exposed as variants with a completion handler: BatchPush.requestNotificationAuthorization(completionHandler:)/[BatchPush requestNotificationAuthorizationWithCompletionHandler:]. Note: In async Swift code, this is a breaking change as the language will force you to use the async variant. If you want to ignore the result, use: let _ = try? await BatchPush.requestNotificationAuthorization().
• Removed pre-iOS 10 UINotification related methods. UNUserNotification and its related callbacks have been the only supported way to integrate Batch for a while as legacy methods lead to unexpected behaviour.
  • Removed deprecated method handleRegisterUserNotificationSettings.
• Added helpers to extract Batch notification information from UNNotification instances.
  • Added method isBatchNotification
  • Added method deeplinkFromNotification
• BatchUNUserNotificationCenterDelegate now defaults to showing foreground notifications.

User

Most of all user's related APIs have been removed and replaced with their equivalent in the new BatchProfile module. Only the reading methods are still present for backward-compatibility but keep in mind these methods are only about the installation data and not your Profile since it may be updated from another source.

• Removed deprecated class BatchUserProfile and all related methods/properties.
• Removed deprecated method trackEvent:withLabel:data and all other variants. You should now use the BatchProfile.trackEvent APIs.
• Removed method BatchUser.editor and the related class BatchUserDataEditor, you should now use BatchProfile.editor which return an instance of BatchProfileEditor or BatchProfile.editWithBlock to directly edit attributes in a closure.
• Removed method printDebugInformation with no equivalent.
• Removed methods trackTransactionWithAmount and trackTransactionWithAmount:data with no equivalents.
• Removed methods trackLocation, you should now use BatchProfile.trackLocation.
• Added BatchUser.clearInstallationData() which allows you to remove the installation data without modifying the current profile.

Event

This version introduced two new types of attribute that can be attached to an event : Array and Object.

• Renamed BatchEventData class to BatchEventAttributes
• Removed deprecated method Batch.trackEvent(String event, String label, JSONObject data).
• Removed all trackEvent APIs from the user module. You should now use Batch.Profile.trackEvent.
• Removed addTag API from BatchEventData You should now use the $tags reserved key with putStringArray:forKey: method.
• Removed parameter label from trackEvent APIs. You should now use the $label reserved key in BatchEventAttributes with the putStringt:forKey: method.
• Added support for Array and Object attributes with the added APIs to BatchEventAttributes :
  • putObject:forKey
  • putObjectArray:forKey
  • putStringArray:forKey
• Added validateWithError method to BatchEventAttributes to ensure your event attributes are valid before sending them.

Messaging

• Removed method setDelegate, which has been replaced by the delegate property.
• Removed method setCanReconfigureAVAudioSession, which has been replaced by the canReconfigureAVAudioSession property.
• Removed method setAutomaticMode, which has been replaced by the automaticMode property.

Inbox

• Removed deprecated property title from BatchInboxNotificationContent. You should access it from the message property.
• Removed deprecated property body from BatchInboxNotificationContent. You should access it from the message property.
• Removed deprecated property isDeleted from BatchInboxNotificationContent.

Profile

Introduced BatchProfile, a new module that enables interacting with profiles. Its functionality replaces most of BatchUser used to do.

• Added identify API as replacement of BatchUser.editor().setIdentifier.
• Added editor method to get a new instance of a BatchProfileEditor as replacement of BatchUserDataEditor.
• Added editWithBlock to directly edit profile attributes in a closure. Note: there's no need to save the editor in the closure since it done automatically.
• Added trackEventWithName and trackEventWithName:attributes APIs as replacement of the BatchUser.trackEvent methods.
• Added trackLocation API as replacement of the BatchUser.trackLocation method.

Fixes

• Fixed an issues where the thread sanitizer would report an issue when opening deeplinks.

Compiles with Xcode 15.1 Batch requires Xcode 15.1 and iOS 12.0 or higher

Core

• Re-release of 1.21.1 due to a build script issue.

Compiles with Xcode 15.1 Batch requires Xcode 15.1 and iOS 12.0 or higher

Core

• Batch now sets a MinimumOSVersion of 100.0 to workaround a framework validation bug on Xcode 15.3.

Compiles with Xcode 15.1 Batch requires Xcode 15.1 and iOS 12.0 or higher

Core

• Improved Batch Logger for better use in Xcode 15.
• Removed support for IDFA (Advertising ID) automatic collection. Batch.setCanUseIDFA is now a no-op.
  You need to collect it from your side and pass it to Batch via the added [BatchUserDataEditor setAttributionIdentifier:] method.
• Added Batch's Privacy Manifest. Since, as of writing, Apple does not support the XCPrivacy file for static frameworks you may not see Batch in the genertaed privacy report.
• Added code signature to the Batch's XCFramework distribution.

In-App

• In-App WebViews can now be inspected using macOS Safari on iOS 16.4 and higher.
• Fixed a crash when trying to display 0px width images in the Image format.

Compiles with Xcode 14.3.1 Batch requires Xcode 14.3.1 and iOS 11.0 or higher

Note: Due to Xcode 15 dropping support for iOS 11.0, this is the last minor version supporting iOS 11.

Core

• Fixed Universal Links not triggering SwiftUI's' onOpenUrl (iOS 14+). For iOS 13, implement your own UISceneDelegate using a custom application delegate or use a BatchDeeplinkDelegate.

User

• Added method [BatchUserDataEditor setEmail:]. This requires to have a user identifier registered or to call the setIdentifier method on the editor instance beforehand.
• Added [BatchUserDataEditor setEmailMarketingSubscriptionState:] method to subscribe to the email marketing list.

Inbox

• Added the ability to know if a BatchPushMessage has been displayed from the inbox via the isDisplayedFromInbox property.
• Added the ability to know if a notification has a landing message attached on BatchInboxNotificationContent using the hasLandingMessage() method.
• Added the ability to display a landing message attached to a BatchInboxNotificationContent using the displayLandingMessage() method.

Messaging

• Added support for Dynamic Type allowing Batch to adapt textual content to honor the user's font size settings. This is enabled by default, you can disable it at any moment by using [BatchMessaging setEnableDynamicType:false].
• In-Apps Banner no longer displays when the presented view controller is an SFSafariViewController as it should not be hidden or obscured by other views or layers.

Compiles with Xcode 13.3.1 Batch requires Xcode 13.3.1 and iOS 10.0 or higher

Note: Due to Xcode 14 dropping support for Bitcode and 32-bit architectures, this is the last minor version to be bundled with these slices.

Messaging

• In-App WebView can now display inline <video> elements.

Compiles with Xcode 13.3.1 Batch requires Xcode 13.3.1 and iOS 10.0 or higher

Note: Due to Xcode 14 dropping support for Bitcode and 32-bit architectures, this is the last minor version to be bundled with these slices.

Core

• Added support for Universal Links in apps using UISceneDelegate

Messaging

• In-App WebView will now ignore WebKit error (204) when loading a video URL without HTML container

Compiles with Xcode 13.3.1 Batch requires Xcode 13.3.1 and iOS 10.0 or higher

Note: Due to Xcode 14 dropping support for Bitcode and 32-bit architectures, this is the last minor version to be bundled with these slices.

Core

• Fixed a SQLite crash caused by a race condition: triggering an In-app message with "Re-evaluate campaign eligibility" enabled right after calling [BatchUserDataEditor save] could make concurrent accesses to SQLite and crash.

Messaging

• Fixed a rare crash that could happen when re-evaluating multiple campaigns eligibility for a same trigger.

Compiles with Xcode 13.3.1 Batch requires Xcode 13.3.1 and iOS 10.0 or higher

Note: Due to Xcode 14 dropping support for Bitcode and 32-bit architectures, this is the last minor version to be bundled with these slices.

Core

• Fixed implementations of various internal objects implementing NSCopying, which could crash in some rare cases on pre iOS 13 devices.
• Fixed an issue the SDK would not send a notification permission status change to Batch's servers until a later SDK start.

Compiles with Xcode 13.3.1 Batch requires Xcode 13.3.1 and iOS 10.0 or higher

Note: Due to Xcode 14 dropping support for Bitcode and 32-bit architectures, this is the last minor version to be bundled with these slices.

Core

• Fixed an issue where some non-profile data (display receipts and In-App campaign view history) wasn't deleted after using [Batch optOutAndWipeData].
• Updated BatchMessagingContentType's definition to use a modern NS_ENUM declaration. Fixes an issue where the header could not be parsed in an Objective-C++ context.

Messaging

• Fixed a display issue on Modals with an image but no title.

Compiles with Xcode 13.3 Batch requires Xcode 13.3 and iOS 10.0 or higher

Event Dispatchers

• Added name and version on the BatchEventDispatcherDelegate protocol. There is no need to implement those in your implementations. If you are using a Batch dispatcher plugin, please update it.

Messaging

• In-App campaigns are now synchronized on SDK start without delay and will fallback on local cache. This changes the way the "next session" trigger works, which is now equivalent to what used to be "as soon as possible".
• Added just-in-time verification for In-App campaigns.

Inbox

• Added the ability to disable the filtering of silent notifications on BatchInboxFetcher using the filterSilentNotifications property.
• To support this feature, we deprecated the title and body properties on BatchInboxNotificationContent and moved them under the message property, which is nil for silent notifications. For compatiblity, when filterSilentNotifications is set to false the body notification content property will be set to the empty string.
• Added the isSilent property on BatchInboxNotificationContent to identify silent notifications.

Compiles with Xcode 13.1 Batch requires Xcode 13 and iOS 10.0 or higher

Core

• Updated BatchMessagingContentType's definition to use a modern NS_ENUM declaration. Fixes an issue where the header could not be parsed in an Objective-C++ context.

Messaging

• Fixed a display issue on Modals with an image but no title.

Compiles with Xcode 13.1 Batch requires Xcode 13 and iOS 10.0 or higher

Core

• Batch's XCFramework distribution now has an empty "PrivateHeaders" folder in the Mac Catalyst distribution to satisfy a broken link created by xcodebuild.

Inbox

• Fixed an issue where the inbox wouldn't return notifications if the installation was upgraded from an application version running Batch 1.17. Fresh app installs worked as expected.

Compiles with Xcode 13.1 Batch requires Xcode 13 and iOS 10.0 or higher

Starting with this release, Batch can be installed as a XCFramework when using Carthage 0.38 and higher

Core

• Added Universal Links support. If your application handles them, please declare your associated domains with [Batch setAssociatedDomains:];. If your site uses multiple subdomains (such as example.com, www.example.com, or support.example.com), each requires its own entry like in the Associated Domains Entitlement.

Events

• Added NSURL type for the events data.
• Batch now emits the BatchEventTrackerFinishedNotification NSNotification when the event tracker has finished sending events. This notification might be triggered multiple times in a row.
  Read BatchTrackingEventsDidFinishWithSuccessKey in the userInfo to know whether the operation succeeded or failed.

Attributes

• Added NSURL type for the custom attributes.

Inbox

• Batch will now cache notifications marked as read or deleted to avoid any synchronization issues.
• Property isDeleted from a BatchInboxNotificationContent is now deprecated: see BatchInbox.h for more info.

Debug

• Batch will now copy the installation ID to the clipboard when the application is foregrounded multiple times in a short timespan. This is enabled by default, you can disable it at any moment by using [Batch setEnablesFindMyInstallation:false].

Compiled with Xcode 12.4
Batch requires Xcode 12 and iOS 10.0 or higher

Core

• Resolved an issue introduced in 1.17.2 where [Batch optOutWithCompletionHandler:] ignored the developer callback and behaved as if BatchOptOutNetworkErrorPolicyIgnore was returned.

Compiled with Xcode 12.4
Batch requires Xcode 12 and iOS 10.0 or higher

Core

• Resolved an issue where calling [Batch optOut] or [Batch optOutAndWipeData] could crash if Batch wasn't started.
• Stopped requesting the Identifier for Vendors (IDFV) from iOS. It was unused since we discontinued Batch Unlock in 2017.
• IDFA isn't displayed in the debug view anymore, even if IDFA collection is enabled.
• On iOS 14.5 and higher, when IDFA collection is enabled, Batch will not query iOS for the advertising ID unless the AppTrackingTransparency request has been explicitly approved by the user.
  This is an optimization: The identifier had never been collected in this case due to iOS blocking it.

Inbox

• Fixed an issue where using markAsRead would mark future notifications as read as soon as they arrived.
• Fix an issue where fetchNewNotifications would behave like fecthNextPage if notifications were already loaded.

Compiled with Xcode 12.4
Batch requires Xcode 12 and iOS 10.0 or higher

Messaging

• Fix a bug where a user could not interact with the application under a Banner format on iPadOS 14. iPhones were unaffected.
• Fix a very rare race condition where the SDK could crash in -[BALocalCampaignsManager isEventWatched:].

Compiled with Xcode 12.4
Batch requires Xcode 12 and iOS 10.0 or higher

Core

• Added the ability to enable Batch's internal logging using [Batch setInternalLogsEnabled:true]. They can also be enabled using the -BatchSDKEnableInternalLogs process argument.
  Internal logs should be disabled when submitting your app to the App Store.
• Added nullability annotations to BatchLoggerDelegate. This might trigger a warning in your Swift code.

Actions

• Add a "copy to clipboard" builtin action (batch.clipboard).
• Add a "rate app" builtin action (batch.rating). Requires iOS 10.3 or higher.

Messaging

• Added support for a new UI format: WebView. See documentation for more info.
• Added batchMessageWasCancelledByError: to BatchMessagingDelegate, called when a message could not be loaded due to an error when loading the message's content.
• Added batchWebViewMessageDidTriggerAction:messageIdentifier:analyticsIdentifier: to BatchMessagingDelegate, called when a message could not be loaded due to an error when loading the message's content.
• Modal formats can now be closed with the escape key
• Fix a bug where cached in-app campaigns might not be deleted when all campaigns were disabled
• In-App campaign cache is now cleared on server errors
• Fix an issue where the statusbar color would not be applied

Event Dispatchers

• Added the new event types BatchEventDispatcherTypeMessagingCloseError and BatchEventDispatcherTypeMessagingWebViewClick.

Push

• Notification opens, deeplinks and mobile landings are now working when notifications aren't displayed in the foreground (willShowSystemForegroundAlert: false).

Inbox

• [BatchInbox fetcherForUserIdentifier:authenticationKey:] now returns a nil instance if "userIdentifier" is nil.

Compiled with Xcode 12.4
Batch requires Xcode 12 and iOS 10.0 or higher

This release backports changes from 1.17.1

Messaging

• Fix a bug where a user could not interact with the application under a Banner format on iPadOS 14. iPhones were unaffected.
• Fix a very rare race condition where the SDK could crash in -[BALocalCampaignsManager isEventWatched:].

This release has been built using Xcode 12.1.

A migration guide from Batch 1.15 and lower is available here.

BREAKING: This version drops support for iOS 8 and 9 Batch requires Xcode 12 and iOS 10.0 or higher

Batch now depends on libz. This might require a change in your project:

• CocoaPods: The podspec has been updated to add the required linker flag. No action is needed.
• Carthage/Manual integration: When building, Xcode should automatically link your project with libz. If you get a compilation error, add -lz to your linker flags, or add libz to "Frameworks and Libraries" in your app's target.

Batch and Apple Silicon
In order to support Apple Silicon, Batch will adopt the XCFramework format: it is not possible to support the iOS Simulator on Apple Silicon macs in a "fat" framework. What it means for you:

• CocoaPods users will be migrated to the XCFramework automatically
• Carthage users will stay on the old distribution style until Carthage supports XCFrameworks.
• Manual integrations should update to XCFramework as soon as possible. Batch will be distributed in both formats for a couple of versions.

Note that the armv7s slice is not included in the XCFramework distribution.

BatchExtension

BatchExtension isn't distributed with the SDK zip anymore. It will be released on github soon after this release.

Core

• Batch is now compatible with iOS 14's tracking consent and IDFA changes.
• Added UIScene support. If your application uses it, you must add an UNUserNotificationCenterDelegate, otherwise Direct Opens, Deeplinks and Mobile Landings will not work: UIScene disables legacy push application delegate methods.
• eSIMs are now supported. Phones that only have an eSIM will now properly report back their carrier, if the feature hasn't been disabled.
• More nullability annotations have been added. As those annotations match Apple's own, we do not expect source compatibility to break.
• Support for TLS versions older than 1.2 has been removed.
• Added a new builtin action named batch.ios_tracking_consent, which requests tracking consent via AppTrackingTransparency. More info in the documentation.

Event Dispatchers

• BatchEventDispatcherTypeNotificationOpen is no longer broadcasted when the application is processing a background push.

Inbox

• Enhanced the way the SDK fetchs notifications from the servers to greatly reduce bandwidth usage. No public API change.

Push

• Add a new method BatchPush.isBatchPush to check if a received push comes from Batch.
• Added BatchUNUserNotificationCenterDelegate, an UNUserNotificationCenterDelegate implementation that forwards events for Batch. Call BatchUNUserNotificationCenterDelegate.register() to automatically set it as your delegate. BatchUNUserNotificationCenterDelegate can display notifications when your app is in the foreground using the showForegroundNotifications property.
• Batch will now emit a warning in the console when your app does not register an UNUserNotificationCenterDelegate by the time application:didFinishLaunchingWithOptions: returns. Implementing this delegate improves Batch's handling of various features that rely on notification interaction feedback, such as analytics or deeplinks: it is strongly recommended that you implement it if you don't already.
• Batch now emits the BatchPushOpenedNotification NSNotification when a notification has been opened by the user. This deprecates BatchPushReceivedNotification: see BatchPush.h for more info.
• In automatic mode, application:didReceiveRemoteNotification:fetchCompletionHandler:'s completion handler is no longer called on your behalf when a deeplink is opened.

Messaging

• The "modal" format now correctly triggers actions after it has been dismissed. This will have an impact on when the custom actions are executed, making them more consistent with the Fullscreen format.
• This fixes an issue where deeplinks could not be opened in the application using SFSafariViewController with modal formats.
• The image format is now properly sized when in a freeform window (iPad in Split View, Catalyst)
• Fix a rare race condition with the interstitial format where it would fail to layout properly when the image server could not be reached.
• Modally presented messages will not be allowed to be dismissed unless they're the frontmost view controller. This fix an issue where a message with an autodismiss might dismiss a view controller presented on top of it.
• Improved dismissal logic. While automatic dismissal may fail in some rare occasions due to iOS refusing to dismiss a modal view controller when one is animating, it will not prevent the user from manually dismissing the view anymore.

User

• Added new strongly typed methods for setting attributes on BatchUserDataEditor. They greatly enhance Swift usage of the API. See setBooleanAttribute:forKey:error and similar methods (set(attribute: Bool, forKey: String) in Swift).

• Those new methods return validation errors: you can now know if your attribute key/value does not pass validation and will be discarded.
• nil values are not supported in the new methods. Use removeAttributeForKey: explicitly.

Debug

• Clicking the "share" buttons in the debug views no longer crash on iPads.

This release has been built using Xcode 11.5.

This is the LAST minor release that support iOS 8 and 9. Future releases will require iOS 10+

Event Dispatcher

• Fix an issue where event dispatchers might not be called.

User

• Fix an issue where events that had not been sent to the server would be lost when the app's process was killed.

This release has been built using Xcode 11.5.

This is the LAST minor release that support iOS 8 and 9. Future releases will require iOS 10+

User

• Added support for Date in BatchEventData.
• BatchEventData now supports up to 15 attributes (from 10).

This release has been built using Xcode 11.3.1.

This is the LAST release that support iOS 8 and 9. Future releases will require iOS 10+

Core

• Changed how notification status is reported: The SDK will now tell Batch's servers that notifications are enabled if :
  • The app has requested and holds a provisional authorization.
  • The user has disabled banners but kept lockscreen or notification center delivery enabled.
• Added support for external analytics using BatchEventDispatcher. See the documentation for more details.

Messaging

• New enum property BatchMessagingContentType contentType on class BatchInAppMessage to help cast to the right content class.
• A new optional delegate method BatchMessagingDelegate.presentingViewControllerForBatchUI allows to specify which view controller to display Batch messages on.
• Fixed an issue where the last line of a label could be cut.
• Improved accessibility of all message formats

Inbox

• Added the markNotificationAsDeleted: method on BatchInboxFetcher, allowing the deletion of notifications

Requires Xcode 11
This release has been built using Xcode 11.1.

Messaging

• Fix an issue where mobile landings might fail to be shown after opening a push for a backgrounded app on iOS 13
• Fix an issue where BatchDeeplinkDelegate does not fire in certain conditions when opening a push from the lockscreen
• Fix an issue where banners would move more than expected when swiping on them on iOS 13

This release officially supports iOS 13. It has been built using and requires Xcode 11.0 GM 2.

This is the LAST minor release that support iOS 8 and 9. 1.14 patch releases that follow will still support those versions.

Messaging

• Add UIScene support
• Add an analytics event for iOS 13's modal swipe-to-dismiss

Core

• Bug fix: deeplinks from actions are properly sent to Deeplink delegate method
• Fixed an issue where the server-side GDPR wipe event was not sent properly
• Fixed an issue where the Installation ID may not be wiped properly after a GDPR wipe

User

• High level data (language/region/custom user id) can now be read back.
• User data (attributes and tags) can now be read back. Documentation

Messaging

• Added support for two new UI formats: Modal, and Image. See the documentation for more information.

• Added support for GIFs in Mobile Landings and In-App messages

• Added support for rich text.

• Added support for text scrolling in all formats. Banners will now have a maximum body height of ~160pt, and their text will scroll.

• Deeplinks can now be open directly in the app using a SFSafariViewController for Push Notifications, Mobile Landings and In-App Mesasges

• Added new methods on the messaging delegate allowing you to track more information such as close/autoclose and button presses. More info in the Mobile Landings documentation.

• In Swift, BatchMessaging.setAutomaticMode has been renamed to BatchMessaging.setAutomaticMode(on:)

Push

• BatchPushAlertDidResignNotification is sent when user dismissed the Remote notification authorization alert. Notification's userInfo dict contains user's choice in BatchPushNotificationDidAcceptKey.

Requires Xcode 10

Core

• Fixed a rare race condition crash that could happen when tracking an event while In-App campaigns are fetched from the server.

User

• Fixed an issue where adding tags would not work with 1.13.1

Re-release of 1.13.0, compiled with Xcode 10.1. Batch now includes an arm64e slice.

Note: This release comes with an update to the included BatchExtension framework.

Requires Xcode 10

Migration guide

Core

• Fixed a rare crash that could happen when Batch's internal database failed to initialize in [BAUserDataManager startAttributesSendWSWithDelay:].

• Opting-out from the SDK now sends an event notifying the server of this. If a data wipe has been asked, the request will also be forwarded to the server. New methods have been introduced to be informed of the status of the request to update your UI accordingly, and possibly revert the opt-out if the network is unreachable.

• Added the BatchDeeplinkDelegate protocol. Adopting it allows you to manually process deeplink open requests from Batch, rather than having to implement openURL. See Batch.deeplinkDelegate for more information.

Push

• The SDK will report whether notifications are allowed, denied, or undecided more accurately on iOS 10 or higher
• Added a method to easily open iOS' settings for the current application's notification settings
• Split +[BatchPush registerForRemoteNotifications] into more explicit methods.
  • +[BatchPush requestNotificationAuthorization] shows the system notification authorization prompt, and then fetches the push token. Equivalent to calling +[BatchPush registerForRemoteNotifications].
  • +[BatchPush refreshToken] will only ask iOS for a new token. This needs to be called on every application start to handle upgrades from versions without Batch, or if iOS changes the push token.
• Added support for iOS 12's notification changes:
  • You can now ask for provisional notification authorization using +[BatchPush requestProvisionalNotificationAuthorization]. This method does nothing on versions lower than iOS 12.
  • You can now ask Batch to tell iOS that your app supports opening an in-app notification settings from the system settings by calling [BatchPush setsetSupportsAppNotificationSettings:true] Note that this still requires you to implement a UNUserNotificationCenterDelegate, and the appropriate method to open the settings.

Events

Event data support has been overhauled. As a result:

• Introduced BatchEventData. Use this class to attach attributes and tags to an event. See this class' documentation for more information about limits.
• +[BatchUser trackEvent:withLabel:data:] has been deprecated

• Calls to this method will log deprecation warnings in the console
• Legacy data (NSDictionary) will be converted to BatchEventData. Same data format restrictions apply: Any key/value entry that can't be converted will be ignored, and logged. Tags are not supported

• Introduced +[BatchUser trackEvent:withLabel:associatedData:] which uses BatchEventData, replacing the deprecated method.

• Swift users: Since Swift allows methods to be overloaded by type, the method and arguments name do not change: simply replace your data dictionary with a BatchEventData instance Example: BatchUser.trackEvent("event_name", withLabel: "label", data: BatchEventData())

• Added methods to handle opting-out from Batch, and wiping user data.
  Please see [Batch optOut], [Batch optOutAndWipeData] and [Batch optIn].
  You can control whether Batch is opted out from by default setting a boolean TRUE in your Info.plist for the key:
  BATCH_OPTED_OUT_BY_DEFAULT
  For compatibility reasons, Batch will be enabled by default.
  More info in our documentation.

• Fixed a bug where an In-App Campaign might not trigger for a certain configuration if a tracked event had a label

• Added support for a new Banner format for In-App Messaging and Mobile Landings

  If your app uses the Mobile Landing/In-App Messaging manual mode, and especially [BatchMessaging loadViewControllerForMessage:error:] you need to change the way you present the view controllers manually: please check the [updated manual mode documentation]/ios/mobile-landings.html) for more information.
  A helper has been added on BatchMessaging, which is especially useful if you don't feel like making your own UIWindow: [BatchMessaging presentMessagingViewController:]

• Fix In-App Campaigns not honoring the grace period

• Fix an issue where on iOS 11, the fullscreen Messaging template may not be displayed correctly for themes with no CTA

• The SDK will now log the current Installation ID on start

• Added [BatchMessaging presentViewController:], which takes care of showing a previously loaded BatchMessagingViewController in the most appropriate way.

  If you used [BatchMessaging loadViewControllerForMessage:error:] to display messages in manual mode, you should go to the messaging documentation to follow updated instructions: failure to do so will result in incorrect banner behaviour.

• Added support for Smart Invert in Mobile Landings/In-App Messaging. Images won't be inverted anymore.

• Added iPhone X support for Mobile Landings/In-App Messaging.

• [BatchMessaging loadViewControllerForMessage:error:] is now allowed in automatic mode.

• Delay button handling in messaging views to until animations are over. This may have prevented deeplinks or custom actions from working properly, as UIKit does not support presenting a view controller while one is already animating.

• Fix In-App Campaigns accidentally performing too much work on the main thread.

• Fix a concurrency issue with In-App Campaigns which could very rarely cause a crash

• Added a method on BatchInAppMessage, allowing you to fetch the visual content of the message. See BatchInAppMessage's content property for more info

• Fixed a bug where overriding a bold font would not work proper for mobile landings
• Various bugfixes

• Removed the one minute minimum delay between two In-App campaign triggers
• Fixed a bug where In-App Campaigns were sometimes not refreshed when coming back in foreground
• Fixed a bug where In-App Campaigns failed to trigger on "Next Session"
• Other bugfixes

• Fixed issues found by the Main Thread Checker in Xcode 9
• Introduced In-App Campaigns
• Added a Do Not Disturb mode on BatchMessaging, allowing easier control of when landings will be shown

• Added the Inbox module, allowing you to fetch previously received notifications from your code. More info: [Inbox documentation]/ios/inbox)

• BREAKING CHANGE: Removed BatchAds and BatchUnlock methods and related classes.
• Added BatchUser.trackLocation, allowing you to natively track user position updates
• Deprecated Batch.isRunningInDevelopmentMode. It is useless, as DEV API Keys always start with "DEV"
• Fix a temporary freeze when opening a push containing a deeplink when triggered by a UNUserNotification delegate
• Fixed a memory leak with network requests
• Rewrote documentation with a more modern syntax. Our API docs are now based on jazzy.

• Fix a bug where the delegate set on BatchMessaging was never called.

• A bug where landings and open rate tracking didn't work when coming from a cold start in some situations on iOS 10.1/10.2 was fixed. Apps implementing UNUserNotificationCenterDelegate or the "fetchCompletionHandler:" variant of the legacy app delegate callbacks are not concerned.
• Applying changes with the user data before starting Batch doesn't fail silently anymore, but now logs an error.
• Improved log clarity for some errors

• Rebuild the SDK without debug symbols

• Fix the handling of notifications opened while the app is on the screen when using UNUserNotificationCenter on iOS 10. The "bug" remains on iOS 9 because of framework limitations.
• Introduced Mobile Landings

• Batch now requires iOS 8 or greater.
• [Batch setUseAdvancedDeviceInformation:] has been introduced to reduce the quantity of device information Batch will use. Note that disabling this will limit several dashboard features.
• Batch will now use the UserNotification framework when possible. UIUserNotificationCategory instances given to [BatchPush setNotificationsCategories:] are automatically converted to UNNotificationCategory on iOS 10.
• BatchPush has new methods that allows it to be integrated into a UNUserNotificationDelegate instance.
• [BatchPush registerForRemoteNotificationsWithCategories:] has been split in two methods and is now deprecated
• Introduced a new dynamic framework, BatchExtension. It is compatible with application extensions APIs, and will progressively bring more Batch features to your extensions. In this version, it is used to add support for Rich Notifications.

Since iOS 10 changes quite a lot in how notifications work, it is strongly advised that you read our iOS 10 documentation: https://batch.com/doc/ios/advanced/ios10-migration.html . Upgrading to UNUserNotificationDelegate is recommended.

• Fixed push token environment detection (Production/Sandbox) logging
• Fixes a bug where +[BatchPush trackEvent:withLabel:] didn't track the event label correctly

• Removed most of the categories used by the SDK. -ObjC shouldn't be needed anymore, but it is encouraged to keep it
• Added support for manual integrations: Application Delegate swizzling can now be disabled, but ALL Batch entry points should be implemented carefully. More info on https://batch.com
• Improved support for notifications containing "content-available":1
• Added .gitignore in "Batch.bundle" to fix git issues for those who commited Batch itself
• Deprecated [BatchPush setupPush]. It is now implied.

Fixed:

• Rare bug that triggered a misdetection of the push token kind
• Logs about the push token kind are now clearer

New:

• Custom user data (attributes, tags and events)
• Added an API to retrieve Batch's unique installation identifier
• Deprecated BatchUserProfile
• HTTP/2 Support (NSURLSession replaces the NSURLConnection backend when available)

New:

• Batch Ads has been discontinued
• iOS 9 and Xcode 7 support
• Added Bitcode support
• Added a method for getting the last known push token
• Improved push registration logs in case of failure
• Fixed Xcode 7 compatibility when integrated via CocoaPods

Note: : If you previously integrated Batch, you may need to remove lines that look like $(PODS_ROOT)/Batch/** from "Framework Search Paths"in your Build settings for Batch to work with Xcode 7.

Improved:

Improved Native Ads:

• Added properties on BatchNativeAd to get image paths on disk (icon and cover)
• Added a method to load Native Ads without preloading their UIImages
• Added a MoPub custom event for Native Ads: BatchMoPubCustomNative

New:

• Automatic deeplink handling can now be disabled
• Added a method for getting the deeplink from Batch Push

Fixed:

Fix an issue that could cause a freeze if your application embedded custom fonts and was started in Airplane mode

New:

• Introduced Native Ads.
• Deprecated legacy Ads methods in order to prevent confusion between Native and Interstitial Ads. More info in the 1.2 to 1.3 migration guide

Improved:

• Interstitial Ads are now displayed in a top level UIWindow rather than pushed in your top view controller, for faster and more reliable display.
• Importing Batch using @import Batch; now imports all of Batch's modules. If you

want to keep the old behavior, import the new Batch.Core submodule, rather than Batch.

• Batch now logs starts for DEV APIKeys.

Fixed:

• Fixed a crash on iOS 6 that occurred when some application delegate methods were not implemented.
• Improved Interstitial Ads on iOS 6 devices.

Fixed:

Various minor bugfixes.

Modified:

• More robust push
• Improved deeplink handling

Fixed:

Minor bugfixes

Bugfixes.

Added:

Batch Ads (interstitials) released.

Fixed:

Stability improvements.

Added:

• Batch Push released.
• iOS 8 and Objective-C modules support.
• Dropped iOS 5 compatibility.
• BatchUnlockDelegate is now weakly retained, rather than strongly retained.
• Batch now requires you to link with libsqlite3.dylib

Fixed:

Moved a file put by mistake in uments/ into /Library/Application Support/.

Added:

Batch out of beta testing and 1.0 published.