PushManager.subscribe()

PushManager インターフェースの subscribe() メソッドは、プッシュサービスを提供します。

これは、プッシュサブスクリプションの詳細を含む PushSubscription オブジェクトで解決される Promise を返します。現在の service worker に既存のサブスクリプションがない場合、新しいプッシュサブスクリプションが生成されます。

構文

​PushManager.subscribe(options).then(function(pushSubscription) { ... } );

パラメーター

options Optional

オプションの設定パラメータを含むオブジェクト。次のプロパティを設定できる：

• userVisibleOnly: 返されたプッシュサブスクリプションの効果がユーザーに表示するメッセージにだけ使われるかを示す boolean 値。

戻り値

PushSubscription オブジェクトを解決する Promise 。

例

this.onpush = function(event) {
  console.log(event.data);
  // ここから、IndexedDB にデータを書き込んだり、いずれかのウィンドウに
  // それを送信したり、通知を表示したりできます。
}

navigator.serviceWorker.register('serviceworker.js').then(
  function(serviceWorkerRegistration) {
    serviceWorkerRegistration.pushManager.subscribe().then(
      function(pushSubscription) {
        console.log(pushSubscription.endpoint);
        // アプリケーションサーバが必要としているプッシュサブスクリプションの
        // 詳細はここから使用できます。たとえば、XMLHttpRequest を使用して
        // これを送信できます。
      }, function(error) {
        // 開発中は、コンソールにエラーを表示するのに役立ちます。
        // 本番環境では、アプリケーションサーバにエラー情報を送信
        //  するためにも 役立ちます。
        console.log(error);
      }
    );
  });

仕様

ブラウザ実装状況

• [1] Push（と Service Workers）は、 Firefox 45 延長サポート版（ESR）では使用できません。
• [2] Firefox for Android 48 から、既定で Push を使用できます。

関連項目

• Using the Push API