W3cubDocs

/Web APIs

PushSubscriptionOptions: userVisibleOnly property

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

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
userVisibleOnly 54 17 No No 41
16Supported on macOS 13 and later
No 54 No 41 16.4 6.0

© 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/userVisibleOnly