PushSubscription

Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

Push API の PushSubscription インターフェイスは、サブスクリプションの URL エンドポイントを提供するとともに、プッシュサービスの登録を解除できます。

このインターフェイスのインスタンスはシリアライズできます。

インスタンスプロパティ

PushSubscription.endpoint 読取専用

プッシュサービスに関連したエンドポイントを含む USVString。

PushSubscription.expirationTime 読取専用

プッシュサブスクリプションに関連付いたサブスクリプション期限切れ時間を表す DOMHighResTimeStamp。存在しない場合は null。

PushSubscription.options 読取専用

サブスクリプションを作成するために用いられるオプションを含むオブジェクト。

PushSubscription.subscriptionId 読取専用

プッシュサービスに関連したサブスクリプション ID を含む DOMString。

インスタンスメソッド

PushSubscription.getKey()

サーバーに送信されてプッシュメッセージの暗号化に使用される、クライアントのパブリックキーを含む ArrayBuffer を返します。

PushSubscription.toJSON()

標準シリアライザー — サブスクリプションプロパティの JSON 記法を返します。

PushSubscription.unsubscribe()

プッシュサービスの登録を解除する非同期プロセスを開始します。現在のサブスクリプションが成功裏に登録解除できた場合、Boolean で解決される Promise を返します。

例

navigator.serviceWorker.ready.then(function(reg) {
  reg.pushManager.getSubscription().then(function(subscription) {
    subscription.unsubscribe().then(function(successful) {
      // 成功裏に登録解除。
    }).catch(function(e) {
      // 登録解除失敗。
    })
  })
});

仕様書

Specification
Push API
# pushsubscription-interface

ブラウザーの互換性

BCD tables only load in the browser

関連項目