PushManager.subscribe

The subscribe() method of the PushManager interface subscribes to a push service.

It returns a Promise that resolves to a PushSubscription object containing details of a push subscription. A new push subscription is created if the current service worker does not have an existing subscription.

Syntax

​PushManager.subscribe(options).then(function(pushSubscription) { ... } );

Parameters

options Optional

An object containing optional configuration parameters. It can have the following properties:

• userVisibleOnly: A boolean indicating that the returned push subscription will only be used for messages whose effect is made visible to the user.
• applicationServerKey: A public key your push server will use to send messages to client apps via a push server. This value is part of a signing key pair generated by your application server and usable with elliptic curve digital signature (ECDSA) over the P-256 curve.

Returns

A Promise that resolves to a PushSubscription object.

Example

this.onpush = function(event) {
  console.log(event.data);
  // From here we can write the data to IndexedDB, send it to any open
  // windows, display a notification, etc.
}

navigator.serviceWorker.register('serviceworker.js').then(
  function(serviceWorkerRegistration) {
    serviceWorkerRegistration.pushManager.subscribe().then(
      function(pushSubscription) {
        console.log(pushSubscription.endpoint);
        // The push subscription details needed by the application
        // server are now available, and can be sent to it using,
        // for example, an XMLHttpRequest.
      }, function(error) {
        // During development it often helps to log errors to the
        // console. In a production environment it might make sense to
        // also report information about errors back to the
        // application server.
        console.log(error);
      }
    );
  });

Specifications

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

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