Android Changelog

Minor release that adds support for specifying route_agent values and passing single messages to prepopulate into Airship Chat via deep link.

Changes

• Added support for handling route_agent and prepopulated_message params on Airship Chat deep links.
• Updated 14.5 migration guide and PrivacyManager javadoc to clarify usage.
• Updated 14.x - 15.x migration guide with instructions for enabling FEATURE_CONTACTS.

Major release that adds support for Airship Preference Center, Subscription Lists, and Contacts. This release removes support for overriding Firebase sender ID to a non-default Firebase project. Firebase currently recommends using a single Firebase project for both Crashlytics and Cloud Messaging.

Changes

• Added new module AirshipPreferenceCenter.
• Added new subscription lists APIs for Channel.
• Replaced NamedUser with Contact, which allows setting data on a user without an external ID (Named User ID).
• Added Dokka for generation of Kotlin documentation.

See the Migration Guide for further details.

Minor release that adds Airship Chat routing support.

Changes

• Added support for specifying a routing string in Airship Chat for directing messages to a particular agent.
• Added a try/catch around network callback register and unregister in NetworkMonitor, to prevent crashes on a small subset of devices.

Patch release that updates the version of firebase-messaging used by urbanairship-fcm and adds a dependency on firebase-iid to maintain support for overriding fcmSenderId to a non-default Firebase project. This configuration is no longer recommended by Firebase and may not be supported in future versions of the Airship FCM module. Firebase currently recommends using a single Firebase project for Crashlytics and Cloud Messaging.

Changes

• Updatedfirebase-messaging to version 22.0.0.
• Added firebase-iid dependency to urbanairship-fcm.
• Added a warning log message if fcmSenderId is being overridden to a non-default Firebase project.
• Marked fcmSenderId and related setter methods in AirshipConfigOptions as @Deprecated.

Minor release changing how the SDK handles data collection by introducing the privacy manager. Privacy manager allows fine-grained control over what data is allowed to be collected or accessed by the Airship SDK.

Changes

• Added privacy manager
• Deprecated existing data collection flags

See the Migration Guide and the Data Collection docs for further details.

Patch release with updates to support targeting the Android S preview SDK.

Changes

• Explicitly declare exported for all <intent-filter> declarations in manifest files.
• Set explicit mutability flags on all uses of PendingIntent.
• Removed databinding in urbanairship-chat.

Patch release that fixes auto scrolling the live chat message list in the ChatFragment when a message is received and removes some of the urbanairship-chat dependencies to make the module easier to generate Xamarin bindings.

Changes

• Drop *-ktk jetpack dependencies and kotlin-serialization from urbanairship-chat module.
• ChatFragment now auto scrolling the list when a message is received.

Patch release to fix styling of IAA banner buttons when using a Material theme.

Changes

• Fix IAA banner button custom styling when using a Material theme.

Patch release to fix full screen In-App Automation reporting events when a user taps a button.

We are no longer able to deploy to JCenter. Updates will only be available through Maven Central going forward.

Changes

• Fixed IAA full screen reporting events reporting as dismissed instead of button click
• Remove JCenter deploys

Minor release that adds support for Airship Live Chat and drops support for Android KitKat and Jelly Bean.

Changes

• Added new urbanairship-chat module.
• Updated minSdkLevel to API 21.
• Added isAccengageVisiblePush() and updated isAccengagePush() to support checking if an Accengage push is a message with content or a silent push.
• Updated Accengage module to fall back to Airship accent color and notification icon.

Minor release that drops support for uploading historic location data to Airship. The location module can still be used to listen for location updates within the app and will be deprecated in a future release.

Changes

• AirshipLocationManager will no longer upload lat/longs to Airship.
• Removed max border radius validation to allow more than 20dps for in-app automations.

Minor release that uses WorkManager for more reliable task management and better support for Instant Apps.

Changes

• Replaced JobScheduler with WorkManager.
• Added tag editor methods to the NativeBridge.
• Added ability to set NamedUser through the NativeBridge.

Patch release fixing a crash related to deferred IAA schedule logging. This issue only affects log levels debug and below, which by default are not enabled in production.

