📘

Out of Beta

This reference includes changes from version 3 to version 4, including breaking changes. For the full React Native SDK reference, click here.

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
• postNotification change
• Event Listeners are now added and cleared differently
• Foreground notification control
• New handlers and observer setters/adders
• getDeviceState to get device info
• Typescript typings

Initialization

setAppId Function

In version 4, 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

Changed Functions

postNotification Function (as of beta.4)

In version 4, the postNotification function has been simplified to take a simple JSON string formatted as a request payload for the notification create call of the REST API.

Example:

const { userId } = await OneSignal.getDeviceState();

const notificationObj = {
  contents: {en: "Message Body"},
  include_player_ids: [userId]
};

const jsonString = JSON.stringify(notificationObj);

OneSignal.postNotification(jsonString, (success) => {
  console.log("Success:", success);
}, (error) => {
  console.log("Error:", error );
});

cancelNotification Function (as of beta.5)

In version 4, the cancelNotification function (Android only) has been renamed to removeNotification. This function is used to remove a notification from the Android shade by supplying the Android notification identifier.

Removed Functions

❗️

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

New Functions

Foreground Notification Control

In version 4, 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.setNotificationWillShowInForegroundHandler(notificationReceivedEvent => {
  console.log("OneSignal: notification will show in foreground:", notificationReceivedEvent);
  let notification = notificationReceivedEvent.getNotification();
  console.log("notification: ", notification);
  const data = notification.additionalData
  console.log("additionalData: ", data);
  notificationReceivedEvent.complete(notification);
});

the callback argument object has two functions:

Handlers

setInAppMessageClickHandler Function

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

OneSignal.setInAppMessageClickHandler(event => {
	console.log("OneSignal IAM clicked:", event);
});

setNotificationOpenedHandler Function

Set the callback to run on notification open/click.

OneSignal.setNotificationOpenedHandler(openedEvent => {
	console.log("OneSignal: notification opened:", openedEvent);
  const { action, notification } = openedEvent;
});

openedEvent fields:

Observers

❗️

Replaces addEventListener functionality.

These observers listen to events that will fire and execute the given callback.

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.

Important: as designated by the "add" prefix to these functions, it is possible to add multiple callbacks to the same event. The callbacks will then fire independently when the event occurs. (Related: see clearHandlers function).

addPermissionObserver Function

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

Change event parameters:

addSubscriptionObserver Function

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

Change event parameters:

addEmailSubscriptionObserver Function

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

Change event parameters:

Example

OneSignal.addPermissionObserver(event => {
    console.log("OneSignal: permission changed:", event);
});

OneSignal.addSubscriptionObserver(event => {
  console.log("OneSignal: subscription changed event:", event);
  console.log("OneSignal: subscription changed from userId:", event.from.userId);
  console.log("OneSignal: subscription changed to userId:", event.to.userId);
  console.log("OneSignal: subscription changed from pushToken:", event.from.pushToken);
  console.log("OneSignal: subscription changed to pushToken:", event.to.pushToken);
  console.log("OneSignal: subscription changed from isPushDisabled:", event.from.isPushDisabled);
  console.log("OneSignal: subscription changed to isPushDisabled:", event.to.isPushDisabled);
  console.log("OneSignal: subscription changed from isSubscribed:", event.from.isSubscribed);
  console.log("OneSignal: subscription changed to isSubscribed:", event.to.isSubscribed);
});

OneSignal.addEmailSubscriptionObserver((event) => {
    console.log("OneSignal: email subscription changed: ", event);
});

Other Functions

getDeviceState Function

ASYNC
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.

const deviceState = await OneSignal.getDeviceState();

deviceState parameters:

disablePush Function

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

OneSignal.disablePush(true);

clearHandlers Function

Clears all handlers and observers.

📘

While this function clears both handlers AND observers, it is mainly useful for the observers since multiple observers can be added to a single event. React Native hot-reloading can lead to the buildup of these observers while in the dev environment which will result in multiple firings of the given callbacks. To avoid this, call in componentWillUnmount().

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.