PushManager.getSubscription()

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 PushManager.getSubscription() method of the PushManager interface retrieves an existing push subscription.

It returns a Promise that resolves to a PushSubscription object containing details of an existing subscription. If no existing subscription exists, this resolves to a null value.

Syntax

​PushManager.getSubscription().then(function(pushSubscription) { ... } );

Parameters

None.

Returns

A Promise that resolves to a PushSubscription object.

Example

This code snippet is taken from a push messaging and notification sample. (No live demo is available.)

// We need the service worker registration to check for a subscription
  navigator.serviceWorker.ready.then(function(serviceWorkerRegistration) {
    // Do we already have a push message subscription?
    serviceWorkerRegistration.pushManager.getSubscription()
      .then(function(subscription) {
        // Enable any UI which subscribes / unsubscribes from
        // push messages.
        var pushButton = document.querySelector('.js-push-button');
        pushButton.disabled = false;
        if (!subscription) {
          // We aren’t subscribed to push, so set UI
          // to allow the user to enable push
          return;
        }
        // Keep your server in sync with the latest subscriptionId
        sendSubscriptionToServer(subscription);
        showCurlCommand(subscription);
        // Set your UI to show they have subscribed for
        // push messages
        pushButton.textContent = 'Disable Push Messages';
        isPushEnabled = true;
      })
      .catch(function(err) {
        window.Demo.debug.log('Error during getSubscription()', err);
      });
  });
}

Specifications

Specification Status Comment
Push API
The definition of 'getSubscription()' 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

Document Tags and Contributors

 Contributors to this page: chrisdavidmills, jpmedley, kscarfone
 Last updated by: chrisdavidmills,