[CHNL-12942] Create a hook to reset badge counts

[belleklaviyo]

Description

These changes introduce a new setter setBadgeCounton the SDK. By default this setter will be called on every foreground event to clear it/set the badge count to 0 and controlled by the Klaviyo_badge_autoclearing flag in the plist, configurable by the developer. The badge count will also be synced with the cached count we track in the App Group User Defaults (to be explained in the updated README instructions). If devs so want to disable the autoclearing and call the setter themselves, they can do so like KlaviyoSDK().setBadgeCount() after initialization.

Small note: Are we ok with the name setBadgeCount, there is the method on UNUserNotificaitonCenter with the same name.

Check List

• Are you changing anything with the public API?
• Have you tested this change on real device?
• Are your changes backwards compatible with previous SDK Versions?
• Have you added unit test coverage for your changes?
• Have you verified that your changes are compatible with all the operating system version this SDK currently supports?

Manual Test Plan

Note: this test plan worked fine on device, but did not auto clear on simulator

Default behavior

1. Add Klaviyo_badge_autoclearing to the target app Info.plist as a Boolean and set it to YES
2. Send some notification from Push Notification Console to populate the badge count (i.e. badge = 3 in payload) with the app in the background and observe badge of 3
3. Open the app
4. Close the app and observe badge cleared to 0

Default behavior turned off

1. Set in the Info.plist the Klaviyo_badge_autoclearing key is set to NO
2. Send some notification from Push Notification Console to populate the badge count (i.e. badge = 3 in payload) with the app in the background and observe badge of 3
3. Open the app
4. Close the app and observe badge is still 3

Custom call with default clearing turned off

1. Add KlaviyoSDK().setBadgeCount(0) to some button or trigger in the app
2. Send some notification from Push Notification Console to populate the badge count (i.e. badge = 3 in payload)
3. Observe when reset method is triggered the badge count is reset to 0

Supporting Materials

[jasper-hsu-kyvo]

Looks good to me, however adding Andrew to the review because he knows way more about the SDKs than I do (so won't approve sorry) - also looks like you need to rerun pre-commit though and have a formatting issue.

[ab1470]

Just wondering, why do we need to persist the current badge number to UserDefaults?

[ab1470]

Also, I think we'll want to get have some unit tests for these changes

[belleklaviyo]

Just wondering, why do we need to persist the current badge number to UserDefaults?

this is necessary for how we are going to keep track and increment the badge count, details here but still some things up in the air, might convert to a draft PR in the meantime

[ajaysubra]

LGTM, minor comments from Noah and I.

[ab1470]

LGTM! Nice work.

[ajaysubra]

Minor nit picks else LGTM.

[ajaysubra]

if we are unable to get the plist value we assume that they want to auto clear? I think this is fine but might be good to callout in the readme.

[ajaysubra]

Should we mention something about how/why this value is used?