iOS SDK

Changelogs 2024

SDK v6.13.1 (Nov 11, 2024)

• Bug fixes and optimizations.

SDK v6.13.0 (Oct 25, 2024)

• Support for Lists in SDK based campaigns

SDK v6.12.0 (Oct 7, 2024)

• Added deeplink retrieval function.
• Bug fixes and optimizations.

SDK v6.11.0 (Aug 9, 2024)

• Added support for InApp Testing

SDK v6.10.0 (July 11, 2024)

• Network Interceptor Support
• Code signing fix.

SDK v6.9.0 (June 14, 2024)

• Separated Location Module.
• Improved Event Syncing.
• Token Personalization Bug fix.
• Added Code Signature.

SDK v6.8.2 (June 10, 2024)

• Thread Safety Improvements.

SDK v6.8.1 (April 29, 2024)

• Major crash fixes : Enumeration on MultiThreads.
• Privacy Manifest Tracking bug fixes.

SDK v6.8.0 (April 24, 2024)

• Support added for setting proxy URL.

SDK v6.7.1 (April 22, 2024)

• Optimizations to use Off-site surveys within In-app notifications.

SDK v6.7.0 (April 9, 2024)

• Support for tracking application events for In-App Notification with JS.

SDK v6.6.2 (April 3, 2024)

• Fixed the app rejection issue due to privacy manifest

SDK v6.6.1 (Jan 12, 2024)

• Bug fixes and minor optimizations.

Changelogs: 2023

SDK v6.6.0 (Dec 21, 2023)

• Added support for KSA environment.
• Optimized SDK authentication flow.
• Fixes and optimizations relation to push impressions and dismiss tracking.

SDK v6.5.0 (Nov 10, 2023)

• Added SDK Lifecycle support.
• Optimized SDK authentication flow.

SDK v6.4.4 (Oct 16, 2023)

• Fixes and optimizations related to App In-line and control group.

SDK v6.4.3 (Sept 6, 2023)

• Bug fixes and minor optimizations.

SDK v6.4.2 (Aug 7, 2023)

• Fixes and optimizations for multi-threading.

SDK v6.4.1 (July 26, 2023)

• Support for iOS 17 beta mode.
• Thread-safety & performance enhancements.
• Improvements and optimization in relation to push notifications.

SDK v6.4.0 (July 20, 2023)

• Viber channel dependencies added.
• Improvements and optimizations in relation to thready-safety and SDK security.
• Push callback improvements.

SDK v6.3.4 (June 26, 2023)

Thread-safety improvements.

SDK v6.3.3 (June 9, 2023)

Bug fixes and optimizations related to Multi-threading.

SDK v6.3.2 (May 24, 2023)

Bug fixes and optimizations related to:

• URL encoding
• Custom and Date attribution tracking
• Null check handling for JWT token

SDK v6.3.1 (April 3, 2023)

• Bug fixes and optimization related to user logout.

SDK v6.3.0 (April 27, 2023)

• Support for Notification Inbox APIs added.
• Added JWT based optional authentication security layer within the SDK

SDK v6.2.1 (April 13, 2023)

• Support added for App In-line Content on React Native.
• Added provider type APNs in Push Subscribe event
• Bug fixes and improvements in relation to NSDate crash in custom events and clearing page view counts in a session

SDK v6.2.0 (Mar 24, 2023)

• Support added for App In-line Content on Flutter.
• App In-line campaigns are now supported on List view screens

SDK v6.1.1 (February 27, 2023)

• Optimization related to Swift interface issues and Event based campaigns added

SDK v6.1.0 (January 31, 2023)

• Added support for Universal Control Group and Custom Control Group

Changelogs 2022

SDK v6.0.1 (October, 2022)

Improvements in location tracking while using latest location API

SDK v6.0.0 (August 23, 2022)

Compatibility with Personalization SDK v1.0.0 added

SDK v5.2.11 (June 8, 2022)

Distributed binaries as XCframeworks in order to support the arm64 simulator slice

SDK v5.2.10 (April 5, 2022)

• Added callbacks on new session creation

SDK v5.2.9 (March 3, 2022)

• Support to configure session timeout limit

Changelogs 2021

SDK v5.2.8 (November 25, 2021)

• SDK initialise status exposed to WebEngage public header
• Support integration of thousands of mobile apps in a single project
  Note: 'WEGAlternateAppSupport' flag that was being used for multi-app support in the same project is deprecated from this version

SDK v5.2.7 (October 1, 2021)