Changes

• Fixed misformatted log message in IAA
• Additional safety in LoggingCore

Patch release improving SDK stability and to fix FCM config overrides.

Changes

• Fixed not using FCM sender ID override in Airship Config
• Fixed SQLException crashes in the Automation module.
• Fixed SecurityException when accessing the TelephonyManager.
• Added error log if the URL Allow list is unmodified for SCOPE_OPEN.

Minor release adding support for frequency limits and advanced segmentation to In-App Automation, as well as new custom event templates.

Changes

• Added frequency limits support to IAA
• Added support for advanced IAA segmentation
• Added a new search event template
• Added wishlist options to retail event template
• Added sms:, tel:, and mailto: to default allow list settings
• IAA messages no longer redisplay if interrupted due to app termination

Patch release optimizing named user tag group cache usage in In-App-Automation.

Changes

• IAA tag group cache is now cleared when a named user is associated or disassociated

Airship SDK 14 is a major update that prepares our automation module to support future IAA enhancements, revamps the Channel Capture tool, and provides other improvements.

The majority of apps will only be effected by the new UrlAllowList behavior changes.

Changes

• BEHAVIOR CHANGE All URLs are not verified by default. Applications that use open URL action, landing pages, and custom in-app message image URLs will need to provide a list of URL patterns that match those URLs for SCOPE_OPEN_URL. The easist way to go back to 13.x behavior is to add urlAllowListScopeOpenURL = * to the AirshipConfig.
• Channel Capture tool now detects a knock of 6 app opens in 30 seconds. Instead of displaying anything to the user, the tool will write the current channel ID to the clipboard.
• Whitelist class and terminology removed and replaced with UrlAllowList.
• ActionAutomation and InAppMessageManager have been combined into InAppAutomation.
• InAppAutomation APIs have been updated to support future IAA enhancements. See migration guide for details.
• Removed deprecated APIs.
• Added sourcesJar maven artifact to each module, this allows browsing source code and java docs directly from Android Studio.

Patch release to fix ADM registration exceptions that occur on first run and text alignment issues with In-App Automation. Any apps that are configured to run ADM and are running 13.0.0 - 13.3.0 should update.

Changes

• Fixed In-App Automation text alignment.
• Fixed ADM registration crash.

Minor release that allows overriding the locale used by Airship.

Changes

• Added locale override.
• Fixed IllegalStateException in NotificationProxyActivity.

Patch release to fix In-App automation display intervals being ignored if the app is killed and HMS token registration on older Huawei devices.

Changes

• Fixed display interval not being respected if app is killed.
• Fixed HMS on older Huawei devices.
• Removed debug logs from Autopilot.

Minor release to handle target="_blank" URLs in Message Center and HTML In-App messages. This release also adds extendedBroadcastsEnabled that once enabled, will broadcast the app key and channel for easier partner integrations.

Changes

• Fixed possible background ANRs when processing location updates.
• Fixed SecurityException when checking if location updates are enabled.
• Open URLs in an external browser if the target is set.
• Added extendedBroadcastsEnabled config flag to broadcast when Airship is ready with the channel and app key, and when the channel is created.

Patch release to improve window inset handling for In-App message banners.

Changes

• Use standard window insets for banners instead of root insets.

Patch release to fix banner In-App messages displaying behind translucent navigation and status bars.

Changes

• Fixed window insets on banners

Minor release that adds Named User attributes.

Changes

• Added Named User attributes.
• Fixed NPE when retrying a failed video URL in IAA after the view has been detached from the window.
• Fixed logging an error message on registration failure due to using Huawei PushKit auto init feature on first run. The error was misleading as the registration will retry immediately after Push Kit is initialized.

Major release that adds support for enhanced custom events, date attributes, HMS push provider, and breaks the urbanairship-core module into several modules: urbanairship-core, urbanairship-message-center, urbanairship-automation, and urbananairship-location. This allows apps to pull in only the feature modules they use. Most of the changes in this release reflect the restructuring that makes this possible.

Changes

