PushSubscription

The PushSubscription interface of the Push API provides a subcription's URL endpoint and allows unsubscription from a push service.

An instance of this interface can be serialized.

Properties

PushSubscription.endpoint Read only

A USVString containing the endpoint associated with the push subscription.

PushSubscription.subscriptionId Read only

A DOMString containing the subscription ID associated with the push subscription.

Methods

PushSubscription.getKey()

Returns an ArrayBuffer which contains the client's public key, which can then be sent to a server and used in encrypting push message data.

PushSubscription.toJSON()

Standard serializer — returns a JSON representation of the subscription properties.

PushSubscription.unsubscribe()

Starts the asynchronous process of unsubscribing from the push service, returning a Promise that resolves to a Boolean when the current subscription is successfully unregistered.

Example

navigator.serviceWorker.ready.then(function(reg) {
  reg.pushManager.getSubscription().then(function(subscription) {
    subscription.unsubscribe().then(function(successful) {
      // You've successfully unsubscribed
    }).catch(function(e) {
      // Unsubscription failed
    })
  })        
});

Specifications

Browser compatibility

• [1] Push (and Service Workers) have been disabled in the Firefox 45 Extended Support Release (ESR.)
• [2] Push has been enabled by default on Firefox for Android version 48.

See also

• Using the Push API
• Push API
• Service Worker API