Last modified August 1, 2019 by Gordon Glauser

Android SDK release notes

Swrve has an open source SDK repository. There are two options for downloading the latest public Swrve Android SDK:

  • Download the SDK from the GitHub public repository.
  • Integrate the SDK libraries using Maven from the Swrve repository on Jcenter. To integrate this library with your project, add the following code to your build.gradle file:
    First, add the Swrve repository:

    Then, select a Swrve library to install, ensuring you include the latest SDK version number: 6.2.0
    Firebase – select if you use push notifications with Swrve, or any Firebase services like Firebase Cloud Messaging or Analytics.

    Amazon – select if you use Amazon Device Messaging.

    Basic – select only if you are not using Swrve push notifications, or any Firebase or Amazon services.

For upgrade instructions, see Android SDK upgrade guide. To view the feature support matrix, see SDK feature support matrix.


Release 6.2

Release date: July 31, 2019

Features

  • Added support for Swrve Geo SDK plugin v2.3, which supports geo notification cooldown periods at app-wide, individual geoplace, and campaign levels. Also includes support for adding geoplace opening hours via CSV upload or the Geoplace API. For more information, see the Swrve Geo SDK release notes.
  • Upgraded the following tools and services:
    • Gradle to 5.1.1
    • Gradle tools plugin to 3.4.1

Release 6.1.1

Release date: April 29, 2019

Fixes

  • Fixed an issue with setting the notification accent color via SwrveNotificationConfig. Thanks to zstecker for your contribution!

Release 6.1

Release date: April 5, 2019

Features

  • Added support for Swrve Geo SDK plugin v2.2, which supports triggering and delivering geo notifications when a device is offline. For more information, see the Swrve Geo SDK release notes.
  • Extended the custom button callback function for in-app message buttons to cover dismiss calls to action and include campaign data. For more information, see the Android integration guide.
  • Added the ability to add custom payloads to a limited number of Swrve.* events used in Conversation responses. For more information, see the Android integration guide.
  • Added support for customers using Timber logging library. Call SwrveLogger.useCustomLogger(true) before the SDK instance is created so the SwrveLoggerTree does not get planted. For more information, see How do I configure SDK device logging?
  • Upgraded the following tools and services:
    • firebase-messaging to 17.4.0
    • play-services-ads-identifier to 16.0.0
    • Gradle tools plugin to 3.3.2
    • google-services to 4.2.0

Fixes

  • Removed the use of Bitmap.recycle() from in-app messages.
  • Fixed a potential caching issue of in-app messages.
  • Fixed a warning caused by improper ID declaration on Conversation star ratings.
  • Various minor fixes and improvements.

Release 6.0.2

Release date: February 21, 2019

Fixes

  • Fixed an issue that potentially affected app responsiveness, resulting in increased ANR warnings.

Release 6.0.1

Release date: November 30, 2018

Fixes

  • Fixed an issue in the internal API used with the SwrveGeoSDK.
  • Fixed an issue where an internal API sent a new device ID if the app was hard closed.

Release 6.0

Release date: October 31, 2018

If you are in the process of upgrading to Android SDK v6.0, please use v6.0.1 instead, as it addresses an important fix to an issue with user identity that was introduced in version 6.0. Do not use Android SDK v6.0.

Warnings

  • In line with Google’s decision to deprecate Google Cloud Messaging and remove support for it in April 2019, we have now completely removed support for the swrve-google flavor of the SDK. If you have any questions about migrating from Google Cloud Messaging to Firebase Cloud Messaging, contact your CSM at support@swrve.com.

Features

  • Added an API for handling User Identity. For more information, see the Android integration guide. To be part of our Early Access program, contact your CSM at support@swrve.com.
  • Added custom filtering of notifications to enable your app to modify the content of a notification or perform a final check and approval before displaying a notification. For more information, see SwrveNotificationCustomFilter in SwrveNotificationConfig.
  • Removed support for Locations campaigns, which have now been replaced by our new geo-triggered campaigns. For more information, see Intro to geo-triggered campaigns.
  • Removed the option to configure HTTP settings from SwrveConfig. The SDK now only supports HTTPS.
  • Upgraded the GSON library to 2.8.5.
  • Upgraded the Timber library to 4.7.1.

Release 5.3.2

Release date: September 21, 2018

Fixes

  • Fixed an issue that occurred when rendering notifications without expandable text. The SDK was setting the BigText style even though it was not needed, resulting in bad rendering on Android 6.X devices.

Release 5.3.1

Release date: September 17, 2018

