PushSubscriptionOptions.userVisibleOnly

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.

Syntax

let userVisibleOnly = PushSubscriptionOptions.userVisibleOnly;

Value

A Boolean 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.

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

Specifications

Specification Status Comment
Push API
The definition of 'PushSubscriptionOptions.userVisibleOnly' in that specification.
Working Draft Initial definition.

Browser compatibility

BCD tables only load in the browser