PushSubscriptionOptions

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Note: This feature is available in Web Workers.

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.

Instance properties

PushSubscriptionOptions.userVisibleOnly Read 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.applicationServerKey Read 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.

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

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Opera Safari Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet WebView Android
PushSubscriptionOptions 54 17 44 41
16Notifications are supported on macOS Ventura and later.
54 48 41
16.4Notifications are supported in web apps saved to the home screen.
6.0 No
applicationServerKey 54 17 44 41
16Notifications are supported on macOS Ventura and later.
54 48 41
16.4Notifications are supported in web apps saved to the home screen.
6.0 No
userVisibleOnly 54 17 No 41
16Notifications are supported on macOS Ventura and later.
54 No 41
16.4Notifications are supported in web apps saved to the home screen.
6.0 No

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