• Break out feature modules from urbanairship-core:
  • urbanairship-message-center: Message Center
  • urbanairship-automation: InApp Automation/Messaging, Landing Page Action, and Action Automation
  • urbananairship-location: Airship Location
• Updated CustomEvents to allow arbitrary JSON as properties.
• Added module urbanairship-hms that adds support for Huawei Mobile Services (HMS).
• Added date attribute support.
• Removed usage of deprecated AsyncTask.
• Removed deprecated APIs.

Patch release to fix a TransactionTooLargeException inside the Airship Job manager.

Changes

• Fixed TransactionTooLargeException exception.

Patch release to fix missing whitelist entries for EUCS cloud site and to fix a crash in event manager.

Changes

• Fixed ArithmeticException in EventManager due to a race condition of disabling analytics at the same time as an event upload.
• Added Airship EUCS URLs to whitelist.

Patch release improving SDK stability.

Changes

• Fixed NullPointerException crash in AlarmOperationScheduler
• Fixed ClassCastException crash in JobScheduler
• Fixed SQLExceptions crashes in In-App Automation
• Apps with any of these issues, and apps using In-App automation are encouraged to update.

Minor release that adds support for number attributes, new data collection flags, and an Accengage transition module to facilitate Accengage customers upgrading to Airship.

Changes

• Added support for number attributes.
• Added AirshipConfigOptions#dataCollectionOptInEnabled and UAirship#setDataCollectionEnabled(boolean) to make it easier to control Airship data collection.
• Added urbanairship-accengage module. This module migrates a device’s attributes and ID to Airship, and allows devices to receive push notifications from Accengage during the upgrade period.
• Added option to automatically install Google’s secure network provider before any Airship request by adding metadata to the manifest with key com.urbanairship.INSTALL_NETWORK_SECURITY_PROVIDER. The network installer is required for KitKat and older devices to work with the EUCS cloud site.

Patch release to fix an issue with the same In-App Automation banner displaying multiple times on an activity if the activity goes through a resume/pause/resume lifecycle state without a stop. This could occur when starting an activity with NEW_TASK and CLEAR_TOP flags if the banner is already displaying. Apps that are experiencing this issue with In-App Automation should update.

Changes

• Fixed In-App Automation banner from displaying multiple times on a single activity in certain situations.

Minor release that adds an accessor the In-App Automation name.

Changes

• Added name accessor for In-App Automations.
• Fixed a crash when specifying duplicate locale audience conditions for an In-App Automation.
• Fixed application starting a new activity instead of resuming the current activity when launching from a notification.

Fixes stability issues with in-app automation.

Changes

• Fixed a crash when specifying duplicate locale audience conditions for an In-App Automation.

Fixes stability issues with in-app automation.

Changes

• Fixed a crash when specifying duplicate locale audience conditions for an In-App Automation.

Major release decoupling Airship channel registration from push functionality, and adding support for channel attributes, which allow key value pairs to be associated with the application’s Airship channel for segmentation purposes.

Custom channel attributes are currently a beta feature. If you wish to participate in the beta program, please complete our signup form.

Changes

• Added a new AirshipChannel class
• Channel related functionality in PushManager is now deprecated
• Added a new AirshipChannel.AttributeEditor class
• Added a new editAttributes method to AirshipChannel
• Android compile and target SDK versions are now 29

Fixes an issue where push message could result in duplicate push notifications. Applications that are running 9.4.0 - 9.7.1 should update.

Changes

• Fixes issue with double processing messages on older devices.

Patch release to fix direct open reporting for notifications when an activity is resumed from the background. Applications running 11.x should update.

Changes

• Fixed direct open attributions for push notifications.

Patch release to fix direct open reporting for notifications when an activity is resumed from the background. Applications running 10.x should update.

Changes

• Fixed direct open attributions for push notifications.

Patch release to fix an issue with not starting a custom activity with the intent filter action com.urbanairship.VIEW_RICH_PUSH_MESSAGE for custom MessageCenter implementations and a fix for a minor fullscreen In-App Automation style issue. Apps that have custom message center implementations should update.

Changes

