PushSubscriptionOptions
Baseline
広く利用可能
*
この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2023年3月以降、すべてのブラウザーで利用可能です。
* この機能の一部は、対応レベルが異なる場合があります。
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 オブジェクト
});
});
仕様書
| 仕様書 |
|---|
| Push API # dom-pushsubscriptionoptions |