We're looking for a user researcher to understand the needs of developers and designers. Is this you or someone you know? Check out the post: https://mzl.la/2IGzdXS

PushSubscription

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

 

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.expirationTime Read only
DOMHighResTimeStamp of the subscription expiration time associated with the push subscription, if there is one, or null otherwise. 
PushSubscription.options Read only
An object containing containing the options used to create the 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

Specification Status Comment
Push API
The definition of 'PushSubscription' in that specification.
Working Draft Initial definition

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support42 Yes441 No29 No
endpoint4216441 No29 No
expirationTime6016 ? No47 No
options4216441 No29 No
subscriptionId42 Yes441 No29 No
getKey4216441 No29 No
toJSON42 ? ? No ? ?
unsubscribe4216 ? No ? ?
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support No42 ?4829 No4.0
endpoint No42 ?4829 No4.0
expirationTime No60 ? ?47 No No
options No42 ?4829 No4.0
subscriptionId No42 ?4829 No4.0
getKey No42 ?4829 No4.0
toJSON No50 ? ? ? ?5.0
unsubscribe No50 ? ? ? ?5.0

1. Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).

See also

Document Tags and Contributors

Last updated by: fscholz,