• Fixed not starting an activity for the intent action com.urbanairship.VIEW_RICH_PUSH_MESSAGE.
• Fixed top padding on the fullscreen In-App Automation when the header is the top most element.

Minor release that backports changes and fixes from 11.0.2 release.

Changes

• Updated banner in-app message adapter to make it easier to customize the banner view.
• Fixed not starting an activity for the intent action com.urbanairship.VIEW_RICH_PUSH_MESSAGE.
• Fixed top padding on the fullscreen In-App Automation when the header is the top most element.
• Synchronize use of SimpleDateFormat instance across threads.

Patch release to fix a rare crash caused by accessing a SimpleDateFormat across multiple threads.

Changes

• Synchronize use of SimpleDateFormat instance across threads.

Major release that migrates from the Android Support Libraries to the Jetpack (AndroidX) Libraries. Applications are required to migrate to Android X before using this version. For more info, see Migrating to AndroidX

Changes

• Migrated to AndroidX.
• Updated banner in-app message adapter to make it easier to customize the banner view.
• Allow defining notification channel sound with a raw resource ID through XML instead of a URL.

Patch release to fix issues with the banner in-app message type and background location updates on Android O+.

Changes

• Fixed banner in-app messages not dismissing when clicking the banner body.
• Fixed banner in-app messages not auto dismissing.
• Fixed background location updates on Android O+.

Patch release fixing a minor regression in AirshipNotifiationProvider when overriding small icon resources via the push API.

Changes

• AirshipNotificationProvider defaults to the small icon specified in the PushMessage, if available.
• AirshipNotificationProvider uses getters instead of instance variables when building its default NotificationArguments.

Major release that addresses new background restrictions with Android Q, includes enhancements to In-App Automation, and adds notification channel compatibility to simplify notification channel settings across Android versions.

9.x to 10.x Migration Guide

Changes

Packages

• Removed urbanairship-sdk and urbanairship-gcm. Apps should use urbanairship-fcm and/or urbanairship-adm instead.
• Preferences (com.urbanairhsip.preferences) have been moved into their own module urbanairship-preferences. The new preferences use the preference support library instead of the deprecated system preferences.
• Advertising ID tracking has been moved into its own module urbanairship-ads-identifier.
• Updated to Firebase Messaging 18.0.

Notifications

• NotificationFactory has been deprecated and replaced with a more flexible NotificationProvider interface.
• AirshipReceiver has been removed and replaced with 3 new listeners on the PushManager class: NotificationListener, PushListener, and RegistrationListener.
• The notification’s push message is now available in the launched activity intent.
• Added notification channel compat that works on Android 16 (Jellybean) and newer devices.

In-App Automation

• Added support for localized messages.
• Button resolution events can be generated from HTML messages via the native bridge.
• Display coordinator architecture for more flexible custom display management.
• There is a new, app-extendable, mechanism for caching the message’s assets.
• Banner messages now use a view group rather than a fragment, as system fragments were deprecated in Android P.
• Landing Pages are now scheduled as an HTML IAA.

Other

• Updated APIs for better kotlin interop support.
• Apps can now provide their own image loader.
• Added DeepLinkListener to make it easier to customize deep link handling.
• Removed styleable attribute urbanAirshipFontPath. Applications should use the Android xml font support instead.
• Builder factory methods and from JSON methods have been normalized throughout the SDK.
• Added OnShowMessageCenterListener that can be set on the Message Center to make it easier to perform custom message center actions.

Bug fixes

• Fixed incorrect font in Message Center Listing.
• Fixed an error when loading the favicon in Message Center.
• Fixed potential ANR if notifications actions take longer than 10 seconds to complete.
• Fixed potential resource-not-found exception on app update for legacy in-app messages when using messages with button drawables.

Minor release that allows listing for Urban Airship log messages.

Changes

• Added ability to listen for logs using a LoggerListener on the Logger class.
• Modal, HTML in-app automation window animations are now defined in the style sheets to make them easier to override.

Changes

