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.
navigator.serviceWorker.ready.then((reg) => {
reg.pushManager.getSubscription().then((subscription) => {
const options = subscription.options;
console.log(options);
});
});
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 |
PushSubscriptionOptions |
54 |
17 |
44 |
No |
41 |
16Supported on macOS 13 and later
|
No |
54 |
48 |
41 |
16.4 |
6.0 |
applicationServerKey |
54 |
17 |
44 |
No |
41 |
16Supported on macOS 13 and later
|
No |
54 |
48 |
41 |
16.4 |
6.0 |
userVisibleOnly |
54 |
17 |
No |
No |
41 |
16Supported on macOS 13 and later
|
No |
54 |
No |
41 |
16.4 |
6.0 |