PushSubscription

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) {
      // 登録解除失敗。
    })
  })        
});

仕様

ブラウザー実装状況

関連項目

• Push API
• Service Worker API