SDK changelog

v1.14.1 - 18/09/2019

Download: iOSRequires Xcode 11

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.

Future releases of the SDK will be distributed as a dynamic framework, as opposed to the current static framework, and will require the Swift runtime in your app.
It will be distributed in the XCFramework format for supported package managers and manual downloads.


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

v1.14.0 - 30/04/2019


  • 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


  • High level data (language/region/custom user id) can now be read back.
  • User data (attributes and tags) can now be read back. [Documentation]/ios/custom-data/custom-attributes#_reading-attributes-and-tag-collections)


  • 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:)


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

v1.13.2 - 22/11/2018

Requires Xcode 10


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


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

v1.13.1 - 05/11/2018

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.

v1.13.0 - 19/09/2018

Requires Xcode 10

Migration guide


  • 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.


  • 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.


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())

v1.12.0 - 26/04/2018

  • 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:
    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

v1.11.0 - 23/02/2018

  • 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

v1.10.4 - 10/11/2017

  • 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

v1.10.3 - 18/09/2017

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

v1.10.2 - 04/09/2017

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

v1.10.1 - 16/08/2017

  • 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

v1.10.0 - 03/08/2017

  • 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

v1.9.0 - 08/06/2017

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

v1.8.0 - 27/04/2017

  • 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.

v1.7.4 - 02/02/2017

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

v1.7.3 - 20/12/2016

  • 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

v1.7.2 - 9/11/2016

  • Rebuild the SDK without debug symbols

v1.7.0 - 27/10/2016

  • 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

v1.6.0 - 29/09/2016

  • 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: []/ios/advanced/ios10-migration.html) . Upgrading to UNUserNotificationDelegate is recommended.

v1.5.4 - 08/06/2016

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

v1.5.3 - 21/04/2016

  • 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
  • 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.

v1.5.1 - 03/03/2016


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

v1.5 - 25/01/2016


  • 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)

v1.4 - 10/09/2015


  • 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.

v1.3.2 - 01/07/2015


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


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

v1.3.1 - 10/06/2015


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

v1.3 - 02/06/2015



  • 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.

v1.2.6 - 07/05/2015


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

v1.2.5 - 16/04/2015


Various minor bugfixes.

v1.2.4 - 26/03/2015


  • More robust push
  • Improved deeplink handling


Minor bugfixes

v1.2.3 - 06/03/2015


v1.2.2 - 24/02/2015


Batch Ads (interstitials) released.

v1.1.1 - 16/12/2014


Stability improvements.

v1.1 - 09/10/2014


  • 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

v1.0.1 - 10/08/2014


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

v1.0 - 08/07/2014


Batch out of beta testing and 1.0 published.

v0.x - 21/02/2014


Bastion, the predecessor to Batch, is released with Unlock functionality.