PushSubscriptionOptions

The PushSubscriptionOptions interface of the Push API represents the options associated with a push subscription.

The read-only PushSubscriptionOptions object is returned by calling PushSubscription.options on a PushSubscription. This interface has no constructor of its own.

Properties

PushSubscriptionOptions.userVisibleOnlyRead only

A boolean value indicating that the returned push subscription will only be used for messages whose effect is made visible to the user.

PushSubscriptionOptions.applicationServerKeyRead only

A public key your push server will use to send messages to client apps via a push server.

Examples

Calling PushSubscription.options on a PushSubscription returns a PushSubscriptionOptions object. In the example below this is printed to the console.

navigator.serviceWorker.ready.then(function(reg) {
  reg.pushManager.getSubscription().then(function(subscription) {
    let options = subscription.options;
    console.log(options); // a PushSubscriptionOptions object
  })
});

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
PushSubscriptionOptions
54
17
44
No
41
No
No
54
44
41
No
6.0
applicationServerKey
54
17
44
No
41
No
No
54
44
41
No
6.0
userVisibleOnly
54
17
No
No
41
No
No
54
No
41
No
6.0

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/PushSubscriptionOptions