This migration guide is for users that are moving from OpenBack's Android SDK V1 to
<=V4.0.0. You can update to the latest version of OpenBack with the code below. Update your Gradle dependency to the version below.
After updating, the steps for migrating are as follows:
- Remove the
openback.jsonfile and switch to our latest
- Use the latest API calls from V4.
1 - Android Manifest Configuration
- Remove the
openback.jsonas this is no longer needed in V4.
- You can now configure OpenBack in your application
Alternatively, if you do not provide an App Code in the plist, you can set it manually using the API.
2 - Update Your API Calls
The Android SDK API has been updated to match the naming scheme of our iOS API for ease of use across both platforms. The following API calls have been changed in V4:
- setUserInfo -> setAttributes
- triggerEvent:withDelay -> signalEvent
- setCustomTrigger -> setCustomSegment
You no longer need to call the OpenBack Config as the configuration is completed in the Android Manifest.
3 - Project Configuration
In line with Apple's specifications, the OpenBack iOS V4 SDK has been split into several different modules depending on the required permissions. See below for the list of which modules you will need to include for certain signals:
- Location Signal requires that you add the OpenBackLocation framework.
- Activity Signal requires that you add the OpenBackMotion framework, but the OpenBackLocation can work too.
- Bluetooth/Connectivity Signal requires that you add the OpenBackBluetooth framework.
iOS13+ Background Modes
Check Background fetch, Background processing and Remote notifications.
When background processing is enabled, add the following two permitted tasks to the
You're now ready to use V4 of the OpenBack SDK, see our full API documentation here or look at some of our other features below.
|Signals & Permissions||Add the required settings and permissions in your project settings for signals.|
|Attributes||Attribute values can be set client side by your mobile app, and then used as personalized content within messages.|
|Custom Segments||Custom Segments are set client side by your mobile app. They can be used to deliver a message based on the value set in your message campaign which is managed through the OpenBack Dashboard or Client APIs.|
|Goals||Goals can range from anything such as a user completing a signup process, to a user purchasing a product.|
|Events||An event is an action at a particular moment in time for each user, which can then be used to deliver a notification. You can easily pass existing or new events to the OpenBack SDK client side, making advanced campaigns simple.|
|App Inbox||Deliver & manage messages in an inbox within your app – standalone, or as part of a notification.|
|Topics||Message users that are subscribed to specific topics.|
|Advanced Configuration||Advanced OpenBack configuration parameters.|
|Notifications||Customize the appearance of OpenBack notifications.|