PushSubscription.unsubscribe()

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

The unsubscribe() method of the PushSubscription interface returns a Promise that resolves to a Boolean when the current subscription is successfully unsubscribed.

Syntax

​PushSubscription.unsubscribe().then(function(Boolean) { ... });

Parameters

None.

Returns

A Promise that resolves to a Boolean when the current subscription is successfully unsubscribed.

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 'unsubscribe()' in that specification.
Working Draft Initial definition.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 42.0 44.0 (44.0)[1] No support ? No support
Feature Android Android Webview Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support No support No support 48.0 (48)[2] No support No support No support No support 42.0

See also

Document Tags and Contributors

 Contributors to this page: chrisdavidmills, jpmedley, Sheppy, Sebastianz
 Last updated by: chrisdavidmills,