Last modified November 22, 2014 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:
    1. First, add the Swrve repository:
    2. Then, choose a Swrve library to install, ensuring you include the latest SDK version number: 5.1.1
      Basic Android SDK

      Google-flavored SDK – select if you’re using any of Google Play’s services, such as IAP or Google Cloud Messaging

      Firebase-flavored SDK – select if you’re using any Firebase services, such as IAP or Firebase Cloud Messaging

      Amazon-flavored SDK – select if you’re using Amazon Device Messaging

For upgrade instructions, see Android SDK Upgrade Guide. To view the feature support matrix, see SDK Feature Support Matrix.


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.

Release 4.11.3

Release Date: October 16, 2017

Fixes:

  • Fixed an issue relating to ProGuard rules that was causing a potential crash when using rich push notifications.

Release 4.11.2

Release Date: September 20, 2017

Features:

  • Updated GCM and FCM libraries to 11.2.0.
  • Added the ability to get the resource key set from a SwrveResource.
  • It is now possible to create Android O channels from the push notification payload.

Release 4.11.1

Release Date: August 28, 2017

Fixes:

  • Fixed a dependency issue with the Timber library.

Release 4.11

Release Date: August 16, 2017

Features:


Release 4.10.1

Release Date: Jun 7, 2017

Fixes:

  • Fixed an issue where if a push notification accent color wasn’t set, the notification wouldn’t show.

Release 4.10

Release Date: May 24, 2017

Features:

  • Added support for using silent push notifications to send background app content updates, for both Google and Amazon flavors.

Release 4.9

Release Date: March 21, 2017

Features:

  • The minimum API Level supported by the Swrve SDK has changed from 10 to 14. The Swrve SDK will not execute on an Android API Level lower than 14.
  • Upgraded the following tools and libraries:
    • Android Gradle tools – from 2.1.3 to 2.2.3
    • Android build tools – from 23.0.3 to 25.0.2
    • Android support jars – from 23.4.+ to 25.1+
    • Google GCM library – from 9.8.0 to 10.0.1
  • The Google Play Services version is no longer required in AndroidManifest.
  • The source code for the Amazon SDK now includes a stubbed amazon-device-messaging jar for compilation purposes.
  • Asset downloading for image and font now supports gzip.
  • It is now possible to lock Conversations orientation via the SwrveConfig.
  • User’s notification permission and importance level are now tracked automatically as user properties.
  • Upgraded open source tests to use the Robolectric version 3.2.2.

Fixes:

  • The Conversations event queue is now flushed upon page transition and onPause.
  • Fixed an issue to ensure Conversations with unknown content are not displayed.

Release 4.8

Release Date: February 2, 2017

Features:

  • Conversations now include support for uploading custom or brand-specific fonts and using advanced text styling and spacing options.

Fixes:

  • Fixed alignment and touch appearance of Conversations star rating icons.
  • Fixed styling of Conversations option buttons.

Release 4.7

Release Date: November 24, 2016

Features:

  • The SDK now includes support for Amazon Device Messaging (ADM) in an Amazon-flavored Android SDK. For instructions on how to integrate push notifications for Amazon devices, see the Android Integration Guide.
  • To support date-typed user property targeting, the SDK now enables you to send Date objects as part of your user updates using the following function: SwrveSDK.userUpdate(String name, Date date) For more information, see the Android Integration Guide.
  • It is now possible to send your own push engagement event to Swrve using the following function: SwrveSDK.sendPushEngagedEvent(Context context, String pushId);
  • It is now possible to set the GCM registration ID (device token) externally.
  • Upgrade of the GCM library to 9.8.0.

Fixes:

  • Fixed an issue where a user update containing device information was sent every time an Activity resumed. It is now sent only once per session.

Release 4.6.2

Release Date: November 7, 2016

Fixes:

  • Fixed an issue where events in the queue were duplicated when closing the current activity after queuing an event.

Release 4.6.1

Release Date: September 12, 2016

Fixes:

  • Fixed an issue with the Conversations Call a Number button to correctly support devices that don’t have phone capabilities.

