This is a major release, please see our migration guide for more info on how to update your current Batch implementation.
Plugin
- Updated Batch to 2.0. For more information see the ios and android changelog .
- Batch requires iOS 13.0 or higher.
- Batch requires a
minSdk
level of 21 or higher.
Core
- Added method
isOptedOut
to checks whether Batch has been opted out from or not. - Added method
setFindMyInstallationEnabled
to set whether Batch should enable the FindMyInstallation feature or not. - Added method
updateAutomaticDataCollection
to fine-tune the data you authorize to be tracked by Batch. - Removed
canUseAdvertisingIdentifier
property fromConfig
. - Added
migrations
property toConfig
to update the profile migrations related configuration. See our documentation for info. - Fixed an issue where opened push with deeplink was not tracked as direct open on a cold start.
User
- Removed method
trackTransaction
with no equivalent. - Removed method
batch.user.editor
and the related classBatchUserDataEditor
, you should now usebatch.profile.editor
which return an instance ofBatchProfileAttributeEditor
. - Added method
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.
- Removed
trackEvent
APIs from the user module. You should now usebatch.profile.trackEvent
. BatchEventData
has been renamed intoBatchEventAttributes
.- Removed
addTag
API fromBatchEventData
You should now use the$tags
key withput
method. - Removed parameter
label
fromtrackEvent
API. You should now use the$label
key inBatchEventAttributes
with theput
method. - Added support for values of type: Array and Object to the
put
method.
Profile
Introduced batch.profile
, a new module that enables interacting with profiles. Its functionality replaces most of BatchUser used to do.
- Added
identify
API as replacement ofbatch.user.getEditor().setIdentifier
. - Added
getEditor
method to get a new instance of aBatchProfileAttributeEditor
as replacement ofBatchUserEditor
. - Added
trackEvent
API as replacement of thebatch.user.trackEvent
methods. - Added
trackLocation
API as replacement of thebatch.user.trackLocation
method.