1 of 41

iOS

Prerequisites

Creating an app

Let's get going!

The very first step is to go to Batch's dashboard and create a new iOS app.

Configuring notifications

Once your app is created, you will need to download a .p8 file and upload it to Batch's Dashboard.

As a reminder, Batch servers need to have a valid certificate in order to communicate with Apple Push Notification Services (APNS). There are two types of files you can use:

.p8 files (recommended) : Valid for all the apps added to your Apple developer account. You will need to specify the Application Identifier (App ID) or the Bundle ID of your app on Batch's dashboard.
.p12 certificates: Generated for a unique App ID and are only valid for one year. If you need a .p12 certificate, please follow these instructions: .

Step 1. Downloading the .p8 file

Head to the , then go to the "Keys" menu and add a new key.

Give a name to your key, tick the "Apple Push Notifications Service" box (1) and press "Configure" (2).

There, in the "Environment" dropdown, select "Sandbox & Production".

Click "Save" and continue until you can download the P8 key. Write down your Key ID.

Step 2. Uploading the .p8 file

Now go to Batch's dashboard → ⚙ Settings → Push settings, and upload your .p8 file.

There are two IDs you need to find to save your certificate and send notifications to your app:

App ID / Bundle ID: We recommend you use the bundle ID you will find in Xcode. You can also use the app ID available from the Developer Console .
Team ID: The team ID is also available from the Developer Console . It is also shown under your name in the top bar of the place you created your p8 key.
Key ID: The Key ID should be automatically filled if you didn't rename the p8 file you downloaded from Apple. If it was not, use the Key ID you have written down earlier. You can also find the Key ID in the Apple Developer Member center, where you generated it.

License Attribution

As Batch uses open-source software, you must include attribution text in your application. This usually goes in a "Legal Notices" or "About" screen.

You can get the attribution text .

SDK Integration

Initial setup

Integrating the SDK

Native SDK

The iOS SDK is a standard mergeable dynamic library, compatible with iOS 15.0 and higher (iOS 16.0 or higher for Mac Catalyst only). Xcode 26.1+ is required, but Batch will work with all Swift versions, along with Objective-C.

It supports the following architectures:

Profile Data

Custom user ID

Batch attaches SDK's installations to a Profile and centralize data and events from multiple sources (Apps, Websites, APIs) in a single place based on a Custom user ID. This allows Batch to support more complex and cross-channel lifecycles: it is now possible to message a user on a channel even though its profile data is fed from another one.

This allows you to use the .

This custom user identifier can be:

The unique ID you are using in your login system.
A stable ID used in your data store (e.g. Firebase, etc).

Custom region/language

Batch allows you to set a custom region or a custom language that will override the value detected by the SDK. By default, Batch collects the language and the country of your users' devices.

Setting a custom region/language is useful if:

You don't want to use the values detected by Batch.
Your users can choose their own language or region for localization purposes.

Writing custom region/language

If you call editor method before startWithAPIKey it will return nil. You should always call it after you started the SDK, and check nullity to be safe.

Reading custom region/language

Keep in mind that the data returned is only about your installation and not your Profile since it may be updated from another source.

Email subscription

The iOS Batch SDK allows you to:

Add and remove email address from a user profile. The profile will automatically be created if needed.
Edit a profile's marketing subscription.

In order to set an email address and subscription status on a profile, the creation of a project is required. If no project is set up, any calls made for these actions will be ignored.

SMS subscription

The Android Batch SDK allows you to:

Add and remove phone number from a user profile. The profile will automatically be created if needed.
Edit a profile's marketing subscription for the SMS channel.

In order to set a phone number and subscription status on a profile, the creation of a project is required. If no project is set up, any calls made for these actions will be ignored.

Here is how to set a phone number with a marketing subscription:

Note:
The phone number must be an formatted string starting with a + and not longer than 15 digits without any special characters. It should match the following regular expression : ^\+[0-9]{1,15}$
Remember if you call editor method before startWithAPIKey it will return nil. You should always call it after you started the SDK, and check nullity to be safe.

