Technical DocMobile SDK Changelog

Mobile SDK Changelog

Subscribe to SDK releases

Android Native SDK

💡

Get notified of updates by subscribing to 📬 release notifications.

See also: Android SDK Documentation

4.10.0 - 2022.06.03
  • Contentsquare visual identity: Updated Contentsquare logo and snapshot button to match the new visual identity.
  • Session Replay: Fixed a bug for which some views captured were not rendered while replaying a user session.
  • WebViews tracking: Update of the WebViews injection mechanism to support new events sent by the WebView Tracking Tag (Dynamic variable, Transaction, Optin, Optout) See the WebView Tracking Tag documentation.
  • Misc: Minor improvements and bug fixes.
4.9.0 - 2022.04.15
  • Session Replay: Add feature to select different quality levels for Wi-Fi & Cellular See the Session Replay Quality Levels section
  • Session Replay: Fixed a bug on unMask API; fixed rendering bugs;
  • In-app features: Fixed a bug where snapshot button does not disappear when app is put in background.
  • Misc: Minor improvements and bug fixes.
4.8.0 - 2022.03.18
  • Session Replay: Added logs when starting & stopping;
  • Snapshots: Multiple bug fixes on snapshot button and capture.
  • Misc: Minor improvements and bug fixes.
4.7.0 - 2022.01.14
  • Session Replay: Optimisation of quality & data consumption.
  • Remove Jetifier: Agera dependency has been removed, which was using android support library. Jetifier is not required anymore.
  • Misc: Minor improvements and bug fixes.
4.6.0 - 2021.12.15
  • Session Replay: new Replay link API to integrate with third-party tools (VOC, crash reporting); Session Replay can be accessed directly within minutes with direct link; replay link button added to in-app features settings; hardware bitmaps are now supported; data consumption optimization; fixed regression on masking API.
  • Misc: Minor improvements and bug fixes.
4.5.0 - 2021.11.18
  • Session Replay: Misc improvements.
  • SDK Log Visualizer: This new module lets you see the live stream of events detected by our SDK (logs) directly in Contentsquare. Check out the Viewing logs in the Contentsquare platform section.
  • Misc: Minor improvements and bug fixes.
4.4.0 - 2021.10.18
  • Drop support for Android Jelly Bean (API Levels 16, 17 & 18): As Google Play services is discontinuing updates for Jelly Bean (API levels 16, 17 & 18), the minimum supported version is now Android 4.4 KitKat (API level 19).
  • Session Replay: WebViews masked by default; performances and quality optimisations;
  • Disable Session Replay for specific app versions: Introducing capability to disable Session Replay for specific app versions (controlled from back office).
  • Logs: Reduced noise to keep only relevant logs. You can just filter on CSLIB
  • Permission: Removed overlay permission request for Android <=5.1
  • Misc: Minor improvements and bug fixes.
4.3.0 - 2021.08.10
4.2.1 - 2021.07.07
  • Fixed an issue introduced in 4.2.0 that affected gestures tracking on the first activity after app start
4.2.0 - 2021.06.14
  • Session Replay: Session Replay feature is now part of the SDK and disabled by default. This feature is only accessible to customers participating in the Early Access program. For more information reach out to your Contentsquare contact.
  • Gestures: Fixed issue that caused gestures to be attached to the wrong view in some cases.
  • Misc: Minor improvements and bug fixes.
4.1.0 - 2021.02.16
  • WebView: WebView tracking back-office setting has been removed. WebView tracking is now always enabled.
  • SDK start: At SDK start, a unique config file per package name is fetched our server:
  • Fixed an issue that prevented to display a log informing when no config file is created for the package name
  • Changed the config retrieval logic to respect package name case-sensitivity (we used to lower case package name)
  • Dagger dependency: Updated from 2.25 to 2.31.2
  • Misc: Minor improvements and bug fixes.