Fixes

  • Fixed an issue where the SDK delivered an empty payload to SwrveNotificationListener. Thanks to Cameron Rattray for your contribution!

Release 5.3

Release date: September 3, 2018

Warnings

  • In line with Google’s decision to deprecate Google Cloud Messaging and remove support for it in April 2019, we have deprecated the swrve-google flavor of the SDK and you should migrate to the swrve-firebase SDK. We will discontinue support for the swrve-google flavor of the SDK in version 6.0 later this year. If you have any questions about migrating from Google Cloud Messaging to Firebase Cloud Messaging, contact your Customer Success Manager at support@swrve.com.

Features

  • Added support for displaying a Swrve in-app message or Conversation campaign directly after a customer engages with a push notification. For more information, see Linking push notifications to in-app campaigns.
  • Added support for the release of Swrve Geo SDK add-on v2.0. This includes a new workflow for setting up your geo-triggered campaigns. For more information, see Creating geo-triggered campaigns.
  • Updated and revamped the Swrve sample projects in GitHub, including a new MinimalIntegration project. Also improved the integration with multiple push provider samples (for more information, see MultipleFCMProviders samples).
  • Various refactors and improvements to how Notifications are built.
  • Upgraded the following build tools and services:
    • Gradle build tool to 4.4
    • Gradle Android tools to 3.2.1
    • google-services to 3.2.1
    • play-services-ads to 15.0.1
    • play-services-gcm to 15.0.1
    • firebase-messaging to 17.1.0 (Note: This upgrade means SwrveFirebaseInstanceIdService is now deprecated. It is no longer required and the upgrade is simply to remove it from manifest.)
  • Added new SwrveNotificationConfig object that you should use to configure global settings for notifications (icons, title and accent color) instead of configuring via meta-data tags in AndroidManifest.xml. We will remove support for configuring via AndroidManifest.xml in version 6.0 later this year. For more information, see SwrveConfig for adding SwrveNotificationConfig in the Android Integration guide.
  • Deprecated SwrveSDK.setPushNotificationListener() and will remove it in version 6.0 later this year. Instead, configure the push notification listener via SwrveConfig.

Fixes

  • Fixed an issue that prevented Javadocs from being displayed in Android Studio.
  • Fixed a rare issue that caused event duplication.
  • Fixed a rare issue with push notification titles where if the title was left blank when creating the notification in Swrve, the title of the previous notification the device received was used.
  • Fixed GSON ProGuard rules.

Release 5.2

Release date: March 5, 2018

Features

  • Added support for OTT platforms. You can now integrate the Swrve SDK into Android TV or Amazon Fire TV to do tracking, resource A/B testing and in-app messages. Conversations and push notifications are not currently supported. For more information, see Swrve OTT Integrations.

Fixes

  • Fixed an issue related to Android Oreo API 26 that caused in-app messages and Conversations to crash if the target SDK version was 27 (Fix for error in version 5.1.1). For information on the status of this issue, see the Google Issue Tracker.

Release 5.1.1

Release date: January 15, 2018

Features

  • Updated the Swrve SDK Multiple GCM Providers Sample project to make it compatible with Android O. For more information, see the  Android SDK Samples folder on GitHub.
  • Added an API for disabling Logcat logging that was removed in 5.0. You can disable logging via the SwrveConfig. For more information, see How Do I Configure SDK Device Logging?

Fixes

  • Fixed an issue with rich push notification button actions where the notification drawer would not close if the button action was dismiss or a deeplink.
  • Fixed an issue related to Android Oreo API 26 that caused in-app messages and Conversations to crash if the target SDK version was 27. Thanks to GitHub user Dimezis for your contribution!

Release 5.1

Release date: December 12, 2017

Features

  • Includes updates required for Locations SDK 2.0. For more information, see the Locations SDK Release Notes.
  • Upgraded the SDK source libraries to compile with Gradle 4.1 and Android Studio 3.0.
  • Upgraded Google Play Services to 11.6.0 and support library tools to 27.0.2.

Release 5.0

Release date: November 16, 2017

Features

  • Includes refactors and code improvements for easier integration and to safely persist data per User ID. For more information, see the Android SDK 5.0 Upgrade Guide.
  • SDK activity tracking is now automatic and the SwrveSDK lifecycle (SwrveSDK.onCreate, and so forth) code is no longer needed. As a result, it is now necessary to pass the Application object into the createInstance method. For more information, see the Android SDK 5.0 Upgrade Guide.
  • Added support for nested push notification payload JSON.
  • You can now configure a device model blacklist in SwrveConfig to prohibit the SDK starting on particular device models. Defaults to “Calypso AppCrawler”.