Profile data migration

To make it easier to collect data to a Profile, Batch has added two automatic ways to migrate old installation's data on a Profile:

User will be automatically identified (logged-in) if he had a Batch custom_user_id set on the local storage.
User natives (language/region) and custom data will be automatically migrated to a Profile.

These migrations are triggered when your application on the dashboard is attached to a Project. Concretely this mean that there's two possible scenarios:

Testing your integration

Batch provides a simple debug tool that allows you to test your custom data integration (⚙ Settings → Debug). It shows all the data available for a specific user ID:

Token: Find the token of a specific device.
Custom user ID: Check if your custom user ID implementation is working correctly.
Native attributes: See the installation date, last session date, country and more information on a specific user / install.
Custom data: See if your app is tagged properly and if custom attributes/events are sent to Batch.

Finding your ID

Installation ID

You can find the Installation ID of a device by calling:

You can either log this to the debug logs, or display it in a debug menu directly in your app. It can safely be exposed to your end users, who can then give it back to you if they are experiencing push trouble with their app.

Starting with Batch 1.18, the SDK will also automatically copy the installation ID to the clipboard if a user follows a .

IDFA

You can use to find your Advertising Identifier (IDFA). Just install the app on your device, tap on the share button and copy the Advertising identifier.

Understanding the results

The results displayed in the debug tool are updated in real time. There are five different pieces of information shown for a single ID:

Basic information (token, install ID, custom user ID, etc).
prefixed with b. (b.attribute_name).
prefixed with c. (c.attribute_name).

Here are some details on the native attributes you will find in the results:

b.app_version: Version of the app installed on your user's device.
b.carrier_code: (Not supported on iOS 16.4+) Your user's carrier. The code provided by Batch is a combination of the Mobile country code (MCC) and the Mobile network code (MNC). The full list of MCC and MNC codes is .
b.city_code: City detected by Batch using IP geolocation.

Data Privacy

SDK opt-out (e.g. GDPR)

If you plan to send personal user data and have to comply with EU's GDPR, any other data privacy law or simply want to give your users more control regarding their privacy, these methods will help you plug your consent screen to Batch.

There are two SDK operation modes:

SDK enabled by default, opting-out required via an explicit method call: this is the default mode.
SDK disabled by default, opting-in required

Event dispatchers

In this article, we'll go through the process of improving your external analytics by either installing a premade event dispatcher or making your own one.

What is an event dispatcher?

Batch can trigger with a number of analytics-oriented events that might be of interest in external analytic tools. An event dispatcher is the code that listens to those events, and dispatches them to the solution of your choice.

Add a "ready-to-go" dispatcher

Batch provide you with premade dispatchers for specific use cases (aka ready-to-go dispatcher). They are enabled by simply registering them in your AppDelegate, and will automatically track events into your analytics solution with a predetermined structure.

Create a custom dispatcher

Or, if you need, you can implement your own dispatcher.

Access data from the event

The Batch SDK will inform you when one of the following event happen:

Push notification displayed : Triggered when a push notification is displayed (only available on Android).
Push notification clicked : Triggered when a push notification is clicked.
Push notification dismissed : Triggered when a push notification is dismissed (only available on Android).
Message showed : Triggered when an in-app or landing message appear on the screen.

With every event comes a BatchEventDispatcherPayload object, allowing you to access data associated with the event, such as a push notification custom payload value, or the tracking ID of an in-app or landing campaign.

Firebase

The Firebase dispatcher automatically dispatches events to the Firebase SDK, including UTM tags when they are available.

https://github.com/BatchLabs/Batch-iOS-firebase-dispatcher.git

Podfile

pod 'BatchFirebaseDispatcher'

github "BatchLabs/Batch-iOS-firebase-dispatcher"

Don't forget to register the dispatcher:

