Skip to content

Release 5.2.0

Compare
Choose a tag to compare
@github-actions github-actions released this 31 May 22:02
· 16 commits to main since this release
a816d7a

No native changes in this release

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 #997

✨ Ionic Capacitor Example App

A new Ionic Capacitor app using the React framework has been added to this repository.

Adding an integrated example app with User Model methods and an automatic linked dependency to the SDK will allow for easy testing of our Cordova SDK as well as method implementation examples.

A new directory, /example has been added to the Cordova SDK.

From this directory, the example app can be opened by running:

ionic capacitor run android

ionic capacitor run ios

Full Changelog: 5.1.4...5.2.0