Release 4.6

Release Date: August 31, 2016

Features:

  • The SDK now uses HTTPS by default for all endpoints.
  • The INSTALL_REFERRER configuration has been removed by default. To enable it, you need to include it in your AndroidManifest.xml. For more information, see the User Acquisition Tracking Guide.

Fixes:

  • Fixed the seqNum attribute that was missing on events sent via the SwrveWakefulService.
  • Fixed a bug in ConversationActivity where method access of FragmentActivity.onCreate was public instead of protected.
  • Fixed a bug where String.toLowerCase() should always be called with a Locale.
  • Added some missing comments on deprecations.

Release 4.5

Release Date: July 5, 2016

Features:

  • Conversations now rotate when changing device orientation. When a Conversation is displayed with enough space (such as landscape), a configurable lightbox and borders are used. For more information, see Intro to Conversations.
  • As with in-app message campaigns, it is now possible to set the priority of Conversations campaigns over others with the same triggers. A lower number means higher priority over other campaigns. For more information, see Creating Conversations.
  • The SwrveSDK.processIntent has been deprecated as engaged events are now automatically processed by the SDK. Note: If using ISwrvePushNotificationListener, ensure you handle long running operations accordingly, as this now executes in a BroadcastReceiver.
  • In-app messages are displayed using an Activity instead of a Dialog.
  • Google Play Services have been upgraded from 8.4.0 to 9.0.2.

Fixes:

  • Fixed runtime issues that were caused by restrictive Proguard rules.
  • Fixed an issue with in-app messages where the click area of a button would not line up properly if the device was rotated.
  • Conversation videos links are now opened using the device’s browser.

Release 4.4

Release Date: May 25, 2016

Features:

  • Added support for using event payload conditions to trigger in-app messages and Conversations campaigns. For more information, see Creating In-App Messages and Creating Conversations.
  • Added better samples that now include examples of Advanced Push, Message Center and multiple GCM providers. See the Samples folder for more details.
  • Started migrating our private tests to the public repo. More to follow.
  • Changed how Android support dependencies are dynamically included. The major and minor version numbers are now fixed, but the patch number can be updated dynamically. Note this can also be overridden in the app manifest using an “exclude group” for Swrve dependencies.
  • Removed the WRITE_EXTERNAL_STORAGE permission from the library manifest. If image caching in external storage is required, then you need to add this permission to the app.

Fixes:

  • Fixed a thread leak. Thanks to silin for contributing!
  • Removed incorrect allowbackup from library manifest.

Release 4.3.1

Release Date: May 9, 2016

Features:

  • The Locations SDK now includes a dependancy on a compatible version of the Swrve Android SDK; that is, version 4.3.1 or higher. If you try to use a pre-4.3.1 SDK with the latest Locations SDK (v1.1), the Locations SDK throws a runtime exception. For more information on integrating the Locations SDK, see Location-Based Campaigns SDK Integration.

Release 4.3

Release Date: April 7, 2016

Features:

  • Added the Star Rating survey template to conversations. For more information, see About Conversation Templates.
  • Custom button style options in Conversations now include rounded corners. For more information, see Intro to Conversations.
  • Internal refactoring for upcoming conversation improvements.
  • Added sample code to the Demo app that shows how GCM is integrated.
  • Added sample code to the Demo app that shows how Message Center is integrated.
  • Changed the swrve.device_region user property from a 3-letter country code to a 2-letter country code.

Release 4.2

Release Date: February 11, 2016

Features:

  • New Message Center API enables you to list conversations and/or in-app messages in the app’s inbox. For more information, see the Swrve Message Center API Guide.
  • Upgrade of the GCM library to 8.4.0.
  • The SDK is ready to work with the future release of Location-based Campaigns.

Fixes:

  • Improvements to the campaign state of in-app messages so it doesn’t get overwritten when campaigns are refreshed from the server.
  • Fixed an issue where apps with an Activity configured with singleTask launchMode were not logging push notification engagements events. For more information, see the onNewIntent method in the Android SDK Upgrade Guide.

Previous Releases Summary

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