Release 5.2.0

What's New

🎉 Push to Start Live Activities

Starting with iOS 17.2, Live Activities can now be started via push notification (Apple's documentation). This change enhances the OneSignal SDK to provide application's access to the full suite of Live Activity functionality.

To use Push To Start Live Activities, see documentation on How to start a Live Activity with a remote push notification.

Default Live Activity
The concept of a "Default" Live Activity has been established in the SDK, which eliminates the need for a customer app to define and manage their own ActivityAttributes. The primary use case of the "Default" Live Activity is to facilitate easier cross-platform adoption.

• A new function OneSignal.LiveActivities.setupDefault() which tells the OneSignal SDK to manage the LiveActivity lifecycle for the DefaultLiveActivityAttributes type. When calling this method, a customer can use both push-to-start and push-to-update notifications to start/update/end their Default Live Activity.
• A new function OneSignal.LiveActivities.startDefault(activityId, activityAttributes, initialContentState) which allows a customer app to start a live activity based on the DefaultLiveActivityAttributes type "in app".

Four New APIs for Live Activities

OneSignal.LiveActivities.setupDefault()
OneSignal.LiveActivities.startDefault(activityId, activityAttributes, initialContentState)
OneSignal.LiveActivities.setPushToStartToken(activityType: string, token: string)
OneSignal.LiveActivities.removePushToStartToken(activityType: string)

Please see the PR description for more details.

• Push to start live activities added to the SDK (#1701)

🔧 Native SDK Dependency Updates

Update Android SDK from 5.1.10 to 5.1.13

• For full changes, see the native release notes
  🐛 Bug Fixes
• [Fix] grouping skipping opRepoPostCreateDelay, causing operations being applied out of order when multiple login operations are pending. (fixes issue since 5.1.10) (2087)
• [Fix]: Cancelling permission request dialog does not fire continuation (2085)
• [Fix] RecoverFromDroppedLoginBug not running in very rare cases (2084)
• Fix the ANR issue caused by prolonged loading of OperationRepo and potentially by extended holding of the model lock during disk I/O read operations. (2068)
  🔧 Maintenance
• Add HTTP header OneSignal-Install-Id that allows the OneSignal's backend know where traffic is coming from (2072)

Update iOS SDK from 5.1.6 to 5.2.0

• 5.2.0 Release Notes
• ✨ Privacy Manifest Improvements
• 🐛 [Bug] Fix rare scenario of dropping data when multiple logins are called (1427)

Release 5.1.3

What's Changed

• 🐛 Enforce tag value string conversion #1696

🔧 Native SDK Dependency Updates

Update Android SDK from 5.1.9 to 5.1.10

• 5.1.10 release notes
• 🛠️ Added additional Network call optimizations
• 🐛 Handle incorrect 404 responses; add a delay after creates and retries on 404 of new ids #2095

Update iOS SDK from 5.1.5 to 5.1.6

• 5.1.6 Release Notes
• 🐛 Bug Fixes
  • Fix crashes when encoding user models #1412
  • Some pending properties can be sent to new user, when users change quickly after the last updates are made (#1418)
  • Fix crash in OneSignalAttachmentHandler trimURLSpacing method (#1411)
  • Fix crash when handling a dialog result when stack traces point to delayResult (#1417)
  • [Bug] Remove IAM window when an in app message is inactive (#1413)

Full Changelog: 5.1.2...5.1.3

Release 5.1.2

🔧 Native SDK Dependency Updates Only

Update Android SDK from 5.1.8 to 5.1.9

• 5.1.9 release notes
• Added Network call optimizations
• Fix for WorkManager not initialized crash
• Added AndroidManifest options to override In-App Messages gray overlay and dropshadow

<meta-data android:name="com.onesignal.inAppMessageHideGrayOverlay" android:value="true"/>
<meta-data android:name="com.onesignal.inAppMessageHideDropShadow" android:value="true"/>

Update iOS SDK from 5.1.4 to 5.1.5

• 5.1.5 Release Notes
• ✨ In-App Message Enhancements:
  • The status bar will be hidden on full-bleed In-App Messages
  • Add back the dropshadow on In-App Messages and include a plist option to disable it
  • Add plist option to override and hide the gray overlay to In-App Messages

OneSignal_in_app_message_hide_gray_overlay
OneSignal_in_app_message_hide_drop_shadow

Release 5.1.1

🔧 Native SDK Dependency Updates Only

Update Android SDK from 5.1.6 to 5.1.8

• Fix crash with EventProducer's fire events in OneSignal/OneSignal-Android-SDK#2034
• 🔋 Battery improvements
  • Possibly resolves issues of "Egregious levels of battery drain"
  • Prevent OperationRepo from continuously pulling when empty (OneSignal/OneSignal-Android-SDK#2033)
  • Add backoff to OperationRepo when retrying network calls (OneSignal/OneSignal-Android-SDK#2017)
  • Limit refresh User and GET IAMs to foreground (OneSignal/OneSignal-Android-SDK#2036)
• Fixes network call batching not waiting the full 5 seconds in most cases to reduce the total number of REST API calls to OneSignal.
• Issue with external_id being skipped and updates stop if something updates the User (such as addTag) shortly before login is called OneSignal/OneSignal-Android-SDK#2046
• For full changes, see the native release notes

Update iOS SDK from 5.1.3 to 5.1.4

• 5.1.4 Release Notes
• The XCFrameworks in this release is signed to help keep your apps secure
• Fix rare scenario where login requests are stuck and prevent the SDK from making updates (OneSignal/OneSignal-iOS-SDK#1398)

Release 4.5.3

What's Changed

• Updated included Android SDK from 4.8.6 to 4.8.8
  • For full changes, see the native release notes
• Updated included iOS SDK from 3.12.6 to 3.12.9
  • Added privacy manifests
  • For full changes, see the native release notes

Release 5.1.0

What's Changed

🎉 New Methods 🎉

• Add getter for onesignalId and externalId and a UserState Observer to be notified of changes in [#1627]
  • See the User Namespace API Reference in the Migration Guide for usage
• Add asynchronous getter methods for Notifications permission and Push Subscription token, id,optedIn in [#1649]
  • 🛑 Deprecated methods 🛑
    • Notifications.hasPermission, User.pushSubscription.id, User.pushSubscription.token, and User.pushSubscription.optedIn are now deprecated but non-breaking.
  • See the Push Subscription Namespace API Reference and Notifications Namespace API Reference in the Migration Guide for usage of new methods getPermissionAsync, getIdAsync, getTokenAsync, and getOptedInAsync.

⚠️ Minor Breaking Change ⚠️

• API update for PushSubscriptionState: the Push Subscription observer will now be passed nullable properties. Please account for the possibility of the push subscription token and id being null.

Native Changes

• Bump Android Native Version to 5.1.6
• Bump iOS Native Version to 5.1.3

Full Changelog: 5.0.6...5.1.0

Release 5.0.6

What's Changed

Bug Fixes

• fix/error removing handlers when SDK is not initialized #1639

Native SDK Updates

• Bump Android Native Version to 5.1.4

Full Changelog: 5.0.5...5.0.6

Release 5.0.5

What's Changed

⚠️ Behavior Changes ⚠️

• Location sharing with OneSignal now defaults to false: You will need to explicitly enable location sharing with OneSignal with OneSignal.Location.setShared(true)

Native SDK Updates

• Bump iOS Native Version to 5.1.0
• Bump Android Native Version to 5.1.2

Full Changelog: 5.0.4...5.0.5

Release 5.0.4

What's Changed

• Fix: prevent addNotificationForegroundLifecycleListener getting called multiple times - #1601
• Add public getTags method - #1609

Native SDK Updates

Update Android SDK to 5.0.5

Update iOS SDK to 5.0.5

Release 5.0.3

What's Changed

• Fix requestPermission to return false when permission is denied in #1591

Native SDK Updates

Update Android SDK to 5.0.4

• Update PropertiesModel's deserialization of tags to not use Model.initializeFromJson in OneSignal/OneSignal-Android-SDK#1884
• Retrieve current ADM PurchasingListener assuming it returns a nullable. in OneSignal/OneSignal-Android-SDK#1888
• Fix: Add synchronized blocks to prevent ConcurrentModificationException in OneSignal/OneSignal-Android-SDK#1876
• Update work-runtime dependency version in OneSignal/OneSignal-Android-SDK#1890
• General protection against exceptions that occur on a thread. in OneSignal/OneSignal-Android-SDK#1887

Update iOS SDK to 5.0.3

• Fix badge clearing when calling clearAll in OneSignal/OneSignal-iOS-SDK#1335
• Fix crash with direct influence but nil direct id OneSignal/OneSignal-iOS-SDK#1327
• Fix forwarding notification opens from non onesignal notifs OneSignal/OneSignal-iOS-SDK#1326

Full Changelog: 5.0.2...5.0.3