• Support to fetch WebEngage SDK version in Xcode 13

SDK v5.2.6 (April 15, 2021)

• Added support to fetch IDFA automatically if app uses AppTrackingTransparency framework for iOS 14+

• Optimizations related to proper tracking of push impression data

• Bug fixes and improvements

SDK v5.2.5 (Feb 5, 2021)

Improvements for handling lifecycle changes of SceneDelegate

Changelogs 2020

SDK v5.2.4 (Dec 20, 2020)

Removed dependency on IDFA for identifying a device

SDK v5.2.3 (Dec 10, 2020)

Added support for deep linking through universal links

SDK v5.2.1 (March 2, 2020)

Added support for Iran Proxy Environment

Changelogs 2019

SDK v5.2.0 (Dec 27, 2019)

Added support for Landscape Modal In-app Views

SDK v5.1.0 (Dec 11, 2019)

• Added logic to clear cache when License Code is updated

• Updated Minimum Deployment Target to iOS 10

SDK v5.0.2 (Nov 26, 2019)

Added logic to prevent multiple User Attributes updates

SDK v5.0.1 (Nov 4, 2019)

Added reset logic before presenting In-App Notifications

SDK v5.0.0 ( Oct 15 , 2019)

Added support for WhatsApp as an Engagement Channel

SDK v4.9.9 (Oct 4, 2019)

Corrects an issue with WebView on iOS 8 & 9

SDK v4.9.8 (Oct 1, 2019)

Added support for Xcode 11

SDK v4.9.7 (Sep 17, 2019)

Removed accessing Bluetooth services from SDK

SDK 4.9.6 (Sep 10, 2019)

Added support for tracking push delivered event from Extension SDKs

SDK v4.9.5 (Aug 14, 2019)

Corrected screen tracking for React Native based apps

SDK v4.9.4 (Aug 1, 2019)

Corrected location permission behavior when Geofencing is enabled

SDK v4.9.2 (July 16, 2019)

Updated inline header documentation

SDK v4.9.1 (June 26, 2019)

Resolved build warnings in the documentation of public headers

SDK v4.9.0 (June 25, 2019)

Added capability to switch server-side environments in SDK

SDK v4.8.0 (June 14, 2019)

• Optimized In-App view rendering

• Added support for String data type on Mobile WebView Bridge

• Updated Default Notifications Templates Request

SDK v4.7.1 (May 21, 2019)

Resolved IDFA checks when supporting multiple apps

SDK v4.7.0 (May 17, 2019)

Added Manual Integration flow to skip auto-integration

SDK v4.6.0 (May 10, 2019)

Added support for multiple apps using the same license code

SDK v4.5.2 (April 23, 2019)

Resolved a crash occurring on sending incorrect data-type on Login in Mobile Web Bridge

SDK v4.5.1 (April 23, 2019)

Resolved a crash occurring on Screen Data update in Mobile Web Bridge

SDK v4.5.0 (April 12, 2019)

Resolved a crash in Debug Mode faced by React Native based apps

SDK v4.4.0 (Mar 28, 2019)

Added capability to dynamically configure JCX request interval

SDK v4.3.0 (Feb 18, 2019)

Optimized presentation of In-app views

SDK v4.2.2 (February 12, 2019)

Performance improvements and bug fixes

SDK v4.2.1 (Feb 11, 2019)

Performance improvements and bug fixes

SDK v4.2.0 (February 8, 2019)

Corrected an issue related to the incorrect data format in event reporting

SDK v4.1.1 (Feb 7, 2019)

Added debug logs for Mobile Web Bridge integration

SDK v4.1.0 (Jan 28, 2019)

Performance improvements for In-apps presented via Journeys

Changelogs 2018

SDK v4.0.22 (Nov 22, 2018)

Performance improvements and bug fixes

SDK v4.0.21 (Oct 10, 2018)

Fixes In-app notification layout issues on iPhone X and newer models

SDK v4.0.20 (Oct 3, 2018)

Performance improvements and bug fixes

SDK v4.0.19 (Aug 2, 2018)

Performance improvements and bug fixes

SDK v4.0.18 (Aug 1, 2018)

Starts reporting screen data in custom events and App Installed event

SDK v4.0.17 (July 9, 2018)

Fixes a bug related to Event buffering, due to which some users may get error "Failed to delete synced events" while syncing events from WebEngage SDK.

SDK v4.0.15 (May 28, 2018)

WebEngage config files will not get backed up on iCloud.