• SDK will now catch any exceptions when attempting to post a notification. None of the notification factories provided by the SDK exhibit this behavior, but it’s possible that a custom notification factory could produce an exception.
• Fix potential crash when attempting to register with FCM if proguard is not configured properly.
• Fix modal In-App Automation message animations.
• The UAWebViewClient will no longer attempt to fetch favicons.

Minor release that targets Android P and updates dependencies.

Changes

• Updated compile and target SDK version 28 (Android P)
• Updated urbanairship-core dependencies:
  • Support library version to 28.0.0
  • Optional play-services-location to 16.0.0
  • Optional play-services-ads-identifier to 16.0.0
• Updated urbanairship-fcm dependencies:
  • firebase-messaging to 17.3.4
  • play-services-base to 16.0.1
• Updated urbanairship-gcm dependencies:
  • play-services-gcm to 16.0.0

Patch release that fixes an issue with Autopilot. If early take off was disabled it would prevent the display of push notifications. Apps that disable early take off should update.

Changes

• Fixed PersistableBundle NPE.
• Fixed ChannelCapture tool sometimes throwing an exception.
• Attempt automatic take off when receiving a new push or token from FCM.
• Marked RichPushUser#update(boolean) as library only. Applications should not call this method. It is handled internally by the SDK.

Minor release that adds support for tag group audiences, miss behaviors and resizable HTML messages in In-App Automation. HTML in-app messages are now displayed as dialogs by default, with an option to display fullscreen on smaller devices.

Changes

• Added support for tag group audience conditions for in-app messages.
• Added isReady method to InAppMessageAdapter so that adapters can wait for custom app conditions to be fulfilled before displaying
• Fixed media layout in the modal in-app messages when using template HEADER_MEDIA_BODY.
• Fixed videos autoplaying in an in-app message.

Patch release to fix proguard warnings with ADM.

Changes

• Update proguard rules.

Patch release that fixes a bug in the json matcher that caused app version equality checks to malfunction. Apps that use in-app automation with version triggers or audience conditions should update.

Changes

• Fixed JsonMatcher scope parsing.

Minor release that adds new NotificationFactory APIs to better handle limited background time when building notifications. This release also addresses ANRs from the GCM and ADM Broadcast Receiver that occur when notification building takes longer than 10 seconds when using a custom notification factory. To avoid the ANR, the braodcast will wait a max of 10 seconds before finishing received broadcast instead of waiting for the notification to finish. This will prevent the ANR from occurring, but the OS might kill the app before it has time to display the notification and it will be lost. To avoid this issue, either use NotificationFactory#createNotificationResult(PushMessage, int, boolean) to retry later if the notification is taking too long, or use NotificationFactory#requiresLongRunningTask(PushMessage) if the notification requires more than 10 seconds.

Changes

• Deprecated NotificationFactory#createNotificationResult(PushMessage, int) in favor of NotificationFactory#createNotificationResult(PushMessage, int, boolean) that also tells the factory if it has longer than 10 seconds to build the notification.
• Added listener to the Whitelist class to reject URLs.
• Added method to generate AirshipConfigOptions from a Properties instance.
• Fixed ANRs caused by slow notification builds in custom factories when using GCM or ADM modules.
• Fixed issue where HTML in-app automation messages were cancelled instead being displayed.

Fixed an issue where if you define an end time on a automation schedule (action or in-app messages), it would mark it as expired during the next app init, even if the schedule was not still current. Any app using either action automation or in-app messages should update.

Changes

• Fixed marking current schedules with an end time as expired.

Fixed issues with in-app automation not displaying due to the display being paused by default. Apps that use in-app automation should update.

Changes

• Fixed In-app automation display being paused by default.
• Fixed CoreActivity having a visible theme.

Changes

• Added support to add custom notification action buttons from xml.
• Added missing play-services-base dependency to urbanairship-fcm.
• Added method to InAppMessageManager to pause display of in-app messages.
• Locale and Timezone info is now sent up with the channel registration even if analytics are disabled.
• Removed use of custom permissions in the manifest.

Minor release that includes new APIs to allow extending in-app messages before they are displayed to the user, exposes information on the ResolutionInfo, and adds a new NotificationFactory create method that allows retrying a failed notification at a later time. This release also includes fixes to the Rate App Action crashing on Marshmallow and older devices. Applications that use the rate app action should update.