4.0.0 - 2020.10.29
  • In-app features activation: A simpler and unified way to enable features living inside the SDK (Snapshot Capture & Logs) along with its tracking capabilities. Enable in-app features section
  • Snapshot: Introducing static snapshot to workaround edge cases where snapshots are not rendered properly. See Static snapshot section](/android/#static-snapshot)
  • Webview: Minor improvement to enable webview zoning analysis

Upgrading from a previous version: Update the dependency to point to com.contentsquare.android:library:4.0.0 and make sure to remove the code snippet from your AndroidManifest.xml that was used to enable snapshot mode.

3.2.0 - 2020.07.30
  • Drop support for Android 4.0.3 (API Level 15). Minimum supported version is now Android 4.1 (API level 16).
  • Snapshots: Improved support for screen with SwipeRefreshLayout
  • Dynamic Variables: Key & value are now trimmed when maximum length is exceeded. If key or value are empty, the SDK now sends the literal string "cs-empty" instead.
  • Transaction currency: Lower & Uppercase are both supported.
  • Session: Fixed a bug preventing a session to be closed when app was killed. This led to following session to be discarded.
  • Minor improvements and bug fixes.
3.1.0 - 2020.04.15
  • New logs: This version brings completely redesigned logs for better understanding of the SDK behavior. See dedicated section Debugging & logging.
  • Enable Logging via ADB SHELL on all Android versions
  • Minor improvement related to Screenview tracking on React Native apps
  • Minor improvements and bug fixes
3.0.0 - 2020.03.20
  • Breaking change: the main class ContentSquare is renamed Contentsquare (lower-case s).
  • Snapshot mode: Now you can display the Snapshot Activation Dialog using a deep link. See the dedicated section Deep Link to trigger the Snapshot Activation Dialog.
  • Track Transactions - Currency: We now provide the ability to pass the currency as an "alphanumeric code" (i.e. "USD") on top of the "numeric code" (i.e. "840"). See the dedicated section Track transactions.
  • Fixed an issue where SDK version was not properly set
  • Minor improvements and bug fixes
2.3.1 - 2020.03.03
  • Gesture tracking: Fix an issue with Android Toolbar
2.3.0 - 2020.01.27
  • Enable Logging via ADB SHELL (Logging support for Android 10)
  • App hide event is now triggered 700ms after the application is put in background (before it was 5 seconds)
  • Snapshot improvements for webViews
  • Add validation for dynamic variables key and value length
  • Remove the rule that prevents to have 2 consecutive screenview events with the same screen name
  • Renamed the Pause tracking API to Stop tracking API
  • Minor improvements and bug fixes
2.2.1 - 2019.11.19
  • Fixing theme issue conflict on Snapshot Mode
2.2 - 2019.10.02

/!\ This version is the first one not supporting Android Support (AndroidX only). If you are still using Android Support, please use version 2.1.3.

  • Dynamic Variables: Send custom data to Contentsquare for session segmentation. Dynamic Variables API
  • Snapshot mode launched at App start: No need to shake the device to trigger Snapshot Mode dialog. Benefits: works on a simulator and avoids conflict with features bases on shake detection.
  • RecyclingViews tracking: We improve the gestures tracking accuracy for those elements.
  • Minor improvements & bug fixes
2.1.3 - 2019.09.30

/!\ This version is the last version supporting Android Support. Upcoming versions will only support AndroidX.

  • Track screens: Implement the new Track Screen API to accurately track screen_view events for all your app screens.
  • User Consent required by default: The default privacy setting for every new app will be set to opted-out by default. This means every new user will be opted-out until the Opt-in API will be called. See dedicated documentation section.
  • Workaround on an issue caused by the New Relic SDK
  • Snapshots improvements
  • Minor improvements & bug fixes
Versions 2.1.0 to 2.1.2 were pre-released only.
2.0.1 - 2019.07.04
1.6.3 - 2019.03.07
  • Minor improvements & bug fixes
1.6.2 - 2019.02.28
  • Minor improvements & bug fixes
1.6.1 - 2019.02.18
  • Minor improvements & bug fixes
1.6 - 2018.11.09
  • Add screen URL customization.
  • Change the transaction API packages: If you were already using this feature, please update the import in your code.
    • Changed Transaction class path from com.contentsquare.android.internal.api.Transaction to the com.contentsquare.android.api.Transaction
    • Change the Currencies class path from com.contentsquare.android.internal.api.Currencies to the com.contentsquare.android.api.Currencies
  • Minor improvements
1.5.1 - 2018.10.18
  • Minor bug fix
1.5 - 2018.10.15
  • Add Flush event requests on app hide
  • Change OS version tracking: now collecting OS version 8.0 instead of Android API Level
  • Change Device info tracking: now collecting Device manufacturer and Device Model in 2 distinct fields (dmaet dmo)
  • Improve around gesture tracking on unresponsive views
  • Minor improvements & bug fixes
1.4 - 2018.07.26
  • Add Send transactions: Transactions events can now be sent using the dedicated public API. See dedicated documentation section
  • Add screen density tracking: stored in the request meta data. Its values can vary between (0.75 and 10).
  • Improvements & bug fixes
1.3.1 - 2018.05.30
  • Minor improvements & bug fixes
1.3 - 2018.05.29
  • Add Privacy Handling Public API: SDK is now GDPR compliant and offers public APIs handling privacy.
  • Improvements & bug fixes

iOS Native SDK

💡

Get notified of updates by subscribing to 📬 release notifications.

See also: iOS SDK Documentation

4.14.0 - 2022.06.08
  • Session Replay: Add new high-level APIs to ease the masking implementation: 'maskTexts', 'maskImages', 'maskTextInputs' See the Session Replay Data Masking section
  • Session Replay: SwiftUI is now fully supported in Session Replay ; all SwiftUI elements are properly recorded
  • Session Replay: Fix a bug where the session recording wouldn't stop when Contentsquare.stopTracking() is called
  • Snapshots: Fix a bug where webviews would have incorrect position
  • Misc: Improvements & bug fixes
4.13.0 - 2022.05.05
  • Session Replay: Add a new API 'setDefaultMasking' to ease the masking implementation See the Session Replay Data Masking section
  • Session Replay: Add a new event in the replay when the quality of the recording has changed
  • Session Replay: Add new events in the replay when the recording starts and stops
  • Session Replay: Fix a bug where the session recording wouldn't start as expected
  • WebViews tracking: Update of the WebViews injection mechanism to support new events sent by the WebView Tracking Tag (Dynamic variable, Transaction, Optin, Optout) See the WebView Tracking Tag documentation
  • Misc: Improvements & bug fixes
4.12.0 - 2022.04.05
  • Contentsquare visual identity: Updated Contentsquare logo and snapshot button to match the new visual identity
  • Snapshots: More accurate message displayed in case of error.
  • Session Replay: Add feature to select different quality levels for Wi-Fi & Cellular See the Session Replay Quality Levels section
  • Session Replay: Fix a bug where the session number would not be correctly incremented.
  • Session Replay: Fix a bug where the session replay link would be erroneous.
  • Session Replay: Misc improvements & bug fixes
4.11.0 - 2022.02.04
  • Session Replay: Data consumption optimisation on scrollable views; Fixed an issue where sessions were wrongly flagged as recorded.
  • Included in tracking: When in-app features is enabled, the device is now always included in tracking.
  • Manual Integration: Updated process for dynamic & static linking. See "Manual Integration" in How to include it section
  • Misc: Minor improvements and bug fixes.
4.10.1 - 2022.01.14
  • Static Framework: Fixed an error when uploading app to App Store Connect.
  • Manual Integration: Our SDK can be integrated manually.
4.10.0 - 2021.12.13
  • SDK Version: Fixed a bug caused by a new Xcode option introduced in version 13 called “Manage Version and Build Number”, enabled by default in the App Store distribution process. This option is overriding the SDK version with the application version.
  • Static Framework: Fixed a build error when code coverage is disabled. Manual Install is not supported anymore, please use Swift Package Manager or CS_iOS_SDK_STATIC instead. See How to include it section.
  • Framework: Fixed a warning in Xcode 13 and newer.
  • Session Replay: Added a screenview event to assign inactivity period to the right screen.
  • Network connectivity: Now able to identify 5G network.
4.9.0 - 2021.11.04
4.8.0 - 2021.10.06
  • Session Replay: Minor improvements around fidelity and start logic.
  • Misc: Minor improvements and bug fixes.
4.7.0 - 2021.09.22
  • ⚠️ SDK now uses XCFrameworks for Carthage: please follow this guide to migrate from framework bundles to XCFrameworks.
  • ⚠️ Added Swift Protobuf dependency: If you are using Carthage or static framework, please follow the dedicated documentation to add this dependency to your project. More info on Swift Protobuf.
  • Xcode Compatibility: From this version, the SDK only works with Xcode 12.5 and newer.
  • Disable Session Replay for specific app versions: Introducing capability to disable Session Replay for specific app versions (controlled from back office).
  • Session Replay improvements: Optimisations around data format, storage and sending strategy; Fidelity improvements (dialogs, text, buttons).
  • Fixed Session Replay issue when using Simulator: causing the data to be sent on the wrong endpoint.
  • Fixed Session Replay bug: causing a crash with WebKit in some cases.
  • Misc: Minor improvements and bug fixes.
4.6.1 - 2021.08.31
  • Misc: Minor improvements and bug fixes.
4.6.0 - 2021.08.10
  • Disable auto-start: Option to start the SDK in a manual method instead of starting automatically. Check out the Manual Start section
4.5.0 - 2021.07.26
  • Session Replay: Fidelity improvements; Improved data sending for better performances; supports keyboard display;
  • Stability: Fixed a crash caused by Session Replay code in edge cases.
  • Misc: Minor improvements and bug fixes.
4.4.0 - 2021.06.23
  • Session Replay: Fidelity improvements; displays when app is put in background; when anonymized, text is now replaced by lalala; ability to send data over cellular network (if feature is enabled); requests are now compressed; replay link button added to in-app features settings.
  • In-app features: Fixed a bug that caused in-app features enabling to fail the first times.
  • Misc: Minor improvements and bug fixes.
4.3.1 - 2021.06.03

React Native related: Fixed a bug on alerts impacting iOS app running with React Native 0.64+. WebViews: Fixed a potential issue related to WebViews management.

4.3.0 - 2021.05.26
  • Session Replay: We now support dialogs and device orientation (landscape mode); fidelity improvements & bug fixes; mask/un-mask types from in-app features settings;
  • Snapshot button: Fixed an issue that made the button disappear on long press
  • Snapshot: Display error message when capturing snapshot before screenview
  • Track screen: when API called but no screen name is pushed, the SDK will use a default value “missing screenName” with the name of the View Controller.
  • Logs: Logs intended for Contentsquare SDK developers (Verbose) are now hidden to make it less confusing, it means you can now simply filter on CSLIB. We also improved logs to debug WebView tracking.
4.2.0 - 2021.03.12
  • Session Replay: Session Replay feature is now part of the SDK and disabled by default. This feature is only accessible to customers participating in the Early Access program. For more information reach out to your Contentsquare contact.
4.1.0 - 2021.01.21
  • Snapshot capture: Fix a bug causing the app to crash when capturing a snapshot in an edge case scenario.
  • Snapshot capture: Screen name is now displayed when capturing a snapshot (on the "snapshot in progress/success/fail" screens)
  • WebView: WebView tracking back-office setting has been removed. WebView tracking is now always enabled.
  • Misc: Minor improvements and bug fixes.
4.0.1 - 2021.01.11

Session: Corrected a bug preventing a session to end because of a dynamic variable triggered before App Start.

4.0.0 - 2020.10.28
  • In-app features activation: A simpler and unified way to enable features living inside the SDK (Snapshot Capture & Logs) along with its tracking capabilities. See Enable in-app features section
  • Webview: Minor improvement to enable webview zoning analysis
  • Snapshot: Minor improvement for handling clipped views

Upgrading from a previous version: Make sure to remove the snapshot mode flag (Contentsquare.enableSnapshots = true) used to enable snapshot mode and to implement in-app features.

3.2.1 - 2020.08.26
  • Disable logs & clipboard access on iOS 14: The upcoming iOS 14 will embark a banner notifying users when apps are accessing the clipboard. To prevent this to happen, Logs are disabled on iOS 14. See Note about iOS 14.
3.2.0 - 2020.07.27
  • Drop support for iOS 9. Minimum support version is now iOS 10. See Compatibility section
  • Dynamic Variables: Key & value are now trimmed when maximum length is exceeded. If key or value are empty, the SDK now sends the literal string "cs-empty" instead. See Dynamic Variables section
  • Transaction currency: Lower & Uppercase are both supported.
  • Snapshots: Improvements for React Native screens and snapshot size
  • Logs: Some improvements for logs.
  • SwiftUI Support: Now providing official support for SwiftUI (Snapshot Mode, gestures tracking, etc.)
  • Minor improvements and bug fixes.
3.1.1 - 2020.04.07
  • Minor bug fix
3.1.0 - 2020.03.30
  • New logs: This version brings completely redesigned logs for better understanding of the SDK behavior. See dedicated section Debugging & logging.
  • Enable Snapshot Mode: New name for the API allowing for Snapshot Mode enablement: enableSnapshot. The previous API isDebug is now marked as deprecated. See dedicated section.
  • Snapshot Button: Fix issue related to snapshot button disappearing in some situations: behind a modal, after keyboard displayed, etc.
  • Dynamic Variables: The API is now available in Objective-C. This is also a pre-requisite for React Native support.
  • Track Transactions - Currency: We now provide the ability to pass the currency as an "alphanumeric code" (i.e. "USD") on top of the "numeric code" (i.e. "840"). See the dedicated section Track transactions.
  • Minor improvements & bug fixes
3.0.0 - 2020.01.15
  • Breaking change: the main class ContentSquare is renamed Contentsquare (lower-case s) and the framework is now called ContentsquareModule. If you are updating from a previous version, take a look at the "<= 2.2.2" documentation version: Updating from <=2.2.2 to >=3.0.0.
  • Gesture tracking: now using the native system gesture recognizer
  • Performance improvements: Impact on CPU has been reduced. See Impact on performances section.
  • Xcode/Swift Compatibility: From this version, the SDK will be compatible with all future Swift versions
  • Dynamic Variables: Enforce limitation for the key and value length.
  • Minor improvements and bug fixes
  • Static framework is now available. See Using the static framework (manual install) tab in the "Add Contentsquare to your app" section.
2.2.2 - 2019.11.20
  • Adding support to Swift 5.1.2 and Xcode 11.2

/!\ This version does not support previous Xcode versions.

2.2.1 - 2019.10.11
  • Improvement around events storage management when the device storage is full
2.2 - 2019.09.26
  • Dynamic Variables: Send custom data to Contentsquare for session segmentation. Dynamic Variables API
  • Snapshot mode launched at App start: No need to shake the device to trigger Snapshot Mode dialog. Benefits: works on a simulator and avoids conflict with features bases on shake detection.
  • CollectionView & TableView tracking: We improve the gestures tracking accuracy for those elements.
  • Support for Swift 5.1 and Xcode 11
  • Use lower priority QoS for event requests
  • Minor improvements related to snapshots
2.1.3 - 2019.08.07
  • Minor improvement to prepare transaction API support for React Native.
2.1.2 - 2019.07.29
  • Another minor improvement to make our SDK compatible with other SDKs.
2.1.1 - 2019.07.19
  • Minor improvement to make our SDK compatible with other SDKs.
2.1 - 2019.06.12
  • Track screens: Implement the new Track Screen API to accurately track screen_view events for all your app screens.
  • User Consent required by default: The default privacy setting for every new app will be set to opted-out by default. This means every new user will be opted-out until the Opt-in API will be called. See dedicated documentation section.
  • Swift 5 support
  • XCode 10.2 support
  • Snapshots improvements
  • Add support for HKD currency when tracking Transactions
  • Other minor improvements & bug fixes
    2.0 - 2019.03.20
  • Add screen URL customization
  • URL structure change: added the screen title in the query parameter to match a standard format between iOS and Android
  • Snapshot mode: See dedicated documentation sections: iOS and Android
  • WebView tracking: See dedicated documentation sections: iOS and Android

  • Screen snapshot quality improvements

  • Minor improvements & bug fixes
1.0.6 - 2018.12.06
  • Minor improvements & bug fixes
1.0.5 - 2018.11.22
  • Minor improvements & bug fixes
1.0.4 - 2018.11.15
  • Change screen elements identification (target view path collected with gestures).
1.0.3 - 2018.11.01
  • Add Xcode 10.1 support
  • Fixed integration bug related to private modules
1.0.2 - 2018.10.22
  • Minor improvements & bug fixes
1.0.1 - 2018.10.18
  • SDK is now available on CocoaPods & Carthage
  • Minor improvements & bug fixes
1.0 - 2018.09.14
  • iOS SDK 1st version

React Native Bridge

💡

Get notified of updates by subscribing to 📬 release notifications.

See also: React Native SDK Documentation

2.6.0 - 2022.05.10
2.5.3 - 2022.04.19
  • Fix unreliable web view injection.
  • Official support for React Native up to 0.67.x
2.5.2 - 2022.2.16
  • Fixing a crash caused by webviews in some specific cases.
2.5.1 - 2022.1.21
2.5.0 - 2022.1.18
2.4.0 - 2021.11.18
2.3.0 - 2021.09.02
2.2.1 - 2021.07.08
2.2.0 - 2021.06.28
2.1.0 - 2021.03.11
2.0.0 - 2020.11.03
1.1.1 - 2020.08.26
1.1.0 - 2020.08.21
1.0.0 - 2020.04.23
  • The bridge is now available at @contentsquare/react-native-bridge.
  • The Bridge uses Android native SDK 3.1.0 & iOS native SDK 3.1.1
  • Bridge only supports React Native >=0.60
  • Dynamic Variables are supported

[tabend]

Flutter plugin

💡

Get notified of updates by subscribing to 📬 release notifications.

See also: Flutter SDK Documentation

0.5.1 - 2022.05.30

  • Snapshots:
    • Stability improvement for Navigator pushed screens

0.5.0 - 2022.05.12

  • Snapshots:
    • Fix issue on generating accurate targets for gestures
    • Only include widgets which are currently visible
  • Native SDKs: Android 4.9.0 & iOS 4.13.0

0.4.2 - 2022.04.14

  • Snapshots: Fixed an issue where snapshot captured was not rendering the right screen.
  • Gesture tracking: Fixed an issue on our gesture detector that could cause an exception to be thrown in edge cases.
  • Native SDKs: Android 4.8.0 & iOS 4.12.0

0.4.1 - 2022.03.25

  • Snapshots: Fixed snapshot capture infinite loading on Android caused by WebView; fixed snapshot capture infinite loading on iOS caused by conflict with background_locator plugin; fixed visual bug with the app bar; fixed empty snapshot on iOS related to autostart disabled.
  • Native SDKs: Android 4.8.0 & iOS 4.11.0
0.4.0 - 2022.03.01
  • Crash at app launch on Android: Fixed a bug introduced crashing the app on Android, at app start.
0.3.0 - 2022.02.18
  • Gesture tracking: Gesture tracking optimization; fixed issue preventing scrolling in WebView;
  • Snapshots: Size Optimisation.
  • Native SDKs: Android 4.7.0 & iOS 4.11.0
0.2.3 - 2022.02.07
  • Native SDKs: Android 4.7.0 & iOS 4.10.1
0.2.2 - 2022.01.13
  • Gesture tracking: Fixed performance issue related to gesture tracking
  • Snapshots: Support snapshot capture on iOS
  • Native SDKs: Android 4.3.0 & iOS 4.10.0
0.2.1 - 2022.12.17
  • Gesture tracking: Now support gesture tracking accurately.