Android Changelog

Bug Fixes

• Geofence: Exit events no longer fire for geofences the device never entered (#805) (c70ac93)
• Geofence: No more duplicate enter events after a device reboot or app update (#805) (c70ac93)
• Geofence: Geofences the device is currently inside always stay monitored, so their exit events aren't missed (#806) (27c64d6)
• Geofence: Nearby geofences are refreshed when the app returns to the foreground (#807) (7f97fc3)
• Geofence: More reliable geofence updates while on the move (#808) (b86f237)

Features

• add support for geofencing feature (#763) (7a1f85b)
• enable Live Notifications (#734) (6409037)
• Visual Notification Inbox overlay (integration / build distribution) (#769) (e28fa9f)

Bug Fixes

• scope in-app polling to process lifecycle instead of per-activity (#746) (5d30ba1)

Bug Fixes

• harden push notification activity and in-app message WebView (#733) (1323529)

Features

• events volume optimization release (#715) (5324714)

Bug Fixes

• Defined a working range of versions for the Segment Analytics (#679) (865851b)

Features

• Location enrichment (#666) (8d856bc)

Bug Fixes

• in-app messages not displaying when app returns from background with SSE enabled (#663) (9fb8156)

Features

• Added support for Notification Inbox (#660) (7bc46da)

Bug Fixes

• Downgrade OkHttp to v4 (#653) (8d97548)

Bug Fixes

• In app improvements (#640) (2270377)

Features

• In-app messages now support SSE (Server-Sent Events) as an alternative to polling, reducing latency and improving message delivery efficiency (#636) (6cba369)

Features

• lead capture for anonymous messages (#634) (8342099)

Features

• Updated the SDK and dependencies for Android 16 compatibility, including minor updates to better support newer OS restrictions and behavior changes. (#626) (2e36d0b)

⚠️ Notes

• Apps now may need to update their compileSdk version to 36 and Gradle version to at least 8.9.3 to ensure compatibility with updated dependencies and to successfully build against Android 16.

Bug Fixes

• Fixed a crash in release builds where anonymous messages could fail due to missing TypeToken definitions when R8/ProGuard optimizations were applied. (#623) (4fef7a8)

Features

• You can now send banners, modals, pop-ups, and surveys to anonymous visitors —no ID or email required.(#614) (bfcbb80)

Features

• Improve push notificaiton delivery receipts delay (#618) (ce5cdf3)

Bug Fixes

• optimize inline in-app reloading (#611) (a201c86)

Bug Fixes

• Resolved a crash when dismissing in app messages using back press during initial loading phase. Users can now safely navigate away from messages without encountering unexpected app crashes. (#608) (ea725f0)

Features

• Align public API with other CIO SDK platforms (#600) (fedbcc9)

Features

• Added support for queue sticky sessions (#598) (4dd7639)

Breaking Features

• Support for Kotlin 2+ is added (#591) (b5f94ff)

but this also means apps needs to have the following minimum requirement

• Gradle: 8.0 or later
• Android Gradle Plugin (AGP): 8.0 or later (8.2+ recommended)
• Kotlin: 1.9.20 or later (2.0+ required if using Kotlin Multiplatform or K2-specific features)

Bug Fixes

• Fixes a crash when build attributes from device are nullable (#584) (33a938f)

Features

• Add ability to configure messaging channels for local notifications (#582) (75ac690)

Internal

• Added base classes around Inline views to support communication of inline view with Wrapper SDKs (#579) (1459529)

Bug Fixes

• Sanitize unsupported numeric values, this fixes a crash when customers attempt to pass values that are not supported by JSON as properties for event or screen tracking (ex: NaN and +-Inf) (#569) (e75a721)

Bug Fixes

• Fixed a crash that occurred only when the app was restored by Android OS from background after being removed from memory with a modal in-app message active. The issue primarily affected wrapper SDKs or apps that don't initialize the SDK in Application class at startup. (#561) (83003b5)

Features

• Added support for inline in-app messages. Inline in-app messages act like a part of the content on your page. They let you dynamically populate parts of your app and talk to your customers without interrupting their experience. (#557) (854a8ad)

Bug Fixes

• Use SDK for tracking events in plugin to follow same lifecycle as other events (#521) (1c0b7a6)

Bug Fixes

• Fixed an issue where, upon FCM token refresh, the newly generated token was mistakenly deleted and re-added. With this fix, only the old unused token is deleted, and the new token is retained and added as expected. (#517) (ccb9de2)

Bug Fixes

• Added support for null handling in nested structures in attributes/traits (#508) (bf6cb1b)

Bug Fixes

• Fixed the sequencing of screen tracking events for in-app messaging current screen state (#500) (6877daf)

Bug Fixes

• Resolved syncing issues for events stored while in battery saver (offline) mode (#498) (6f3d16f)

Bug Fixes

• Android 14 introduced strict rules for when apps are in the killed state, impacting push delivery tracking. This release fixes that. (#493) (ea5c7a7)

Bug Fixes

• Fixes in-app messages overlay background color being ignored from in-app message payload (#485)

Bug Fixes

• Fixes the bug where device update/delete events would not migrate automatically when migrating from v3 to v4 (#481)

Features

• Added ability to disable forwarding screen events to destinations/servers. Apps can still send screen events for local processing and use them for page rules in in-app messages by just updating SDK configuration during initialization. Learn more about screen configuration options here. (#474) (b5ea8e9)

Fixes

• Handle the case where the user identifier would be set to an empty string, if profile attributes were updated before identifying the profile. #476

Bug Fixes

• Fixes issue with loading legacy editor messages (#469) (ecd89dd)

Features

• This release introduces support for displaying larger in-app messages. (#456) (b8331bf)

Internal

• Updated our SDK to use the v2 version of our in-app messages API. This will provide a more reliable experience for in-app messages. (#461)

Note:

This is only supported for the new in-app editor, if you are using the legacy in-app editor, it is recommended NOT to upgrade to this release for now.

Improvement

• This release includes changes needed to support for data pipelines in the our React Native SDK. There are no new features for customers utilizing our native Android SDK only.

Features

• Revamped the in-app messaging module to enhance performance by optimizing local processing, accelerating message loading during page transitions, and implementing a state-driven architecture for better responsiveness and control. (#431) (682ac42)
• We highly recommend upgrading to the new in-app editor to ensure optimal performance.

Fixes

• We reduced the chance of duplicate in-app messages by keeping a local store of messages already displayed.
• Resolves an issue with tracking attributes for certain in-app messages.
• Fixes an intermittent crash on initialization. #426
• Resolves an application not responding (ANR) issue. #147

Features

• Ability to dismiss current in-app message. Currently displayed message can now be dismissed using CustomerIO.instance().dismissMessage() (#420) (8bfc37d)
• Improved logs around in-app messaging to provide more clarity on state changes and actions performed on in-app messages (#421) (8bfc37d)

Bug Fixes

• Resolves an issue that caused the SDK version to be reported as the previous version for versions 3.3.0 - 4.0.0. (#415) (1358719)

⚠ BREAKING CHANGES

• Data Pipelines Support: Sending your mobile data into our customer data platform (CDP) helps you support both Journeys and the rest of your martech stack—analytics, data warehouses, CRMs and more. (#412) (772b489)

Features

• Anonymous tracking: You can send anonymous events, and we’ll reconcile anonymous activity with your users when you identify them.
• Built-in lifecycle events: the SDK now automatically captures events like “Application Installed” and “Application Updated” for you, so you better understand your users’ behaviors in your app. (#334) (9d239c8)
• New device data: the SDK captures complete device-level context, like your audience’s screen dimensions, device names, and more. (#341) (7cb17c1)

Bug Fixes

• Resolves an issue that caused the SDK version to be reported as the previous version for versions 3.3.0 - 4.0.0. (38b2815)

Bug Fixes

• Messages created in the new drag and drop in-app editor will load much faster and don’t require pre-fetching assets. If you are using the older in-app editor, the initial in-app message may experience a delay. We highly recommend upgrading to the new in-app editor to avoid this issue and ensure optimal performance. (#393) (8c8ee89)
• This update also resolves an issue that was causing crashes during the pre-fetching step in certain situations.

Features

• When using page rules and when an in-app messages need a second to load, the in-app message might appear after a user navigates to another page. We made changes to ensure the page-rules are checked after the message is loaded and immediately before it’s displayed in order to resolve this issue.
• We resolved a caching issue that in rare cases, caused users to see the incorrect in-app message when logging out then logging back in as a different user.

(#355) (ee756d6)

Features

• support for android gradle plugin 8 (#296) (90b31ef)

Bug Fixes

• added consumer rules for R8 full mode (#298) (3aa6757)

Bug Fixes

• last used format for device (#287) (726667b)

Features

• use new header to set polling interval (#285) (966c9cb)

Bug Fixes

• ensure messages are only shown once (#281) (f73e13f)

Bug Fixes

• fixes a thread safety issue with currentMessage being out of sync (#279) (bb72944)

Features

• improve push click behavior (#247) (bcc5318)

Bug Fixes

• add priority field to message and sorting by priority within local store (#276) (ddb0359)

Features

• persistant in-app messages (#269) (4fcb781)

Bug Fixes

• added exception handling for when browser doesn't exist (#271) (aaddad5)

Bug Fixes

• stack-overflow caused by BQ recursion (#251) (365a5b6)

Bug Fixes

• prevent concurrency issues in in-app listeners (#246) (72dafd7)

Bug Fixes

• in-app messaging proguard rules missing (#241) (c494bb0)

Bug Fixes

• prevent empty identifier and device token (#240) (e9b5d0c)

Bug Fixes

• duplicate classes crash on wrappers (#239) (ead2175)

Bug Fixes

• migrate in-app module from gist to CIO (#221) (d6fda6d)

Note: We've made updates to our installation instructions. Please refer to them as they reflect our new streamlined process which no longer necessitates a previously required dependency for in-app messages.

Features

• expose device token (#235) (deaa916)

Bug Fixes

• expose push tracking to wrapper sdks (#227) (3bc1345)

Bug Fixes

• set auto track screen to false by default (#216) (71fcf52)

Bug Fixes

• improve delivered metrics (#204) (831d1d9)

Features

• dismiss in-app message (#186) (89794f3)

Bug Fixes

• minor only auto update for gist (#210) (c00d50c)

Bug Fixes

• multiple Queue instances being created (#190) (406626c)

Bug Fixes

• push opened metrics tracked on Android 12 (#184) (d2e52fa)

Features

• in app click tracking (#187) (4ad1f35)

Bug Fixes

• remove tasks from queue with 400 http response (#177) (3ed104a)

Bug Fixes

• prevent crash for file not found exception (#178) (be8a2d9)

Features

• add setting a in-app event listener (#147) (5fd9559)
• in-app feature no longer requires orgId (#163) (fc2a08e)

Bug Fixes

• image not shown when image url in notification payload (#172) (0abdc85)
• moved shared wrapper code (#158) (51af98f)
• remove currentRoute parameter in in-app event listener (#159) (688e4a5)
• rename in app listener keys (#164) (f540eaf)
• set gist dependency to use latest 3.X.Y version (#170) (a019c36)
• set gist user token incase identifier exists (#162) (44cc4d1)
• update CustomerIOFirebaseMessagingService to open (#174) (edce7f5)
• upgrade dependencies (#146) (6da8b8d)
• use maven style dependency range syntax (#171) (ba83214)

Features

• sdk initialization re-architecture (9e21960)

Bug Fixes

• cio sdk version attribute using client value (bb90f35)
• user agent client support in preferences repo (454a18e)

Bug Fixes

• in-app messages instant delivery (#150) (a6dcf3c)

Features

• added shared instance for independent components (70fa8cd)
• added support to modify notification small icon (b93c2dc)

Bug Fixes

• in-app messages stop delivering (4027502)
• in-app system link causes app reopen (6349081)
• updated json adapter usage to safe parsing (f72280b)

⚠ BREAKING CHANGES

• android 12 deep link fix

Features

• added option to customize push notification from app (68010f8)
• changes for react native package (2f20ac3)
• in app sdk (1036c80)
• updated client to support react native user agent (7588526)

Bug Fixes

• android 12 deep link fix (fd7ae28)
• version bump for gist sdk to resolve messaging not showing bug (05dad42)

Bug Fixes

• parsing exception for expired tasks (440bb13)

Features

• delete expired background queue tasks (8dca8b7)

Bug Fixes

• deploy code script commands (#124) (fe817d1)

Bug Fixes

• track opens fcm notification payload (ab3cd18)

⚠ BREAKING CHANGES

• get current FCM token on SDK startup
• register device attributes when set
• create background queue to make API synchronous

Features

• add device and profile attribute setters (789f09f)
• add device_manufacturer device attribute (6a60f39)
• added support for custom track url (b61a64b)
• added support for device attributes (#71) (5fedf26)
• create background queue to make API synchronous (2524460)
• get current FCM token on SDK startup (dda443d)
• register device attributes when set (0f5159e)
• set log level via SDK config (81eea4e)
• support for custom device attributes and config (#77) (a7dbaba)

Bug Fixes

• added java compatibility in public constructors and methods (acdec46)
• added support for big decimal (#56) (58c791b)
• code cleanup (c651ee6)
• delete device token when clear identify (72f9753)
• events are tracked to identified customer (71634ed)
• queue attempts to run all tasks on each run (e180dea)
• register device tokens http request (b1c6872)

Bug Fixes

• added alternative route to fetch screen name for automatic tracking (#92) (37a20b5)

Bug Fixes

• crash using invalid characters in HTTP header (#75) (81a065e)

Bug Fixes

• allow http requests in host app (#74) (1035648)

Bug Fixes

• added java compatibility in public constructors and methods (2bb73be)

Bug Fixes

• number parsing coverts to double (#57) (72a80fe)

Bug Fixes

• pro-guarding removal of enums (#39) (dd27d35)
• timestamp conversion issue (#37) (d986f54)
• updated host endpoints (#53) (efe2b9e)
• user agent (#42) (37af83e)

Features

• automatic screen tracking (#52) (8f95ebb)
• event tracking, identify customer (#29) (5181268)
• manual screen tracking (#51) (213a278)
• Push notification (#31) (c639802)
• Rich push support (#34) (2480127)