Skip to content

UNUserNotificationCenter: notification event ​

The notification event fires when a notification arrives while the app is in the foreground. Notifications that arrive while the app is not in the foreground produce no such event.

Syntax ​

center.addEventListener('notification', (event) => { })

Event object ​

UNNotificationPresentEvent, an Event with one extra field:

notification

The notification that just arrived, a UNNotification.

Not cancelable. The callback runs in the next turn after the event occurs.

When it fires ​

  • When a notification is delivered while the app is in the foreground. Fires for both local notifications and remote push notifications.
  • How the notification is shown on screen is decided by foregroundPresentationOptions before the event fires; listeners cannot change it for this notification. With the default [] it is not shown, and there is only this event.
  • Notifications that arrive with no listener are not kept: adding a listener later does not deliver them. This differs from notificationclick.
  • When it fires is not verified in the simulator.

Examples ​

js
const center = UNUserNotificationCenter.currentNotificationCenter();
center.addEventListener('notification', (event) => {
  console.log('New message', event.notification.request.content.body);
});

Effect (not verified in the simulator): when a notification arrives while the app is open, the console logs "New message" and its body.

Corresponding iOS API ​

The delegate method userNotificationCenter:willPresentNotification:withCompletionHandler:. In JS you do not set a delegate; listen for this event. The completionHandler you would call in that method is replaced by foregroundPresentationOptions, set in advance.

See also ​