@import BatchFirebaseDispatcher

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
    
    func application(_ application: UIApplication,
                     didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey


// MYAppDelegate.h

@interface MYAppDelegate : UIResponder <UIApplicationDelegate>

[...]

@end

// MYAppDelegate.m

@import BatchFirebaseDispatcher;

@implementation MYAppDelegate

AT Internet

The AT Internet dispatcher automatically dispatches events to the AT Internet SDK, including the XTOR tag when it's available.

This dispatcher should not be used in new integrations in favor of Piano Analytics

github "BatchLabs/Batch-iOS-atinternet-dispatcher"

Podfile

pod 'BatchATInternetDispatcher'

Then, register the dispatcher:

import BatchATInternetDispatcher

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
    
    func application(_ application: UIApplication,
                     didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey


// MYAppDelegate.h

@interface MYAppDelegate : UIResponder <UIApplicationDelegate>

[...]

@end

// MYAppDelegate.m

@import BatchATInternetDispatcher;

@implementation MYAppDelegate

Batch AT Internet Dispatcher 1.1.0+ will automatically instantiate Tracker instances using the default AT Internet configuration, which comes in a plist. If you're not using plist-based configuration and would like to manually configure your Tracker in code, you can tell Batch which tracker instance to use:

Mixpanel

The Mixpanel dispatcher automatically dispatches events to the Mixpanel SDK, using UTM tags when available.

Two flavors of the dispatcher are available, depending on which flavour of the Mixpanel SDK you're using:

One for the Objective-C Mixpanel SDK
One for the Swift Mixpanel SDK

"https://github.com/BatchLabs/Batch-iOS-mixpanel-swift-dispatcher"

Podfile

pod 'BatchMixpanelSwiftDispatcher'
# or
# pod 'BatchMixpanelObjcDispatcher'

Cartfile

github "BatchLabs/Batch-iOS-mixpanel-swift-dispatcher"
# or
# github "BatchLabs/Batch-iOS-mixpanel-objc-dispatcher"

Don't forget to register the dispatcher:

Once your dispatcher is installed, restart your app and you should see something like this in your log:

If you can't find the line in your log, it may be due to missing dependencies, be sure to add the AT Internet and/or Firebase Analytics SDKs to your project.

Custom

If for some reason, you need to implement your own dispatcher, you must create a BatchEventDispatcherDelegate and register it to the SDK using [BatchEventDispatcher addDispatcher].

You don't need to add a dispatcher if you're using one of the previous "ready-to-go" library ! It will be automatically registered.

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate, BatchEventDispatcherDelegate {
    
    func application(_ application: UIApplication,
                     didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]


// MYAppDelegate.h

@interface MYAppDelegate : UIResponder <UIApplicationDelegate,
                                        BatchEventDispatcherDelegate>

[...]

@end

// MYAppDelegate.m

@implementation MYAppDelegate

If the Batch SDK happens to be opt-out from, dispatchers won't receive any events.

Advanced

Deeplinking

URLs present in notifications and mobile landings/in-app messages are handled by the Batch SDK in the following ways:

the default implementation by the SDK will automatically call -[UIApplication openURL:] with any URL it encounters
alternatively you can use a BatchDeeplinkDelegate to handle the URL your way

Migration Guides

Batch 1.16

Batch 1.16 comes with a number of changes regarding the distribution of the SDK and it's extension counterpart.

This migration guide will help you update your implementation.

iOS minimum version

Batch 1.16 requires iOS 10.0 or higher. If your app targets an older version of iOS, please downgrade to 1.15.

Migrating from the older binary BatchExtension

With the 1.16 release, BatchExtension has been rewritten and open-source in two repositories:

(Swift version, recommended)
(Objective-C version, should only be used if you cannot use the Swift one)

This marks the end of the binary distribution of BatchExtension, which used to be bundled with the SDK downloads. The only way to integrate BatchExtension in your application from now on is using the source. Fortunately, package managers make this easy to deal with!

Migrating to the new BatchExtension is done in three steps:

Remove the old BatchExtension framework
Add the new one using a package manager
Update your code to match the new API signatures, if needed.

Removing the old BatchExtension

Since BatchExtension has never been distributed on a package manager, you had to copy it in your project and add a script phase.

In order to remove the framework, simply find it in the Project Navigator (which is the first tab of the left sidebar), and delete it:

When asked what to do with the deletion, pick Move To Trash.

Xcode should have automatically removed the framework reference from the Link Binary With Libraries and Embed Frameworks build steps.

Now, go in your main target's Build Steps and find the Run Script phase that refences a script which path contains BatchExtension.framework/strip-frameworks.sh. Be careful, as you might have multiple script phases. Delete it.

BatchExtension has now been fully removed from your project. Now, we have to add it back!

Adding the new BatchExtension using a package manager

Note: If your extension code is written in Objective-C and uses BAENotificationServiceExtension, please use the Objective-C version of the extension.

The extension is available on Swift Package Manager, CocoaPods and Carthage.

Please which will walk you through integrating the extension, and come back here once done.

Updating your code

If the extension builds without issues, you do not have anything to do!

If it doesn't, what you have to do depends on how you integrated the extension and which language you use:

You're using Swift code

BatchExtension 3.0.0 introduces the following source breaking changes for Swift users:

Classes have been unprefixed (except BAENotificationServiceExtension). For example, if your Swift code references BAERichNotificationHelper, you need to change it to RichNotificationHelper.
RichNotificationHelper.appendRichData(to: completionHandler:) has been renamed. It is now RichNotificationHelper.appendRichData(toContent: completionHandler:). Xcode offers a quickfix for this.

You're using Objective-C code

While the public API doesn't change, you might run into the following message: Cannot subclass a class that was declared with the 'objc_subclassing_restricted' attribute. This happens if you used the standard version of the extension using Swift PM. To fix this, use the Objective-C version of the extension as described in the , or rewrite the extension code in Swift (do not forget to update the extension's Info.plist with the new class name).

If you run into any other issue, please contact our support team to get help on your migration.

Migrating to XCFramework

Batch 1.16 is now distributed as a static XCFramework instead of a legacy fat static framework. While the legacy framework format is still distributed, we encourage you to switch to the XCFramework build as soon as possible.

CocoaPods

Batch 1.16.0 and higher are distributed as a XCFramework in CocoaPods. CocoaPods should handle the transition without needing any action on your end.

If you're running into issues, make sure you've updated to the latest CocoaPods version for XCFrameworks support.

Carthage

As of writing, Carthage (ver 0.36.0) does not support XCFrameworks. Therefore, Batch is still distributed as a fat framework for Carthage.

iOS Simulator for Apple Silicon and Mac Catalyst support are not available with carthage.

Swift Package Manager

We've heard loud and clear that developers would like to use Swift Package Manager to add Batch in their app. Unfortunately due to bugs in Xcode 12's handling of binary frameworks in SPM packages, Batch isn't distributed there yet. We will reevaluate this decision when a new version of Xcode that fixes the issues is released.

Manual Integration

Replacing your manual Batch integration with the XCFramework distribution is quite easy.

First, delete Batch.embeddedframework (or Batch.framework) in the Project Navigator. Xcode should remove all of the Framework's reference in the build steps. Pick Move To Trash when asked.

Then, drag & drop Batch.xcframework in the Project Navigator where the framework you deleted was. Unless you manually copied the XCframework folder into your project's directory, check Copy items if needed. Make sure the only checked target is your Application target: extensions should be unchecked.

Xcode should have added Batch.xcframework in the Link Binary With Libraries build step. Add it manually if this did not happen.

Your project should now build!

Inbox

Inbox is an optional feature. If you are interested, please contact us.

The Inbox API allows you to fetch and process notifications that this user has previously received, even if their device was offline. You can then do anything you want with the data, such as making a "notification center", where the user can catch up with previous notifications in a list.

The API gives you access to the entire notification, including its raw payload. It also lets you know if the notification has already been read, and allows you to mark one or all notifications as such. Once received/stored in the inbox, your push notifications will remain for a 3 months period.

This screenshot is an example of what you can achieve with the Inbox API. Please note Batch does not include any UI.

Picking the Right Fetcher

Installation Mode

This mode will fetch notifications from the current app installation, and nothing else. If the user clears the app's data, this inbox will be cleared. This is great for applications where your users don't have to log in.

In this mode, you can simply get the Inbox Fetcher with a context:

Note: This may cause privacy issues if your app has an identification system. Users sharing the same device and using different accounts in your app would be able to see the push history of previous users.

Custom User ID Mode

This mode will fetch notifications for the specified , even if they just installed the application and already got notifications on another device logged in with the same user identifier. If your application has a login system, this is the mode you should use.

Since notifications can have sensitive content, you cannot get a user's notifications simply with their user identifier: Batch requires you to authenticate your request.

Getting Your Authentication Key

First, you will need your inbox secret key. You will find that in your dashboard, below your API Keys. It is unique for every app.

The authentication key is generated by computing a sha256 hmac hash of the API Key concatenated with the user identifier, using the secret as the key. Then, you have to encode the hash in a hexadecimal string.

For the API Key "abcdef", user identifier "paul" and secret of "foobar", the string to hash is abcdefpaul and the expected authentication key would be 796f1ab5d119d1b2eab8201e60335b56d1befff40c0f80263d64a169a8fd2e45.

PHP example code:

Note: This hash HAS to be computed on your server. If you bundle the inbox secret in your application to compute the hash, attackers will be able to extract it, and read the notifications of any of your users

Getting the Fetcher Instance

Once you've got the authentication key from the server, you only have to give Batch the right user identifier and auth key tuple to get the Inbox Fetcher:

Fetching Notifications

Now that you've got your fetcher instance, it's time to fetch notifications, and display them!

The inbox fetcher has several important methods and properties:

allFetchedNotifications This returns a copy of all the notifications that have been fetched. Useful for a list adapter. Warning: Calling this always makes a copy of the objects, so you should cache that method's result.
fetchNewNotifications() Allows you to fetch notifications that might have been received after the initial fetch. This is useful for implementing a refresh feature. This will erase the notification history returned by allFetchedNotifications to ensure consistency: you should clear the other notification pages you've already from your cache.

Note: BatchInboxFetcher and its methods are well documented in BatchInbox.h. You can also use the of BatchInboxFetcher to get detailed explanations about what every method does.

BatchInboxFetcher will not fetch any notification by default, so before trying to display anything, you will need to call fetchNewNotifications() or fetchNextPage()

Both fetch methods take a block, which the SDK will call you back on either on failure, or success. Success callbacks include information about the operation to operate on the data, but you can very well do with the global methods. The block callbacks are always called on the main thread.

Reading Notification Content

Once you've fetched notifications, you will end up with a list of BatchInboxNotificationContent objects.

These objects have everything you need to display these notifications:

Title
Body
Send timestamp (UTC)
Read state

Note: Just like when you get it using iOS' standard callbacks, the raw payload (accessible from the payload property) should be used carefully on keys you do not control:

"aps" is considered private by Apple, and can change at any time. This has happened in the past, where the "alert" object got additional keys for new iOS features.
"com.batch" is Batch's internal payload: You should not make any assumption about its content, nor depend on it. We reserve the right to change it at anytime, without warning.
Standard parsing good practices apply: Make sure to check every cast and handle errors gracefully, and never assume anything about the payload's content.

You can then use the same methods that you can use on push payloads to extract information. Example: BatchPush.deeplink(fromUserInfo: notificationContent.payload), where "notificationContent" is a BatchInboxNotificationContent instance.

Marking Notifications as Read

Notifications can be marked as read in two ways:

By marking only one notification as read Use markNotification(asRead: notification) with the notification you want to mark as read.
By marking all notifications as read Simply call markAllNotificationsAsRead()

In both cases, the notifications will be marked as read locally, but refreshing them might mark them as unread again, as the server might not have processed the request. These methods return quickly, and are thus safe to call on your UI thread.

Note that notifications that have been opened when received are automatically marked as read.

Displaying Mobile Landing

Batch allows you to display a mobile landing attached to a notification. To do so, you can simply trigger the landing message from the BatchInboxNotificationContent object as following:

Marking Notifications as Deleted

Notifications can be deleted using the markNotification(asDeleted: notification) method with the notification you want to mark as deleted. A deleted notification will NOT appear in the notification list the SDK provides, and you will be expected to update your UI accordingly.

The notifications will be marked as deleted locally, but refreshing them might make them appear again, as the server might not have processed the request. These methods return quickly, and are thus safe to call on your UI thread.

Tweaking the Fetcher

For more advanced usages, you can also change various aspects of the Inbox Fetcher, such as:

The maximum number of notifications fetched per page (maxPageSize)
The maximum number of notifications that can be fetched using this object (limit) A default limit is set to avoid going over memory by accident.
1.19.0 Disabling the filtering of silent notifications (filterSilentNotifications). A silent notification is a push that doesn't show any visible message to the user.

Testing Your Integration

In order to test your integration, you will need to create a push campaign on the dashboard. Please see our fore more info.

SDK changelog

3.2.0

Compiles with Xcode 26.1.1

Batch requires Xcode 26.1.1 and iOS 15.0 or higher (iOS 16.0 or higher for Mac Catalyst only)

Core

Reintroduced the arm64e architecture slice since the previous removal was a temporary measure due to App Store/TestFlight validation issues observed with arm64e slices compiled using early iOS 18 SDKs.

Profile

Profile string attributes now support up to 300 characters for the Customer Engagement Platform (CEP). The limit for the Mobile Engagement Platform (MEP) remains 64 characters. Attributes set via BatchProfileEditor.setStringAttribute() longer than 64 characters will only be applied to the CEP.
Event string attributes now support up to 300 characters for the Customer Engagement Platform (CEP). The limit for the Mobile Engagement Platform (MEP) remains 200 characters. Attributes set via BatchEventAttributes.putString() longer than 200 characters will only be applied to the CEP.

3.1.0

Compiles with Xcode 16.4 Batch requires Xcode 16.4 and iOS 15.0 or higher

Core

Fixed an issue where some GIF files would play too fast
Fixed an issue where didRegisterForRemoteNotificationsWithDeviceToken/didFailToRegisterForRemoteNotificationsWithError UIApplicationDelegate methods broke when swizzling was enabled on a SwiftUI lifecycle application.

Messaging

Introduced In-App Automations within the Customer Engagement Platform.
Introduced Spacer component for creating flexible empty space within In-App messages.
Added support for In-App WebView format within the Customer Engagement Platform.
Added fill

3.0.3

Compiles with Xcode 16.3 Batch requires Xcode 16.3 and iOS 15.0 or higher

This version is fully compatible with iOS 26 and Xcode 26

Core

Re-release of 3.0.2 due to a build script issue.

3.0.2

Compiles with Xcode 16.3 Batch requires Xcode 16.3 and iOS 15.0 or higher

Core

Important Xcode 26 warning: We have had reports of the SDK failing to pass App Store/Testflight validation due to the presence of an arm64e slice compiled with the iOS 18 SDK. Therefore, we removed the arm64e slice for the time being, planning to reintroduce it at a later date when we can compile with a stable iOS 26 SDK. Please contact our support team if this is a problem for you.

Messaging

Fixed an issue where In-App messages might not display during NEW SESSION events.

3.0.1

Compiles with Xcode 16.3. Batch requires Xcode 16.3 and iOS 15.0 or higher

Core

Re-release of 3.0.0 due to a misalignment of deployment targets across package managers

3.0.0

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

Compiles with Xcode 16.3. Batch requires Xcode 16.3 and iOS 15.0 or higher

Core

Added NS_SWIFT_UI_ACTOR annotations on a couple of methods to prevent threading related bugs. While this is a breaking change, most implementations won't notice anything.

Messaging

Added Mobile Landings with Push v2 which can be created from the CEP composer in the Batch Dashboard.
Added new BatchInAppDelegate protocol and inAppDelegate property on BatchMessaging, in order to handler In-App messages manually.
Removed individual close callback methods (batchMessageWasCancelledByAutoclose, batchMessageWasCancelledByUser

2.1.2

Compiles with Xcode 16.0 Batch requires Xcode 16.0 and iOS 13.0 or higher

This version is fully compatible with iOS 26 and Xcode 26

Core

Added support for Xcode 26.
Removed arm64e slice.
Fixed an issue where didRegisterForRemoteNotificationsWithDeviceToken/didFailToRegisterForRemoteNotificationsWithError UIApplicationDelegate methods broke when swizzling was enabled on a SwiftUI lifecycle application.

2.1.1

Compiles with Xcode 16.0 Batch requires Xcode 16.0 and iOS 13.0 or higher

Core

Re-release of 2.1.0 with a valid codesignature.

2.1.0

Compiles with Xcode 16.0 Batch requires Xcode 16.0 and iOS 13.0 or higher

Profile

Added setPhoneNumber API to the BatchProfileEditor class. This requires to have a user identifier registered or to call the identify method beforehand.
Added setSMSMarketingSubscriptionState API to the BatchProfileEditor class.

2.0.2

Compiles with Xcode 15.3 Batch requires Xcode 15.3 and iOS 13.0 or higher

Core

Due to CocoaPod bugs, we removed Code Signing and Mergable Library support from Batch when installed via CocoaPods. If those are important to you, please use Swift Package Manager or manually integrate the framework.

2.0.1

Compiles with Xcode 15.3 Batch requires Xcode 15.3 and iOS 13.0 or higher

Event

Fixed an issue where tracking an event without custom attributes wasn't sent.

2.0.0

This is a major release, please see our for more info on how 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 . 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 introduces visionOS support. 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 class 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.

Push

Removed deprecated method setupPush, which was a no-op.
Removed the ability to register notification categories using Batch. Please use the .
- Removed deprecated method registerForRemoteNotifications.

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

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

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

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.

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

Fixes

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

1.21.3

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

Core

Re-release of 1.21.2 with a valid codesignature. Note: 1.21.3 only exists on SPM & Carthage. The 1.21.2 Cocoapods artifact & manual download has been updated with the new signature.

1.21.2

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.

1.21.1

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.

1.21.0

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.

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.

1.20.0

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 identifer 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

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.

1.19.5

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.

1.19.4

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

1.19.3

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.

1.19.2

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.

1.19.1

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.

1.19.0

Compiles with Xcode 13.3 Batch requires Xcode 13 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

1.18.2

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.

1.18.1

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.

1.18.0

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.
Fixed an issue where deleting a notification would not be reflected in allFetchedNotifications before re-fetching from the server.

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

1.17.3

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.

1.17.2

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.

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.

1.17.1

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:].

1.17.0

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.

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.

1.16.1

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:].

1.16.0

A migration guide from Batch 1.15 and lower is .

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.

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.

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.

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.

1.15.2

Compiled with Xcode 11.5 This minor release is the last one to support iOS 8 and 9.

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.

1.15.1

Compiled with Xcode 11.5

User

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

1.15.0

Compiled with 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.

Inbox

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

1.14.2

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

1.14.1

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

This is the LAST release that support iOS 8 and 9. Apple has already removed their simulators from Xcode 11.

Messaging

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

1.14.0

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.

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.

Push

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

1.13.2

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

1.13.1

Re-release of 1.13.0, compiled with Xcode 10.1. Batch now includes an arm64e slice. arm64e bitcode isn't present

Note: This release comes with an update to the included BatchExtension framework. Its strip-frameworks script will strip the arm64e slice to prevent bitcode-related submission errors: we strongly discourage from enabling arm64e in your extension's Architectures

1.13.0

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

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.

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

1.12.0

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

1.11.0

Added support for Banners in In-App Messaging
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 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

1.10.4

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.

1.10.3

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

1.10.2

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

1.10.1

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

1.10.0

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

1.9.0

Added the Inbox module, allowing you to fetch previously received notifications from your code. More info: https://batch.com/doc/ios/inbox.html

1.8.0

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

1.7.4

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

1.7.3

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

1.7.2

Rebuild the SDK without debug symbols

1.7.0

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

1.6.0

Batch now requires iOS 8 or greater due to Xcode 8 dropping support for earlier versions.
[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 UNUserNotificationCenterDelegate instance.

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.

1.5.4

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

1.5.3

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/doc
Improved support for notifications containing "content-available":1
Added .gitignore in "Batch.bundle" to fix git issues for those who commited Batch itself

1.5.2

Minor bugfixes

1.5.1

Fixed: push token environment detection failed in some rare cases

1.5

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)

1.4

Deprecated Batch Ads
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.

1.3.2

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

1.3.1

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

1.3

Native Ads
Renamed ad methods to avoid confusion between interstitial ads and native ads. Old methods are deprecated but still work
Faster interstitial ad display
"Batch" Objective-C module now imports everything. Base Batch functionality is in the new "Batch.Core" submodule.

1.2.6

iOS 6 Bugfixes
Ads optimisations

1.2.5

Bug fixes

1.2.4

Bug fix
Better push implementation
Deeplink management improvement

1.2.3

Bug fix

1.2

Batch Ads

1.1.1 & 1.1.2 & 1.1.3

Stability improvements

1.1

Add push capabilities.
iOS 8 and Objective-C modules support.
Dropped iOS 5 compatibility.
BatchUnlockDelegate is now weakly retained, rather than strongly retained.

1.0.1

Move a file put by mistake in /Documents/ into /Library/Application Support/

1.0

Batch release.

iOS

Prerequisites

Creating an app

Configuring notifications

License Attribution

SDK Integration

Initial setup

Integrating the SDK

Profile Data

Custom user ID

Custom region/language

Email subscription

SMS subscription

Profile data migration

Testing your integration

Finding your ID

Understanding the results

Data Privacy

SDK opt-out (e.g. GDPR)

Event dispatchers

What is an event dispatcher?

Add a "ready-to-go" dispatcher

Create a custom dispatcher

Access data from the event

Firebase

AT Internet

Mixpanel

Custom

Advanced

Deeplinking

Migration Guides

Batch 1.16

iOS minimum version

Migrating from the older binary BatchExtension

Removing the old BatchExtension

Adding the new BatchExtension using a package manager

Updating your code

Migrating to XCFramework

CocoaPods

Carthage

Swift Package Manager

Manual Integration

iOS

Prerequisites

Creating an app

Configuring notifications

License Attribution

SDK Integration

Migration Guides

Custom region/language

Profile data migration

Profile Data

Advanced

Testing your integration

Finding your ID

Understanding the results

Event dispatchers

What is an event dispatcher?

Add a "ready-to-go" dispatcher

Create a custom dispatcher

Access data from the event

SMS subscription

Initial setup

Integrating the SDK

Custom user ID

Deeplinking

Email subscription

Data Privacy

Identifying a user

Choosing a unique identifier

Your first start

Testing your integration

Universal links

Custom URL schemes

Batch 1.16

iOS minimum version

Migrating from the older binary BatchExtension

Removing the old BatchExtension

Adding the new BatchExtension using a package manager

Updating your code

`batch.dismiss`