General

registerRemoteNotificationsRegistered()

Fired when the user registers for remote notifications. The handler will be invoked with an event holding the hex string representing the deviceToken

Notifications.events().registerRemoteNotificationsRegistered((event: Registered) => {
  console.log(event.deviceToken);
});

registerNotificationReceivedForeground()

Fired when a remote notification is received in foreground state. The handler will be invoked with an instance of Notification. Should call completion function on iOS, will be ignored on Android.

Notifications.events().registerNotificationReceivedForeground((notification: Notification, completion: (response: NotificationCompletion) => void) => {
  console.log(JSON.stringify(notification.payload));

  // Calling completion on iOS with `alert: true` will present the native iOS inApp notification.
  completion({alert: true, sound: true, badge: false});
});

registerNotificationReceivedBackground()

To receive background notifications on iOS follow this guide.

Fired when a remote notification is received in background state. The handler will be invoked with an instance of Notification. Should call completion function on iOS, will be ignored on Android.

Notifications.events().registerNotificationReceivedBackground((notification: Notification, completion: (response: NotificationCompletion) => void) => {
  console.log(JSON.stringify(notification.payload));

  // Calling completion on iOS with `alert: true` will present the native iOS inApp notification.
  completion({alert: true, sound: true, badge: false});
});

registerNotificationOpened()

Fired when a remote notification is opened from dead or background state. The handler will be invoked with an instance of Notification. Should call completion function on iOS, will be ignored on Android. Android: This event will be called before the component is mounted, if you want to know the initial notification in the component please use getInitialNotification on mount.

Notifications.events().registerNotificationOpened((notification: Notification, completion: () => void) => {
  console.log(JSON.stringify(notification.payload));
  completion();
});

registerRemoteNotificationsRegistrationFailed()

Fired when the user fails to register for remote notifications. Typically occurs when APNS is having issues, or the device is a simulator. The handler will be invoked with {localizedDescription: string, code: string, domain: string}.

Notifications.events().registerRemoteNotificationsRegistrationFailed((event: RegistrationError) => {
  console.log(event.code, event.localizedDescription, event.domain);
});

registerRemoteNotificationsRegistrationDenied()

Fired when the user does not grant permission to receive push notifications. Typically occurs when pressing the "Don't Allow" button in iOS permissions overlay.

Notifications.events().registerRemoteNotificationRegistrationDenied(() => {
  console.log('Notification permissions not granted')
})

registerRemoteNotificationsRegistered()#

registerNotificationReceivedForeground()#

registerNotificationReceivedBackground()#

To receive background notifications on iOS follow this guide.#

registerNotificationOpened()#

registerRemoteNotificationsRegistrationFailed()#

registerRemoteNotificationsRegistrationDenied()#