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 source from the GitHub public repository.
- Integrate the SDK via Gradle by adding the following code to your
build.gradle
file.
First, in the projectbuild.gradle
file, add the Maven Central repository:repositories { mavenCentral() }
Then, select a Swrve library to install, ensuring you include the latest SDK version number: 11.1.1
Firebase – select if you use push notifications with Swrve, or any Firebase services like Firebase Cloud Messaging or Analytics.dependencies { implementation 'com.swrve.sdk.android:swrve-firebase:11.1.1' }
Amazon – select if you use Amazon Device Messaging.
dependencies { implementation 'com.swrve.sdk.android:swrve-amazon:11.1.1' }
Huawei – select if you use Huawei Push Service.
dependencies { implementation 'com.swrve.sdk.android:swrve-huawei:11.1.1' }
Basic – select only if you are not using Swrve push notifications, or any Firebase/Amazon/Huawei services.
dependencies { implementation 'com.swrve.sdk.android:swrve:11.1.1' }
For upgrade instructions, see Android SDK upgrade guide.
Release 11.1.1
Release date: November 19, 2024
Fixes
- Fixed an issue affecting In-app message Stories where deeplinks were not opening.
Release 11.1.0
Release date: November 7, 2024
Features
- Added Intervals and Blackout Dates for in-app messages and embedded campaigns. For more information, see Schedule triggered campaigns.
Release 11.0.0
Release date: October 16, 2024
Features
- In-app messages now appear edge-to-edge on all Android devices.
- Swrve Conversations is no longer supported and this feature has been removed from the SDK.
- Increased Android minimum SDK from 19 to 21 to support the latest Firebase Cloud Messaging.
- Increased Android target SDK from 34 to 35.
- Upgraded the following tools and services:
- Firebase-messaging library to version 24.0.1
- Huawei AGCP plugin to version 1.9.1.303
- Android Gradle Plugin to version 8.6.1
- Gradle to version 8.7
Fixes
- Copy to Clipboard button click details will now appear in QA logs.
Release 10.16.0
Release date: August 28, 2024
Features
- Added Push Inbox API. For more information, see Push Inbox API.
- Added platform and device type properties to IAM campaign events.
Fixes
- Remove use of deprecated API for getting device height and width.
Release 10.15.1
Release date: May 30, 2024
Features
- Notifications on the Lock Screen will now show the full message body when the message visibility is set to public.
Release 10.15.0
Release date: May 30, 2024
Features
- Added
getDeviceId()
API to get the Swrve generated device id.
Fixes
- Fixed an issue with Campaign Holdouts where control campaigns weren’t treated exactly the same as treatment campaigns.
Release 10.14.0
Release date: March 26, 2024
Features
- In-app messages now support customizable layering of content elements. For more information, see Layering elements.
- The Push Delivered event payload now includes details when a notification is not displayed because the Notification Channel is disabled.
- The Push Delivered event payload now includes the message’s priority.
Fixes
- Fixed an issue where the notification permission event was not queued straight away.
Release 10.13.0
Release date: January 29, 2024
Features
- In-app message now supports the Story message type. For more information, see Designing in-app message Stories.
Release 10.12.0
Release date: January 10, 2024
Features
- The Identify API now supports periodic hard refresh with the server instead of using a local cache. For more information, contact your CSM at support@swrve.com.
- Added support for Android 14 (API Level 34).
- Added a check to prohibit the use of a secret key type when creating an SDK instance with an API key.
- Removed Jetify from the Gradle Build.
- Upgraded the following tools and services:
- Android Gradle Build Tools plugin to version 8.1.1.
- Firebase Cloud Messaging to version 23.2.1.
- Huawei: Upgraded Push Kit to version 6.11.0.300 and Gradle plugin dependency (agcp) to version 1.9.1.301.
- Added extra parameters to the push payload for internal processing.
Fixes
- Resolved an issue to ensure that events are correctly requeued when a HTTP 429 error occurs.
- Huawei: Fixed a bug that prevented push notification processing and rendering.
Release 10.11.2
Release date: September 8, 2023
Fixes
- Fixed an issue where deeplinks were not opening if the
SwrveInAppMessageListener
was implemented. For custom deeplink opening, implement theSwrveDeeplinkListener
.
Release 10.11.1
Release date: August 18, 2023
Fixes
- Fixed an issue with missing in-app message button click events for opening app and notification settings, and requesting a permission.
Release 10.11.0
Release date: June 27, 2023
Features
SwrveInAppMessageListener
now receives callbacks that include campaign and button metadata for the following in-app campaign interactions: impression, dismiss, custom, and copy to clipboard.- Deprecated the
SwrveDismissButtonListener
,SwrveCustomButtonListener
, andSwrveClipboardButtonListener
callbacks. For more information, see In-app messages.
Release 10.10.1
Release date: June 15, 2023
Fixes
- Fixed an issue to ensure the SDK called the
SwrveEmbeddedListener
instead of the deprecatedSwrveEmbeddedMessageListener
for embedded campaigns from push notifications.
Release 10.10.0
Release date: May 18, 2023
Features
- In-app messages now support custom button styles. For more information, see Intro to in-app messages.
- Added the setSplashActivity API to the SwrveConfig, which can be used to configure your splash screen activity. This API delays the init of the Swrve SDK until your app is loaded and ready to display Swrve campaigns.
- Added the setSwrveDeeplinkListener API to the SwrveConfig, which is used to access deeplinks from in-app messages, Conversations, and push notifications.
- Improved push token registration for QA users.
- In-app message page navigation events now include the button name.
- In-app message campaigns now require a valid image content type for URL images.
- Upgraded the following tools and services:
- Android Gradle Build Tools plugin to version 7.4.0.
- Android material components library version 1.8.0.
Release 10.9.2
Release date: March 30, 2023
Fixes
- Fixed a deep linking issue on Android 12+ that sometimes caused a second push notification to fail to open when selected.
Release 10.9.1
Release date: February 1, 2023
Fixes
- Fixed an issue with how the SDK called
SwrveResourcesListener.onResourcesUpdated
, which sometimes caused the app to crash.
Release 10.9.0
Release date: January 19, 2023
Features
- To improve campaign holdout reporting on in-app message and embedded campaigns, the SDK now sends an impression event.
- Added support for requesting Android 13 notification permissions through in-app message campaigns.
- Added a new action to in-app message campaigns that automatically directs a user to the app’s notification settings page when they click a button. This is a useful option for getting the user to grant permission if they previously denied the permission prompt.
- Added a new action to in-app message campaigns that automatically launches the Swrve Geo SDK, prompting the user to grant location permission.
- Added NUMERIC conditions support to in-app message triggering logic.
Release 10.8.0
Release date: December 1, 2022
Features
- Improved how the SDK downloads image and font assets for in-app messages and Conversations by adding checks that prevent excessive downloading of the same asset.
Release 10.7.0
Release date: November 24, 2022
Features
- Added support for sending an event or user property update when a user engages with an in-app message. For more information, see In-app messages.
Release 10.6.0
Release date: October 28, 2022
Features
- Realtime user properties are now updated before displaying in-app campaigns from push notifications.
Fixes
- Fixed an issue to ensure the SDK only downloads an asset once.
Release 10.5.0
Release date: October 25, 2022
Features
- The Push Delivered event payload includes an
additional_info
field that contains details such as the Google sent time and message ID. - Added a new API called
SwrvePushServiceDefault.handle(Context context, Map data, String messageId, long sentTime)
. Use this API when implementing multiple push providers.
Fixes
- Fixed a rendering issue to ensure only one notification and delivery event is sent per single push.
Release 10.4.0
Release date: October 14, 2022
Features
- Added support for Android 13 (API Level 33), which includes Android’s new permission setting for displaying notifications.
- The Push Delivered event payload now includes details when a notification is not displayed because the notification permission is denied.
- Added a new API to the
SwrveNotificationConfig
calledpushNotificationPermissionEvents
. Use this API to configure specific events that trigger a notification permission prompt when added to the event queue. For more information, see Push notification permission request. - Huawei: Upgraded Push Kit to version 6.7.0.300 and Gradle plugin dependency (
agcp
) to version 1.7.2.300.
Release 10.3.0
Release date: September 20, 2022
Features
- Added CONTAINS conditions support to in-app message triggering logic.
Release 10.2.0
Release date: September 5, 2022
Features
- Added a new object called
SwrveMessageCenterDetails
to expose the subject, description, and image icon of a message center campaign. For more information, see Swrve Message Center API. - Added a new API called
getDownloadDate
that provides the download date of a message center campaign. - Made performance improvements to the SDK asset download process.
Release 10.1.0
Release date: August 4, 2022
Features
- In-app messages now support displaying animated GIFs as the background or button image format, using Glide Library. For more information, see In-app messages.
- Added an API to retrieve the name of an in-app message campaign via the Message Center API.
- Upgraded the following tools and services:
- Android Gradle Build Tools plugin to version 7.2.1.
- Android target SDK to 32.
Release 10.0.0
Release date: June 17, 2022
Features
- Increased Android minimum SDK from 16 to 19 to support the latest Firebase Cloud Messaging.
- Added
SwrveMessageFocusListener
toSwrveInAppMessageConfig
, which is used to configure button focus behavior for in-app message campaigns. - The
SwrveCustomButtonListener.onAction
andSwrveDismissButtonListener.onAction
APIs now contain an extra string argument for the campaign name. - Upgraded the following tools and services:
- Android Gradle Build Tools plugin to version 7.1.3.
- Firebase Cloud Messaging to 23.0.5.
Previous releases summary
Date | Version | Features and Fixes |
---|---|---|
May 12, 2022 | 9.4.0 | In-app message enhancements: Multi-page support, accessibility text support, and added OR conditions support to triggering logic. |
April 8, 2022 | 9.3.1 | Upgraded Huawei Push Kit to version 6.3.0.304, which resolved a compliance issue with publishing to the Play Store. |
April 7, 2022 | 9.3.0 | Upgraded Huawei Push Kit to version 6.3.0.302. |
February 28, 2022 | 9.2.0 | Added support for custom text styling, padding, fonts, and line height for in-app messages. |
December 14, 2021 | 9.1.0 | Added support for multiple lines of text in the in-app message text component and added the ability to set a SSLSocketFactory through our Swrve Config. Improved cache refreshing for Real Time User Properties to prevent out-of-date properties from being used when loading campaigns for the first time. |
November 8, 2021 | 9.0.0 | Added support for Android 12. If using Google Play services advertising ID, you must now include the library dependency in your build.gradle. Removed some internal deprecations and upgraded various tools and services. |
July 29, 2021 | 8.0.0 | Made performance improvements to the SDK initialization, added a new API called stopTracking , included personalization properties in the SwrveEmbeddedMessageListener , renamed the ManagedModeAutoStartLastUser configuration in SwrveConfig to AutoStartLastUser , removed the LoadCachedCampaignsAndResourcesOnUIThread configuration in SwrveConfig, the SwrveLogger now uses Android log constant values instead of numbers. Fixed an issue with text alignment on Conversation buttons and upgraded the Push Kit to version 5.3.0.304. |
April 27, 2021 | 7.6.1 | Fixed an issue with Conversation custom fonts that caused the system font to display on devices running Android 11. |
March 31, 2021 | 7.6.0 | Added support for Huawei Push Service. |
March 18, 2021 | 7.5.0 | Added Activity Window Listener to SwrveInAppMessageConfig . |
December 14, 2020 | 7.4.0 | Added the ability to use Swrve triggering for your own application UI and upgraded various tools and services. |
November 3, 2020 | 7.3.2 | Various bug fixes. |
October 7, 2020 | 7.3.1 | Various bug fixes. |
September 24, 2020 | 7.3.0 | Internal changes to improve the reliability of sending the Push Delivered event, upgraded various tools and services, and updated tracking of device OS and type for platform-specific delivery of in-app messages. |
September 4, 2020 | 7.2.1 | Various bug fixes. |
August 17, 2020 | 7.2.0 | Upgrades to the QA user feature, with richer logs now available in the QA user logging screen, and removed format , orientation , and size from the in-app message impression event payload. Various bug fixes. |
May 14, 2020 | 7.1.0 | Mark Message Center campaigns as seen programmatically and upgraded various tools and services. Various bug fixes. |
March 10, 2020 | 7.0.0 | Swrve now automatically tracks and logs when push notifications are delivered and displayed on each device, changed the notification accent color configuration from RGB to Hex, added the ability to set a custom registration ID for the Firebase service, added a new SwrveInAppMessageConfig object used to configure global settings related to in-app messages, removed the previously deprecated SwrveNotificationCustomFilter, increase Android minimum SDK version from 14 to 16, and upgraded various tools and services. Various bug fixes. |
February 20, 2020 | 6.3.1 | Fixed an issue that prevented Conversations from displaying correctly on wider devices. |
October 2, 2019 | 6.3.0 | Added configuration options for delaying the start of the SDK and setting a custom user ID for tracking purposes, deprecated SwrveNotificationCustomFilter, and updated the SDK to send the Firebase push token (swrve.gcm_token) separately to regular device updates. Various bug fixes. |
September 16, 2019 | 6.2.1 | Bug fixes. |
July 31, 2019 | 6.2.0 | Added support for Swrve GeoSDK plugin v2.3, which supports geo notification cooldown periods. Also includes support for adding geoplace opening hours via CSV upload or the Geoplace API. |
April 29, 2019 | 6.1.1 | Bug fixes. |
April 5, 2019 | 6.1.0 | Added support for Geo SDK plugin v2.2. Upgrades to various build tools and services. Bug fixes. |
February 21, 2019 | 6.0.2 | Bug fixes. |
November 30, 2018 | 6.0.1 | Bug fixes. |
October 31, 2018 | 6.0.0 | Removed support for Google Cloud Messaging. Added an API for handling User Identity. Removed support for deprecated Locations campaigns. |
September 21, 2018 | 5.3.2 | Bug fixes. |
September 17, 2018 | 5.3.1 | Bug fixes. |
September 3, 2018 | 5.3.0 | Deprecated the swrve-google flavor of the SDK. Added support for linking push notifications to in-app campaigns and Swrve Geo SDK 2.0. Added new SwrveNotificationConfig object for configuring global settings for notifications and deprecated SwrveSDK.setPushNotificationListener() . Upgrades to various build tools and services. Bug fixes. |
March 5, 2018 | 5.2.0 | 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. |
January 15, 2018 | 5.1.1 | Updated Multiple GCM Providers Sample project to make it compatible with Android O and added an API for disabling Logcat logging. |
December 12, 2017 | 5.1.0 | Various libraries and support tools upgrades. |
November 16, 2017 | 5.0.0 | Refactors and code improvements. Added automatic activity tracking and support for nested push notification payload JSON. |
October 16, 2017 | 4.11.3 | Bug fixes. |
September 20, 2017 | 4.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 | 4.11.1 | Bug fixes. |
August 16, 2017 | 4.11.0 | 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 | 4.10.1 | Bug fixes. |
May 24, 2017 | 4.10.0 | Added support for using silent push notifications to send background app content updates. |
March 21, 2017 | 4.9.0 | 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 | 4.8.0 | Various Conversation enhancements and fixes, including custom fonts and styling. |
November 24, 2016 | 4.7.0 | 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 | 4.6.2 | Bug fixes. |
September 12, 2016 | 4.6.1 | Bug fixes. |
August 31, 2016 | 4.6.0 | SDK now uses HTTPS by default for all endpoints. |
July 5, 2016 | 4.5.0 | Conversations enhancements. |
May 25, 2016 | 4.4.0 | Added support for using event payload conditions to trigger in-app messages and Conversations campaigns. |
May 9, 2016 | 4.3.1 | Added dependancy to Locations SDK v1.1 on Swrve iOS SDK v4.3.1 or higher. |
April 7, 2016 | 4.3.0 | Added Star Rating survey template to Conversations. |
February 11, 2016 | 4.2.0 | Added Message Center API and updated Google Cloud Messaging libraries. |
November 30, 2015 | 4.1.0 | Restricted use of Swrve.* namespace for custom events. |
November 5, 2015 | 4.0.5 | Updated Google Cloud Messaging libraries. |
October 21, 2015 | 4.0.4 | Bug fixes. |
October 15, 2015 | 4.0.3 | Added compatibility with Android Marshmallow. |
September 23, 2015 | 4.0.2 | Updated push notification plugin to latest GCM library and increased HTTP default timeout. |
August 18, 2015 | 4.0.1 | Bug fixes. |
July 7, 2015 | 4.0.0 | Added support for Conversations and moved from JAR to AAR distribution. |
April 8, 2015 | 3.4.0 | Changed default background for in-app messages from solid black to transparent. |
January 21, 2015 | 3.3.1 | Added support to automatically capture and send referrer information. |
November 11, 2014 | 3.3.0 | Added support to log carrier information by default. |
October 21, 2014 | 3.2.0 | Added support to generate a random UUID if no custom user ID is provided at initialization. |
July 30, 2014 | 3.1.0 | Simplified Google Cloud Messaging push notification integration and added support for triggering in-app messages at session start. |
May 27, 2014 | 3.0.1 | Bug fixes. |
May 15, 2014 | 3.0.0 | Enhancements to real-time targeting and added separate JAR files for Google Play-flavored SDK. |
April 3, 2014 | 2.10.1 | Bug fixes. |
April 1, 2014 | 2.10 | Simplified in-app message actions and QA device registration. |
March 4, 2014 | 2.9.0 | Added support for push notifications for Android devices. |
2.8.0 | Added support for Swrve’s redesigned in-app messaging functionality and push notifications Beta. | |
2.7.1 | Bug fixes. | |
2.7.0 | Added support for auto-generation of user IDs and unified the in-app messaging and analytics SDKs. | |
November 12, 2013 | 2.6.0 | Added support for extended IAP event and bug fixes. |
October 16, 2013 | 2.5.0 | Added support for in-app messaging per campaign dismissal rules and bug fixes. |
September 17, 2013 | 2.4.0 | Added support for in-app messaging QA logging. |
August 20, 2013 | 2.3.0 | Added support for in-app messaging QA user functionality. |
July 26, 2013 | 2.2.0 | Bug fixes. |
July 2, 2013 | 2.1.0 | Added support for app store filtering within in-app messaging. |
May 22, 2013 | 2.0.1 | Fixed possible crash while displaying messages whose images were not fully downloaded. |
May 17, 2013 | 2.0.0 | First public release. |