Changes

• Added message extenders to the InAppMessageManager.
• Added a new optional createNotification method that returns status.
• Expose type, duration, and button info on the ResolutionInfo class.
• Fixed BuildConfig conflicts with the urbanairship-sdk module.
• Fixed Rate App Action crashes.

Patch release to fix issues with proguard as well as enables fullscreen video for landing pages and message center.

Changes

• Enable fullscreen video for landing pages and message center.
• Added new error message when trying to display a message center message that is no longer available.
• Fixed proguard issue.

Minor release that introduces support for FCM apis, modular packages, and in-app message design updates. For FCM migration, please follow the FCM Migration Guide.

Changes

• Added support for FCM Google Play Services dependency.
• When using urbanairship-fcm, setting the FCM sender ID in the airship config options is now optional.
• Moved push providers into own packages - urbanairship-fcm, urbanairship-gcm, urbanairship-adm, and urbanairship-core. The package urbanairship-sdk still exists and is now just a wrapper package that depends on gcm, adm, and core to prevent breaking apps.
• Deprecated urbanairship-sdk and urbanairship-gcm packages. They will be dropped in SDK release 10.0.
• Updated in-app message designs.
• Added support to display an in-app modal message as fullscreen on smaller screen devices.
• Normalized the custom event builder APIs.
• Added metadata option to enable local storage in Urban Airship webviews.
• Updated to Play Services version 15.0.0 and Support Library 27.1.1. Tracking Advertising IDs now require the play-services-ads-identifier dependency.

Bug Fixes

• Added calls to takeOff autopilot when in-app message activities are being restored when the app is suspended.
• Fixed packages not declaring the proper dependencies in the pom file.

Patch release to fix an issue with delaying takeOff. Applications that make use of the isReady method may want to update.

Changes

• Remove wait for takeOff in the PushService
• Allow autopilot creation to be retried if the app info is unavailable

Patch release to fix a BadParcelableException when accessing the PushMessage from an intent’s bundle on some devices.

Changes

• Fixed BadParcelableException when handling push messages from intents.
• Fixed lint warnings/errors.

Patch release to fix a NPE due to a race condition in the in-app messaging manager and fixes an issue with cancelling in-app automation messages. Applications running older versions of SDK 9.0 should update.

Changes

• Added proguard rule to keep Autopilot class
• Fixed crash in the in-app automation manager.
• Fixed issue with cancelling in-app automation messages.

Patch release to fix a NPE introduced in 9.0.2 when sending a notification with a button without any actions.

Changes

• Fixed NPE in core receiver.
• Allow custom schemes when whitelisting urls.

Patch release to fix an issue with background services in Android O and a background ANR when delaying takeOff. Applications that are targeting Android O and take advantage of push notification actions should update.

Changes

• Fixed ANR when takeOff is delayed.
• Fixed IllegalStateException when opening a push notification with actions.

Patch release to fix a minor display issue and data validation for in-app messaging.

Changes

• Fixed in-app message displays when using the EXCLUDE_FROM_AUTO_SHOW flag in the manifest.
• Added missing checks for identifier lengths for both in-app messages and message buttons.

Major release required for new in-app messaging capabilities.

New features

• In-app messaging v2. The new in-app messaging module includes several different view types that are fully configurable, including modal, banner, and fullscreen. An in-app message is able to be triggered using the same rules as the Action automation module.
• A rate app action to prompt the user to rate the application.
• Automation schedule priority: Used to determine the execution order of schedules if multiple schedules are triggered by the same event.
• Support for editing automation schedules.
• New active session automation trigger. The trigger will increment its count if it has been scheduled during an active session instead of waiting for the next foreground.
• New app version automation trigger.
• Extended whitelist URL checking for URL loading instead of just JS bridge injection. By default these checks are disabled, but you can enable them with the AirshipConfigOptions field enableUrlWhitelisting.
• Updated localizations.
• Updated to Google Play Services 11.8.0 and Support Library 27.0.2.