SDK v4.0.14 (May 18, 2018)

• Adds options to configure automatic location tracking accuracy.

• Adds manual location tracking API.

• Optimizes how geofencing works with respect to resource (battery and data) consumption.

SDK v4.0.13 (May 10, 2018)

SDK tracks Advertising ID and Vendor ID of the device along with other device information.

SDK v4.0.11 (Mar 28, 2018)

Fixes push notification issue in 4.0.10

SDK v4.0.10 (Mar 26, 2018)

(A major issue related to push notifications was detected in this release which was fixed in 4.0.11. Please use version 4.0.11 instead.)

Fixes the issue of push notification click not getting recorded if the UNUserNoticationCenter delegate is set after initializing the SDK. With this change, SDK will function independently of when and if the application uses the UNUserNoticationCenter delegate.

SDK v4.0.9 (Mar 15, 2018)

Added dSYM file of WebEngage framework, to get symbolized crash logs on crash analytics.

SDK v4.0.8 (Mar 1, 2018)

Fixes the locale language issue for iOS devices. With this version, irrespective of the device locale, the location details on the WebEngage dashboard will appear in English only.

Please Note: This feature will work only for iOS version 11.0 and above. If the iOS version of the user is less than 11.0, the location details will be in the same language as that of device language.

SDK v4.0.7 (Jan 22, 2018)

• WKWebView - JavaScript Bridge: Enables handling WebEngage Website SDK calls from iOS WKWebViews.

• Adds support for Push notification clicked and Anonymous ID changed callbacks

Changelogs 2017

SDK v4.0.6 (Dec 11, 2017)

Fixes an issue where Full Page Modal and Page Blocker in-app notification were not rendering in some cases.

SDK v4.0.5 (Dec 6, 2017)

Fixes an issue where some devices were not reachable to receive push notifications due to undetermined status.

SDK v4.0.4 (Nov 30, 2017)

• Fixes an issue where InApp might not get rendered, even if all the rules are satisfied because of other frameworks that manipulate the app's windows.

• Fixes an issue that caused certain rules for InApp Notifications to fail because of encoding issues.

SDK v4.0.3 (Nov 15, 2017)

Fixes a high severity but rare case scenario, where sending malformed pushes can make the apps crash on launch every time.

SDK v4.0.2 (Oct 11, 2017)

• WebEngage is now a Dynamic framework as opposed to a static framework.

• AppStore Size contribution of SDK is now 200-300KB as opposed to approx 1MB before.

