fix(badges): drop deprecated applicationIconBadgeNumber usage #1568
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
One Line Summary
Drop usage of deprecated
applicationIconBadgeNumber
API, and support usage of replacementsetBadgeCount
API (with no getter).Details
Motivation
Reports of the SDK's usage of
applicationIconBadgeNumber
is causing apps to hang: #1452Scope
Note the biggest change is we lose some ability to get the most accurate badge count at any moment. This should be mitigated overall as we swizzle both badge setting methods that developers would call (old and new) to update our cached value. Additionally, we will store a previous badge count as well for cases where a notification display event is cancelled, so we can revert our cached badge count to be accurate.
New class
OneSignalBadgeHelpers
in OneSignalCore and move a method to cache badge count out of OneSignalExtension and into that classSupport new
setBadgeCount
API on iOS 16+.applicationIconBadgeNumber
is deprecated in iOS 17 - see https://developer.apple.com/documentation/uikit/uiapplication/applicationiconbadgenumber. Its replacement issetBadgeCount:withCompletionHandler:
(https://developer.apple.com/documentation/usernotifications/unusernotificationcenter/setbadgecount(_:withcompletionhandler:)?language=objc) but there is no equivalent getter.Remove all usages of deprecated applicationIconBadgeNumber
Testing
Unit testing
None
Manual testing
iPhone 13 iOS 18.5
setBadgeCount
and check SDK swizzling and cachingAffected code checklist
Checklist
Overview
Testing
Final pass
This change is