📘

Out of Beta

This reference includes changes from version 2 to version 3, including breaking changes.

Read the following reference documentation carefully. If you are migrating from an older version, go through your existing code and cross-reference it with the changes listed in this reference to ensure a smooth migration. Make sure to make all the changes necessary and test them thoroughly.

Notable Changes:

• Initialization is now done differently
• Foreground notification control
• New handlers and observer setters
• getDeviceState to get device info

To report a bug, open a new issue in our public repo.

Initialization

setAppId Function

In version 3, we are simplifying initialization. OneSignal initialization now only requires that you set the application ID.

You can call setAppId at any point in your app's flow. This allows full initialization to be delayed until say, a user logs in.

New Functions

Removed Functions

❗️

In version 3, there are several functions you should remove.

New Functions

Foreground Notification Control

In version 3, you can now specifically read notification data that will display while the app is in focus as well as change the display type dynamically. This allows developers to have even greater control over the notification experience.

Replaces inFocusDisplaying() functionality.

setNotificationWillShowInForegroundHandler Function

Runs before displaying a notification while the app is in focus. Use this handler to decide if the notification should show or not.

Note: this runs after the Notification Service Extension which can be used to modify the notification before showing it (native code).

The callback accepts a parameter OSNotification.

OneSignal.shared.setNotificationWillShowInForegroundHandler((OSNotificationReceivedEvent event) {           
      /// Display Notification, send null to not display, send notification to display           
      event.complete(event.notification);      
});

the callback argument object has two functions:

Handlers

setInAppMessageClickHandler Function

Set the callback to run on an In-App Message click.

OneSignal.shared.setInAppMessageClickedHandler((OSInAppMessageAction action) {
     print('OneSignal: IAM clicked action: ${action}');
});

setOnWillDisplayInAppMessageHandler Function

Set In-App message will display handler whenever the In-app message is about to be displayed

OneSignal.shared.setOnWillDisplayInAppMessageHandler((message) {
      print("OneSignal: On will display In-App message: ${message.messageId}");
 });

setOnDidDisplayInAppMessageHandler Function

Set In-App message did display handler whenever the In-app message is displayed

OneSignal.shared.setOnDidDisplayInAppMessageHandler((message) {
      print("OneSignal: On did display In-App message: ${message.messageId}");
 });

setOnWillDismissInAppMessageHandler Function

Set In-App message will dismiss handler whenever the In-app message is about to be dismissed

OneSignal.shared.setOnWillDismissInAppMessageHandler((message) {
      print("OneSignal: On will dismiss In-App message: ${message.messageId}");
 });

setOnDidDismissInAppMessageHandler Function

Set In-App message did dismiss handler whenever the In-app message is dismissed

OneSignal.shared.setOnDidDismissInAppMessageHandler((message) {
      print("OneSignal: On did dismiss In-App message: ${message.messageId}");
 });

setNotificationOpenedHandler Function

Set the callback to run on notification open/click.

OneSignal.shared
        .setNotificationOpenedHandler((OSNotificationOpenedResult result) {
    print('"OneSignal: notification opened: ${result}');
});

openedEvent fields:

Observers

Each callback you pass to an observer adder function will receive a state change object when fired that contains two parameters: to and from. The parameters on those objects are the same between the two. This format allows for the detection of the previous state and the new state.

Example: a change in the subscription state of the device might see the isSubscribed parameter change from false to true. You can detect the change by the event.from.isSubscribed and event.to.isSubscribed objects.

setPermissionObserver Function

Add a callback that fires when the native push permission changes.

Change event parameters:

setSubscriptionObserver Function

Add a callback that fires when the OneSignal subscription state changes.

Change event parameters:

setEmailSubscriptionObserver Function

Add a callback that fires when the OneSignal email subscription changes.

Change event parameters:

Example

OneSignal.shared.setPermissionObserver((OSPermissionStateChanges changes) {
      print("OneSignal: permission changed: ${changes.jsonRepresentation()}");
    });

OneSignal.shared
        .setSubscriptionObserver((OSSubscriptionStateChanges changes) {
      print("OneSignal: subscription changed:: ${changes.jsonRepresentation()}");
    });

OneSignal.shared.setEmailSubscriptionObserver(
        (OSEmailSubscriptionStateChanges changes) {
      print("OneSignal: email subscription changed: ${changes.jsonRepresentation()}");
});

Other Functions

getDeviceState Function

(Async method) Returns an OSDeviceState object with device info.

🚧

Do not cache OSDeviceState object

This method returns a "snapshot" of the device state for when it was called. Make sure to call getDeviceState again to get the latest state.

OneSignal.shared.getDeviceState().then((deviceState) {
     print("OneSignal: device state: ${deviceState.jsonRepresentation()}");
});

deviceState parameters:

disablePush Function

Use this function to opt users out of receiving all notifications through OneSignal.

OneSignal.shared.disablePush(true);

clearOneSignalNotifications Function

Android Only, use this function to manually remove all OneSignal notifications from the Notification Shade.

OneSignal.shared.clearOneSignalNotifications();

removeNotification Function

Android Only, use this function to manually cancel a single OneSignal notification based on its Android notification integer ID. The notification identifier can be found as part of the OSNotification object.

OneSignal.shared.removeNotification("NOTIFICATION_ID");

userProvidedPrivacyConsent Function

Android Only, use this function to get a boolean value indicating if the user-provided privacy consent.

bool consent = await OneSignal.shared.userProvidedPrivacyConsent();

Other Additions / Changes

OSNotification Object

In version 4, the OSNotification class is composed of all notification properties in a single object. This is the object passed into the notificationWillShowInForeground handler.