PushSubscription.unsubscribe()

Experimental

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

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

BCD tables only load in the browser