Merge pull request #749 from OneSignal/fix/changelog

[Fix] Changelog and migration guide to include push to start live activities feature

Author: shepherd-l

MIGRATION_GUIDE_v3_to_v5.md

@@ -262,6 +262,10 @@ The Live Activities namespace is accessible via `OneSignal.LiveActivities` and p
 | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `Task<bool> EnterAsync(string activityId, string token)` | ***Note:*** *This method is for iOS only<br>Entering a Live Activity associates an activityId with a live activity temporary push token on OneSignal's server. The activityId is then used with the OneSignal REST API to update one or multiple Live Activities at one time.*  |
 | `Task<bool> ExitAsync(string activityId)`                | ***Note:*** *This method is for iOS only<br>Exiting a Live activity deletes the association between a customer defined activityId with a Live Activity temporary push token on OneSignal's server.*                                                                             |
+| `void SetupDefault(LiveActivitySetupOptions options = null)`  | ***Note:*** *This method is for iOS only<br>Enable the OneSignalSDK to setup the default`DefaultLiveActivityAttributes` structure, which conforms to the `OneSignalLiveActivityAttributes`. When using this function, the widget attributes are owned by the OneSignal SDK, which will allow the SDK to handle the entire lifecycle of the live activity.  All that is needed from an app-perspective is to create a Live Activity widget in a widget extension, with a `ActivityConfiguration` for `DefaultLiveActivityAttributes`. This is most useful for users that (1) only have one Live Activity widget and (2) are using a cross-platform framework and do not want to create the cross-platform <-> iOS native bindings to manage ActivityKit.* |
+| `void StartDefault(string activityId, IDictionary<string, object> attributes, IDictionary<string, object> content)`  | ***Note:*** *This method is for iOS only<br>Start a new LiveActivity that is modelled by the default `DefaultLiveActivityAttributes` structure. The `DefaultLiveActivityAttributes` is initialized with the dynamic `attributes` and `content` passed in.* |
+| `void SetPushToStartToken(string activityType, string token)` | ***Note:*** *This method is for iOS only<br>Indicate this device is capable of receiving pushToStart live activities for the `activityType`. The `activityType` **must** be the name of the struct conforming to `ActivityAttributes` that will be used to start the live activity.* |
+| `void RemovePushToStartToken(string activityType)`            | ***Note:*** *This method is for iOS only<br>Indicate this device is no longer capable of receiving pushToStart live activities for the `activityType`. The `activityType` **must** be the name of the struct conforming to `ActivityAttributes` that will be used to start the live activity.* |
 
 
 ### Debug Namespace

OneSignalExample/Assets/OneSignal/CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 ## [5.1.7]
 ### Changed
+- Updated SDK to support Live Activities PushToStart and added a concept of a "Default" Live Activity to facilitate easier adoption. Please check out https://documentation.onesignal.com/docs/push-to-start-live-activities for more information and our [example app](https://github.com/OneSignal/OneSignal-Unity-SDK/tree/main/OneSignalExample) for an example implementation.
 - Updated included Android SDK from 5.1.13 to [5.1.17](https://github.com/OneSignal/OneSignal-Android-SDK/releases/tag/5.1.17)
   - Fixed Xiaomi notification click not foregrounding app
   - Fixed FCM push token not being refreshed