PushSubscriptionOptions

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.

Push API の PushSubscriptionOptions インターフェイスは、プッシュサブスクリプションに関連付いたオプションを表します。

PushSubscription で PushSubscription.options を呼ぶと、読み取り専用の PushSubscriptionOptions オブジェクトが返ります。このインターフェイスは自身のコンストラクターを持ちません。

インスタンスプロパティ

PushSubscriptionOptions.userVisibleOnly 読取専用

プッシュサブスクリプションがユーザーに見える効果を持つメッセージのみに使われるかどうかを表す boolean 値です｡

PushSubscriptionOptions.applicationServerKey 読取専用

プッシュサーバーがプッシュサーバーを通じてクライアントアプリケーションにメッセージを送信するのに用いる公開鍵です。

例

PushSubscription で PushSubscription.options を呼ぶと、PushSubscriptionOptions オブジェクトが返ります。この例では、これをコンソールに出力します。

js
navigator.serviceWorker.ready.then((reg) => {
  reg.pushManager.getSubscription().then((subscription) => {
    const options = subscription.options;
    console.log(options); // PushSubscriptionOptions オブジェクト
  });
});

仕様書

Specification
Push API
# dom-pushsubscriptionoptions

ブラウザーの互換性

BCD tables only load in the browser