PushSubscription: options property

Baseline 2023
Newly available

Since March 2023, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

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 options read-only property of the PushSubscription interface is an object containing the options used to create the subscription.

Value

An read-only PushSubscriptionOptions object containing the following values:

userVisibleOnly

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

applicationServerKey

A public key your push server will use to send messages to client apps via a push server. This value is part of a signing key pair generated by your application server, and usable with elliptic curve digital signature (ECDSA), over the P-256 curve.

Specifications

Specification
Push API
# dom-pushsubscription-options

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
options

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
See implementation notes.