PushManager.subscribe()
Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。
PushManager
インターフェイスの subscribe()
メソッドは、プッシュサービスを提供します。
これは、プッシュサブスクリプションの詳細を含む PushSubscription
オブジェクトで解決される Promise
を返します。現在のサービスワーカーに既存のサブスクリプションがない場合、新しいプッシュサブスクリプションが生成されます。
構文
PushManager.subscribe(options).then(function(pushSubscription) { ... } );
引数
options
省略可-
オプションの設定パラメータを含むオブジェクト。次のプロパティを設定できる:
userVisibleOnly
: 返されたプッシュサブスクリプションの効果がユーザーに表示するメッセージにだけ使われるかを示す boolean 値。applicationServerKey
: プッシュサーバーがアプリケーションサーバーを認証するために使用する 楕円曲線 DSA P-256 公開鍵を含む、Base64 でエンコードされたDOMString
またはArrayBuffer
。指定した場合は、アプリケーションサーバーから発するすべてのメッセージで VAPID 認証スキームを使用しなければならず、また対応する秘密鍵で署名した JWT を含めなければなりません。この鍵は、データを暗号化するために使用する ECDH 鍵と同じではありません。詳しくは "Using VAPID with WebPush" をご覧ください。
メモ: この引数は Chrome など、一部のブラウザーで必須です。
返値
PushSubscription
オブジェクトを解決する Promise
。
例
this.onpush = function(event) {
console.log(event.data);
// ここから、IndexedDB にデータを書き込んだり、いずれかのウィンドウに
// それを送信したり、通知を表示したりできます。
}
navigator.serviceWorker.register('serviceworker.js');
// serviceWorker.ready を使用して、プッシュの購読ができることを確かめます。
navigator.serviceWorker.ready.then(
function(serviceWorkerRegistration) {
var options = {
userVisibleOnly: true,
applicationServerKey: applicationServerKey
};
serviceWorkerRegistration.pushManager.subscribe(options).then(
function(pushSubscription) {
console.log(pushSubscription.endpoint);
// アプリケーションサーバが必要としているプッシュサブスクリプションの
// 詳細はここから使用できます。たとえば、XMLHttpRequest を使用して
// これを送信できます。
}, function(error) {
// 開発中は、コンソールにエラーを表示するのに役立ちます。
// 本番環境では、アプリケーションサーバにエラー情報を送信
// するためにも 役立ちます。
console.log(error);
}
);
});
仕様書
Specification |
---|
Push API # dom-pushmanager-subscribe |
ブラウザーの互換性
BCD tables only load in the browser