Notifications

Provides access to remote notifications (also known as push notifications) and local notifications (scheduling and immediate) related functions.

Subscribing to Notifications

Exponent.Notifications.addListener(listener)

Arguments

• listener (function) — A callback that is invoked when a remote or local notification is received or selected, with a Notification object.

Returns

An EventSubscription object that you can call remove() on when you would like to unsubscribe the listener.

Related types

EventSubscription

Returned from addListener.

• remove() (function) — Unsubscribe the listener from future notifications.

  Notification

An object that is passed into each event listener when a notification is received:

• origin (string) — Either selected or received. selected if the notification was tapped on by the user, received if the notification was received while the user was in the app.
• data (object) — Any data that has been attached with the notification.
• remote (boolean) — true if the notification is a push notification, false if it is a local notification.

Remote (Push) Notifications

Exponent.Notifications.getExponentPushTokenAsync()

Returns

Returns a Promise that resolves to a token string. This token can be provided to the Exponent notifications backend to send a push notification to this device. Read more in the Push Notifications guide.

Local Notifications

Exponent.Notifications.presentLocalNotificationAsync(localNotification)

Trigger a local notification immediately.

Arguments

• localNotification (object) — An object with the properties described in LocalNotification.

Returns

A Promise that resolves to a unique notification id.

Exponent.Notifications.scheduleLocalNotificationAsync(localNotification, schedulingOptions)

Schedule a local notification to fire at some specific time in the future or at a given interval.

Arguments

• localNotification (object) —

  An object with the properties described in LocalNotification.

• schedulingOptions (object) —

  An object that describes when the notification should fire.

  • time (date or number) — A Date object representing when to fire the notification or a number in Unix epoch time. Example: (new Date()).getTime() + 1000 is one second from now.
  • repeat (optional) (string) — 'minute', 'hour', 'day', 'week', 'month', or 'year'.

Returns

A Promise that resolves to a unique notification id.

Exponent.Notifications.dismissNotificationAsync(localNotificationId)

Android only. Dismisses the notification with the given id.

Arguments

• localNotificationId (number) — A unique id assigned to the notification, returned from scheduleLocalNotificationAsync or presentLocalNotificationAsync.

Exponent.Notifications.dismissAllNotificationsAsync()

Android only. Clears any notificatons that have been presented by the app.

Exponent.Notifications.cancelScheduledNotificationAsync(localNotificationId)

Cancels the scheduled notification corresponding to the given id.

Arguments

• localNotificationId (number) — A unique id assigned to the notification, returned from scheduleLocalNotificationAsync or presentLocalNotificationAsync.

Exponent.Notifications.cancelAllScheduledNotificationsAsync()

Cancel all scheduled notifications.

Related types

LocalNotification
An object used to describe the local notification that you would like to present or schedule.

• title (string) — Either selected or received. selected if the notification was tapped on by the user, received if the notification was received while the user was in the app.
• data (optional) (object) — Any data that has been attached with the notification.

• ios (optional) (object) — notification configuration specific to iOS.

  • sound (optional) (boolean) — if true, play a sound. Default: false.

• android (optional) (object) — notification configuration specific to Android.

  • icon (optional) (string)
  • color (optional) (string)
  • priority (optional) (string)
  • sticky (optional) (boolean)
  • vibrate (optional) (boolean or array)
  • link (optional) (array)