Fixes

  • It is no longer possible to use internal Swrve.* events to trigger in-app messages or conversations.

Previous releases summary

  • October 16, 2017 – v4.11.3 – Bug fixes.
  • September 20, 2017 – v4.11.2 – Updated GCM and FCM libraries to 11.2.0 and added the ability to get the resource key set from a SwrveResource.
  • August 28, 2017 – v4.11.1 – Bug fixes.
  • August 16, 2017 – v4.11 – Several push notification enhancements, including support for creating rich notifications directly in Swrve, influenced metrics reporting, and Firebase Cloud Messaging. Also added support for Android O and a new API for extracting resource A/B test campaign information.
  • June 7, 2017 – v4.10.1 – Bug fixes.
  • May 24, 2017 – v4.10 – Added support for using silent push notifications to send background app content updates.
  • March 21, 2017 – v4.9 – Minimum support changed to Android API Level 14. Upgrades to Android Gradle and build tools, support jars and Google Cloud Messaging libraries.
  • February 2, 2017 – v4.8 – Various Conversation enhancements and fixes, including custom fonts and styling.
  • November 24, 2016 – v4.7 – Added support for Amazon Device Messaging, for using date-type user properties to target your campaign audiences and for sending your own push engagement event.
  • November 7, 2016 – v4.6.2 – Bug fixes.
  • September 12, 2016 – v4.6.1 – Bug fixes.
  • August 31, 2016 – v4.6 – SDK now uses HTTPS by default for all endpoints.
  • July 5, 2016 – v4.5 – Conversations enhancements.
  • May 25, 2016 – v4.4 – Added support for using event payload conditions to trigger in-app messages and Conversations campaigns.
  • May 9, 2016 – v4.3.1 –  Added dependancy to Locations SDK v1.1 on Swrve iOS SDK v4.3.1 or higher.
  • April 7, 2016 – v4.3 – Added Star Rating survey template to Conversations.
  • February 11, 2016 – v4.2 – Added Message Center API and updated Google Cloud Messaging libraries.
  • November 30, 2015 – v4.1 – Restricted use of Swrve. namespace for custom events.
  • November 5, 2015 – v4.0.5 – Updated Google Cloud Messaging libraries.
  • October 21, 2015 – v4.0.4 – Bug fixes.
  • October 15, 2015 – v4.0.3 – Added compatibility with Android Marshmallow.
  • September 23, 2015 – v4.0.2 – Updated push notification plugin to latest GCM library and increased HTTP default timeout.
  • August 18, 2015 – v4.0.1 – Bug fixes.
  • July 7, 2015 – v4.0 – Added support for Conversations and moved from JAR to AAR distribution.
  • April 8, 2015 – v3.4 – Changed default background for in-app messages from solid black to transparent.
  • January 21, 2015 – v3.3.1 – Added support to automatically capture and send referrer information.
  • November 11, 2014 – v3.3 – Added support to log carrier information by default.
  • October 21, 2014 – v3.2 – Added support to generate a random UUID if no custom user ID is provided at initialization.
  • July 30, 2014 – v3.1 – Simplified Google Cloud Messaging push notification integration and added support for triggering in-app messages at session start.
  • May 27, 2014 – v3.0.1 – Bug fixes.
  • May 15, 2014 – v3.0 – Enhancements to real-time targeting and added separate JAR files for Google Play-flavored SDK.
  • April 3, 2014 – v2.10.1 – Bug fixes.
  • April 1, 2014 – v2.10 – Simplified in-app message actions and QA device registration.
  • March 4, 2014 – v2.9 – Added support for push notifications for Android devices.
  • v2.8 – Added support for Swrve’s redesigned in-app messaging functionality and push notifications Beta.
  • v2.7.1 – Bug fixes.
  • v2.7 – Added support for auto-generation of user IDs and unified the in-app messaging and analytics SDKs.
  • November 12, 2013 – v2.6 – Added support for extended IAP event and bug fixes.
  • October 16, 2013 – v2.5 – Added support for in-app messaging per campaign dismissal rules and bug fixes.
  • September 17, 2013 – v2.4 – Added support for in-app messaging QA logging.
  • August 20, 2013 – v2.3 – Added support for in-app messaging QA user functionality.
  • July 26, 2013 – v2.2 – Bug fixes.
  • July 2, 2013 – v.2.1 – Added support for app store filtering within in-app messaging.
  • May 22, 2013 – v.2.01 – Fixed possible crash while displaying messages whose images were not fully downloaded.
  • May 17, 2013 – First public release.