mozilla
Your Search Results

    PushManager

    This is an experimental technology
    Because this technology's specification has not stabilized, check the compatibility table for the proper prefixes to use 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 spec changes.

    The PushManager interface of the Push API provides a way to receive notifications from third-party servers as well as request URLs for push notifications.

    This interface is accessed via the ServiceWorkerRegistration.pushManager property.

    Note: This interface has replaced functionality offered by the obsolete PushRegistrationManager.

    Properties

    None

    Methods

    PushManager.subscribe()
    Subscribes to a push service. It Returns a promise that resolves to a PushSubscription object containing details of a new push subscription.
    PushManager.getSubscription()
    Retrieves an existing push subscription. It Returns a promise that resolves to a PushSubscription object containing details of the existing subscription.
    PushManager.permissionState()
    Returns a Promise that resolves to the permission state of the current PushManager, which will be one of 'granted', 'denied', or 'default'.

    Deprecated methods

    PushManager.hasPermission()
    Returns a Promise that resolves to the PushPermissionStatus of the requesting webapp, which will be one of granted, denied, or default. Replaced by PushManager.permissionState().
    PushManager.register()
    Subscribes to a push subscription. Replaced by PushManager.subscribe().
    PushManager.registrations()
    Retrieves existing push subscriptions. Replaced by PushManager.getSubscription().
    PushManager.unregister()
    Unregisters and deletes a specified subscription endpoint. In the updated API, a subscription is can be unregistered via the PushSubscription.unsubscribe() method.

    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.subscriptionId);
            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 'PushManager' in that specification.
    Working Draft Initial definition.

    Browser Compatibility

    Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
    Basic support 42.0 (Yes) ? ? ?
    Feature Android Android Webview Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
    Basic support Not supported Not supported (Yes) (Yes) ? ? ? 42.0

    See also

    Document Tags and Contributors

    Last updated by: chrisdavidmills,