Package 

Interface INotificationReceivedEvent

  • 
public interface INotificationReceivedEvent

    The event passed into both INotificationServiceExtension.onNotificationReceived. It provides access to the received notification and the ability to change how (or whether) that notification will be displayed to the user.

    The notification provided in this event is both an IMutableNotification, which allows the notification to be altered, and IDisplayableNotification, which allows the notification to be displayed outside of the event callback.

    To display the notification outside of the event callback (for instance, if you need to perform asynchronous processing to determine whether to display the notification).

    object : IRemoteNotificationReceivedHandler {
  fun remoteNotificationReceived(event: IRemoteNotificationReceivedEvent) {
    event.preventDefault()
    thread {
      // do something async

      // optionally, change the display using a native Android Extender
      event.notification.setExtender(androidx.core.app.NotificationCompat.Extender {
        // alter the notification, for example to change the title
        it.setContentTitle("CUSTOM TITLE")
      })

      // optionally, display the notification manually
      event.notification.display()
    }
  }
}

    • Method Summary

      Modifier and Type Method Description
      abstract Unit preventDefault() Call this to prevent OneSignal from displaying the notification automatically.
      abstract Unit preventDefault(Boolean discard) Call this to prevent OneSignal from displaying the notification automatically.
      abstract Context getContext() The Android context the notification was received under.
      abstract IDisplayableMutableNotification getNotification() The notification that has been received.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • preventDefault

         abstract Unit preventDefault()

        Call this to prevent OneSignal from displaying the notification automatically. The notification can still be manually displayed using notification.display().

      • preventDefault

         abstract Unit preventDefault(Boolean discard)

        Call this to prevent OneSignal from displaying the notification automatically. This method can be called up to two times with false and then true, if processing time is needed. Typically this is only possible within a short time-frame (~30 seconds) after the notification is received on the device.

        Parameters:
        discard - an preventDefault set to true to dismiss the notification with no possibility of displaying it in the future.

      • getContext

         abstract Context getContext()

        The Android context the notification was received under.