Push Notifications

Here is how to use the push notifications API in the Javascript SDK. Before you use these methods, make yourself familiar with our guide about setting up and using browser push notifications in Bloomreach Engagement.

isAvailable()

This method allows you to check whether push notifications are supported in the current browser. The provided callback is called with the answer.

Arguments

The callback is called with the following arguments:

Examples

exponea.notifications.isAvailable(available => {
  if (available)
    console.log("Browser supports push notifications!")
  else
    console.log("Browser does NOT support push notifications.")
})

isSubscribed()

This method checks whether the current user is subscribed to push notifications or whether they have denied access to them.

Arguments

The callback is called with the following arguments:

Examples

Here is an example how to determine whether to show a subscription prompt for the user:

exponea.notifications.isSubscribed((active, denied) => {
  if (active) {
    // the user is already subscribed
  } else if (denied) {
    // the user has already interacted with the prompt and declined
  } else {
    // show the subscription prompt (like a web layer) and then,
    // when the user confirms, execute:
    exponea.notifications.subscribe()
  }
})

For an example of a subscription web layer, take a look at our Browser Push Notifications documentation.

subscribe()

Prompts the user to subscribe to push notifications if they are not already. This shows the standard push notifications prompt in the browser, which the user can either confirm or decline.

Arguments

If provided, the callback is called with the following arguments:

It can be helpful to also take a look at the MDN documentation for Notification.requestPermission because this is the browser API that the subscribe() method uses internally.

Examples

exponea.notifications.subscribe(
	status => {
  	if (status === 'subscribed')
    	console.log('The user has been subscribed to push notifications')
    else
    	console.log('Failed to subscribe the user to push notifications:', status)
	},
	{ push_notifications: true }
)

unsubscribe()

Unsubscribes the user from push notifications if they are already, or silently succeeds if the are not.

Arguments

If provided, the callback is called with the following arguments:

Examples

exponea.notifications.unsubscribe(status => {
  if (status === 'unsubscribed')
    console.log('The user has been unsubscribed from push notifications')
  else
    console.log('Failed to unsubscribe the user from push notifications:', status)
})