• Created a separate pod WebEngageAppEx(https://github.com/WebEngage/WebEngageAppEx) for supporting Rich Pushes, i.e. WebEngage is no more required as a dependency in your Extension Targets.

• Fixed an issue where screen data, was incorrectly being overlapped with custom events data.

• Made changes to support Segment Packaged integration now hosted at https://github.com/WebEngage/analytics-ios-integration-webengage

• Made changes to support XCode, Fixed Thread Checker Issues.

• Optimizations in Event Reporting from SDK in terms of Memory and CPU.

SDK v3.5.9 (Aug 21, 2017)

Fixes a high severity issue where the apps may crash on app launch itself because of high memory consumption.

SDK v3.5.8 (July 13, 2017)

• Removes the need to add the WEG_APP_GROUP key in the Info.plist file for Rich Push Integrations. Refer to <https://docs.webengage.com/docs/ios-10-rich-push-notifications-integration#section-info-plist-changes> for integration docs.

• Fixes a bug that sent duplicate Push Notification Received/ View Event for Star Rating Layout Push.

SDK v3.5.7 (June 29, 2017)

• Fixes a bug that prevented Secondary CTA notifications and Rich Push Notifications to work properly on iOS 10 and above devices when the app uses Manual APNS registration in the WebEngage initialization call and also implements the notifications using the User Notifications Framework introduced in iOS 10.

• Introduces detection and reporting of Push Notification Dismissal system events on iOS 10 and above devices.

• Fixes an issue related to reporting of APP_UPGRADED system event in some cases.

SDKK v3.5.6 (June 13, 2017)

• Fixes a bug associated with reporting of User's hashed_email and hashed_phone attributes.

• Fixes an issue where In-App Notifications with certain complex rules caused memory leaks.

• Changes the way images were handled in Carousel Notifications. The new method introduces more reliability in both delivering the images and purging them after use. In the best case, the unexpanded version of the notification shows a thumbnail image in the unexpanded mode but the expanded Carousel might still work properly even when the unexpanded version fails to add a thumbnail.

• Adds a detailed APNS registration failure logging message for debugging/resolution while integration.

SDK v3.5.4 (May 25, 2017)

• Fixes an issue where in some cases In-App notifications would not work when run as part of the User Journey.

• Adds user email/sms opt-in/opt-out APIs.

• Fixes an issue where push notification clicks were not handled when the push was presented in the foreground and the app implements the NotificationCenterDelegate's userNotificationCenter:willPresentNotification:completionHandler: callback.

SDK v3.5.1 (April 19, 2017)

• Custom title and body bar in Carousel Notifications to enable universal configuration with all layouts including Rating notifications for hiding native display of the same. Refer to <https://docs.webengage.com/docs/ios-10-rich-push-notifications-integration#section-info-plist-changes> before upgrading.

• Several Improvements for Banner Notifications to reliably show up the image as part of the push notification.

SDK v3.4.17 (April 15, 2017)

New Star Rating based Push Notifications Layout

SDK v3.4.16 (Mar 22, 2017)

• Prevents reporting of APNS registration on each app launch by updating and caching the device token registered on the first launch and subsequent ones that change the device token.

• Fixes an issue where the use of certain SDKs for showing small Window notifications(error display etc.) interfered with the rendering of In-App Notifications.

SDK v3.4.14 (Mar 7, 2017)

• Fixes push notification click handling when the push notification is delivered in the foreground.

• Fixes an issue where date attributes were reported erroneously by the SDK for devices with certain regions like UK, France, etc. where the 12-hour date format is the default.

• Deprecates setBirthDate:(NSDate*) WEGUser API in favour of setBirthDateString:(NSString*)

• Adds setAttribute:withDictionaryValue WEGUser API for enabling custom key-value dictionary to be reported as a user attribute.

SDK v3.4.13 (Feb 28, 2017)

Fixes a rare issue where the click and close action of an In-App Notification shown as part of the user journey caused a crash due to faulty data being sent from the backend. The issue is also fixed at the backend while taken care of the crash in the SDK in case the faulty data still appears.

SDK v3.4.12 (Feb 23, 2017)

• Introduces support for Control Groups applied to In-App Notification Campaigns conversion metrics.

• Deprecated WEGUser's loggedIn and loggedOut APIs in favour of login and logout

SDK v3.4.11 (Feb 7, 2017)

Fixes an issue where there were crashes observed if the screen navigation APIs were called multiple times during the rendering of an In-App Notification.

SDK v3.4.9 (Jan 13, 2017)

Fixes an issue where the inclusion of certain other SDKs similar to WebEngage in the App caused some problems in the functionality of WebEngage related to invocation of some system methods.

SDK v3.4.8 (Jan 10, 2017)

Fixes a critical bug that caused erroneous device identifiers to be generated in some rare circumstances that resulted in Push Notifications being sent out to only one of the affected devices while others being eligible as well.

SDK v3.4.7 (Jan 6, 2017)

• Fixes a bug that prevented certain "Regular Expression" based rules to match for In-App Notifications.

• Internal Changes in Carousel Notification Implementation.

SDK v3.4.6 (Jan 3, 2017)

Support for Complex Data Types(Dictionary, Arrays) as part of event data and user attributes.

Changelogs 2016

SDK v3.4.5 (Dec 28, 2016)

Fixes a bug around the integration of SDK.

SDK V3.4.4 (Dec 7, 2016)

• Fixes a bug where casting UIApplication's Delegate to AppDelegate caused an error in the App.

• Reduces one integration step for Rich Push Integration for Carousel Notifications.

• Fixes a bug where Carousel Push Notification on dismissal use to create an unnoticeable crash.

SDK v3.4.2 (Nov 28, 2016)

• Adds the capability of Rich Push Notifications with Banner and Carousel Layouts.

• Fixes a bug where AppDelegate's methods were not being called when WebEngage's SDK was used alongside some other iOS SDKs due to the conflicts in the implementation mechanisms of the two SDKs.

• Fixes a bug related to the close event cycle of In-App Notifications.

• User APIs for Phone, Encrypted Email, and Encrypted Phone Number.

• Fixes an issue where setting a blank string in a custom user attribute caused the SDK to crash.

• Improved Logging

SDK v3.3.7 (Oct 5, 2016)

• Fixes a bug related to device identification.

• Removed support for XCode 6

• Added a fix for a bug in iOS 10.0 where the standard callback for receiving a remote notification was not fired.