PushSubscriptionOptions: userVisibleOnly property

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 userVisibleOnly read-only property of the PushSubscriptionOptions interface indicates if the returned push subscription will only be used for messages whose effect is made visible to the user.

Value

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

Examples

In the example below the value of userVisibleOnly is printed to the console.

js
navigator.serviceWorker.ready.then((reg) => {
  reg.pushManager.getSubscription().then((subscription) => {
    const options = subscription.options;
    console.log(options.userVisibleOnly); // true if this is a user visible subscription
  });
});

Specifications

Specification
Push API
# dom-pushsubscriptionoptions-uservisibleonly

Browser compatibility

BCD tables only load in the browser