This document provides release notes for significant updates to Iterable's Android SDK.
For more granular release notes, take a look at the Iterable Android SDK releases page on GitHub.
Table of contents
- Deprecation and End-of-Life Schedule
- Further reading
3.2.12 (Tuesday, March 30, 2021)
Iterable's Android SDK includes:
- Support for syncing in-app message read state across multiple devices. Note
- When the SDK fetches in-app messages from Iterable, it examines each
readfield to determine if it has already been read.
- The SDK's default implementation no longer automatically displays in-app messages that have already been seen on another device (even if those messages were not configured to go directly to the inbox).
- When you view a message, the SDK calls
POST /api/events/trackInAppOpento create an
inAppOpenevent on the user's Iterable profile. Previous versions of the SDK made this same API call, but the call now also causes Iterable to set the message's
- Previous versions of the SDK will correctly sync a message's read / unread indicator for the default implementation of a mobile inbox. However, these older SDK versions will not automatically suppress messages that have already been seen on another device (as this version of the SDK will).
- When the SDK fetches in-app messages from Iterable, it examines each message's
- Support for the display of a custom message (title and body) in an empty mobile inbox. For more details, see Customizing Mobile Inbox on Android
3.3.0 - Beta 1 (Thursday, January 28, 2021)
of Iterable's Android SDK includes:
- The features and updates introduced in the 3.2.x releases (for example, Mobile Inbox, JWT-enabled API keys, and in-app animations).
- Beta support for offline events processing (capturing engagement events when a device is offline and sending them to Iterable when a network connection is reestablished) and in-app message prioritization (specifying a priority for an in-app message campaign, to determine its display order for your users). To try these beta features, have your Iterable customer success manager enable them for your project.
3.2.0 - General Availability (Tuesday, February 25, 2020)
- This release moves version 3.2.0 of Iterable's Android SDK out of beta.
- It also adds customization options to the Mobile Inbox feature. For more details, see Customizing Mobile Inbox on Android.
3.2.0 - Beta (Tuesday, October 15, 2019)
Version 3.2.0 (beta) of Iterable's Android SDK works with Iterable's Mobile Inbox feature. With Mobile Inbox, users of your mobile apps can save in-app messages and revisit them when it's convenient or when the content is more relevant.
The SDK includes a default implementation of an inbox user interface, which can be customized as necessary to match your brand's styles. Also, it automatically captures inbox-related events to Iterable, where they can be used to segment users, filter and trigger workflows, or send system webhooks.
To get started with Mobile Inbox:
3.1.0 - General Availability (June 10, 2019)
Version 3.1.0 of Iterable's Android SDK is now generally available and supported by Iterable.
This version of the SDK automatically downloads new in-app messages, allows apps more control over which in-app messages to display and when to display them, and consolidates the way deep links are handled across push notifications, in-app messages, and emails. For more information, see the beta announcement.
How to upgrade
Upgrading to version 3.1.0 of the Iterable Android SDK requires some code changes in your mobile apps. For more details, take a look at the Migrating from a version prior to 3.1.0 instructions on GitHub.
3.1.0 - Beta (Monday, May 13, 2019)
Version 3.1.0 (currently in beta) of Iterable's Android SDK provides various new features:
- Automatic downloading of new in-app messages
- More control for mobile apps to decide when and how to display in-app messages
- Consolidated handling of deep link URLs, so that the same URLs work when sent in emails, in-app messages, or push notifications
Beta versions of Iterable's mobile SDKs are subject to the Beta Mobile SDK Disclaimer.
New and updated features
This version of the SDK provides the following new and updated features:
Automatic downloading of new in-app messages
With this version of the SDK, mobile apps automatically download all available in-app messages and store them on device. This makes it possible to inspect the messages to decide when and how to display them. Automatic in-app message downloads happen:
- When Iterable sends silent push notifications (not visible or audible to the user) indicating that new in-app messages are available.
- At key points in the mobile app's lifecycle, such as when it launches or comes to the foreground.
This feature makes it easier than ever to test in-app message campaigns. Simply send a proof and wait for it to appear in the app (no need to manually force the app to download new messages, as could be the case with previous versions of the SDK).
More control for mobile apps to decide when and how to display in-app messages
Since this version of the SDK automatically downloads all available in-app messages and stores them on device, the mobile app can examine each message to decide when and how to display it. For example, the app might:
- Skip displaying a particular message
- Display multiple messages in sequence (by default, in-app messages display in sequence, with a 30-second delay between messages—but this is customizable)
- Wait to display a particular message until a network connection is available
- Create a native user interface for a particular message, rather than rendering the HTML supplied by Iterable
- Display a particular in-app message when a user completes a specific action in the app
Consolidated handling of deep link URLs
This version of the SDK provides a common way to handle deep link URLs in a mobile app. With this feature, deep link URLs in emails, in-app messages, and push notifications are all handled in the same way, making it easier for marketers to define a set of deep link URLs that work as expected, regardless of message type.
How to upgrade
Upgrading to the 3.1.0 beta of the Iterable Android SDK requires some code changes in your mobile apps. For more details, take a look at the Migrating from a version prior to 3.1.0 instructions on GitHub.
To learn more, take a look at the Iterable Android SDK 3.1.0 beta on GitHub.
Deprecation and End-of-Life Schedule
The following schedule lists the deprecation dates, support windows, and end-of-life dates for various versions of Iterable's Android SDK. For details about how Iterable supports mobile SDKs, see the Mobile SDK Support Policy.
|SDK||SDK version(s)||Deprecation announcement date||Support window||End-of-life date|
|iterable-android-sdk||3.0.x (where x >= 9)||6/10/2019||12 months||6/9/2020|
|iterable-android-sdk||3.0.8 and older||6/10/2019||6 months||12/9/2019|