diff options
author | Peter Bengtsson <mail@peterbe.com> | 2020-12-08 14:40:17 -0500 |
---|---|---|
committer | Peter Bengtsson <mail@peterbe.com> | 2020-12-08 14:40:17 -0500 |
commit | 33058f2b292b3a581333bdfb21b8f671898c5060 (patch) | |
tree | 51c3e392513ec574331b2d3f85c394445ea803c6 /files/ja/web/api/pushmanager | |
parent | 8b66d724f7caf0157093fb09cfec8fbd0c6ad50a (diff) | |
download | translated-content-33058f2b292b3a581333bdfb21b8f671898c5060.tar.gz translated-content-33058f2b292b3a581333bdfb21b8f671898c5060.tar.bz2 translated-content-33058f2b292b3a581333bdfb21b8f671898c5060.zip |
initial commit
Diffstat (limited to 'files/ja/web/api/pushmanager')
-rw-r--r-- | files/ja/web/api/pushmanager/getsubscription/index.html | 149 | ||||
-rw-r--r-- | files/ja/web/api/pushmanager/index.html | 110 | ||||
-rw-r--r-- | files/ja/web/api/pushmanager/permissionstate/index.html | 124 | ||||
-rw-r--r-- | files/ja/web/api/pushmanager/register/index.html | 77 | ||||
-rw-r--r-- | files/ja/web/api/pushmanager/registrations/index.html | 88 | ||||
-rw-r--r-- | files/ja/web/api/pushmanager/subscribe/index.html | 105 | ||||
-rw-r--r-- | files/ja/web/api/pushmanager/unregister/index.html | 89 |
7 files changed, 742 insertions, 0 deletions
diff --git a/files/ja/web/api/pushmanager/getsubscription/index.html b/files/ja/web/api/pushmanager/getsubscription/index.html new file mode 100644 index 0000000000..d2fabe1b86 --- /dev/null +++ b/files/ja/web/api/pushmanager/getsubscription/index.html @@ -0,0 +1,149 @@ +--- +title: PushManager.getSubscription() +slug: Web/API/PushManager/getSubscription +tags: + - API + - Experimental + - Method + - PushManager + - Reference + - Service Workers +translation_of: Web/API/PushManager/getSubscription +--- +<p>{{SeeCompatTable}}{{ApiRef("Push API")}}</p> + +<p>{{domxref("PushManager")}} インターフェースの <strong><code>PushManager.getSubscription()</code></strong> メソッドは、既存のプッシュサブスクリプションを取得します。</p> + +<p>これは既存のプッシュサブスクリプションの詳細を含む {{domxref("PushSubscription")}} を解決する {{jsxref("Promise")}} を返します。既存のプッシュサブスクリプションが存在しない場合 <code>null</code> 値で解決されます。</p> + +<h2 id="構文">構文</h2> + +<pre class="brush: js" style="font-size: 14px;">PushManager.getSubscription().then(function(pushSubscription) { ... } );</pre> + +<h3 id="パラメーター">パラメーター</h3> + +<p>なし。</p> + +<h3 id="戻り値">戻り値</h3> + +<p>{{domxref("PushSubscription")}} オブジェクトで解決される {{jsxref("Promise")}}。</p> + +<h2 id="例">例</h2> + +<p>このコードスニペットは、<a href="https://github.com/GoogleChrome/samples/blob/gh-pages/push-messaging-and-notifications">push messaging and notification sample </a>から取ってきました(使用できるライブデモはありません)。</p> + +<pre class="brush: js" style="font-size: 14px;">// サブスクリプションをチェックするために、service worker の登録が必要である。 + navigator.serviceWorker.ready.then(function(serviceWorkerRegistration) { + // 既にプッシュメッセージサブスクリプションがあるか? + serviceWorkerRegistration.pushManager.getSubscription() + .then(function(subscription) { + // プッシュメッセージからサブスクライブ / アンサブスクライブ + // する任意の UI を有効にする + var pushButton = document.querySelector('.js-push-button'); + pushButton.disabled = false; + + if (!subscription) { + // プッシュを購読していない場合、ユーザーがプッシュできるように + // UI を設定する。 + return; + } + + // 最新の subscriptionId でサーバ同期を維持する。 + sendSubscriptionToServer(subscription); + + showCurlCommand(subscription); + + // プッシュメッセージの購読を表示するために + // UI を設定する。 + pushButton.textContent = 'Disable Push Messages'; + isPushEnabled = true; + }) + .catch(function(err) { + window.Demo.debug.log('Error during getSubscription()', err); + }); + }); +}</pre> + +<h2 id="仕様">仕様</h2> + +<table class="standard-table"> + <tbody> + <tr> + <th scope="col">仕様</th> + <th scope="col">状態</th> + <th scope="col">コメント</th> + </tr> + <tr> + <td>{{SpecName('Push API', '#widl-PushManager-getSubscription-Promise-PushSubscription', 'getSubscription()')}}</td> + <td>{{Spec2('Push API')}}</td> + <td>初期定義。</td> + </tr> + </tbody> +</table> + +<h2 id="ブラウザ実装状況">ブラウザ実装状況</h2> + +<div>{{CompatibilityTable}}</div> + +<div id="compat-desktop"> +<table class="compat-table"> + <tbody> + <tr> + <th>機能</th> + <th>Chrome</th> + <th>Firefox (Gecko)</th> + <th>Internet Explorer</th> + <th>Opera</th> + <th>Safari (WebKit)</th> + </tr> + <tr> + <td>基本サポート</td> + <td>{{CompatChrome(42.0)}}</td> + <td>{{CompatGeckoDesktop(44.0)}}<sup>[1]</sup></td> + <td>{{CompatNo}}</td> + <td>{{CompatUnknown}}</td> + <td>{{CompatNo}}</td> + </tr> + </tbody> +</table> +</div> + +<div id="compat-mobile"> +<table class="compat-table"> + <tbody> + <tr> + <th>機能</th> + <th>Android</th> + <th>Android Webview</th> + <th>Firefox Mobile (Gecko)</th> + <th>Firefox OS</th> + <th>IE Mobile</th> + <th>Opera Mobile</th> + <th>Safari Mobile</th> + <th>Chrome for Android</th> + </tr> + <tr> + <td>基本サポート</td> + <td>{{CompatNo}}</td> + <td>{{CompatNo}}</td> + <td>{{CompatGeckoMobile(48)}}<sup>[2]</sup></td> + <td>{{CompatNo}}</td> + <td>{{CompatNo}}</td> + <td>{{CompatNo}}</td> + <td>{{CompatNo}}</td> + <td>{{CompatChrome(42.0)}}</td> + </tr> + </tbody> +</table> +</div> + +<ul> + <li>[1] Push(と <a href="/en-US/docs/Web/API/Service_Worker_API">Service Workers</a>)は、 have been disabled in the <a href="https://www.mozilla.org/ja/firefox/organizations/">Firefox 45 延長サポート版</a> (ESR)では使用できません。</li> + <li>[2] Firefox for Android 48 から、既定で Push を使用できます。</li> +</ul> + +<h2 id="関連項目">関連項目</h2> + +<ul> + <li><a href="/ja/docs/Web/API/Push_API/Using_the_Push_API">Using the Push API</a></li> +</ul> diff --git a/files/ja/web/api/pushmanager/index.html b/files/ja/web/api/pushmanager/index.html new file mode 100644 index 0000000000..0671616f4d --- /dev/null +++ b/files/ja/web/api/pushmanager/index.html @@ -0,0 +1,110 @@ +--- +title: PushManager +slug: Web/API/PushManager +tags: + - API + - Experimental + - Interface + - Push + - Push API + - Reference + - Service Workers +translation_of: Web/API/PushManager +--- +<p>{{SeeCompatTable}}{{ApiRef("Push API")}}</p> + +<p><a href="/ja/docs/Web/API/Push_API">Push API</a> の <code>PushManager</code> インターフェースは、3rd パーティーのサーバーからの通知だけではなく、プッシュ通知へのリクエスト URL を取得するための方法を提供します。</p> + +<p>このインターフェースは、{{domxref("ServiceWorkerRegistration.pushManager")}} プロパティを経由してアクセスできます。</p> + +<div class="note"> +<p><strong>ノート</strong>:このインターフェースは、廃止された {{domxref("PushRegistrationManager")}}で以前に提案されていた機能をリプレースしています。</p> +</div> + +<h2 id="Properties" name="Properties">プロパティ</h2> + +<dl> + <dt>{{domxref("PushManager.supportedContentEncodings")}}</dt> + <dd>プッシュメッセージのペイロードの暗号化でサポートされているコンテンツエンコーディングの配列を返します。</dd> +</dl> + +<h2 id="Methods" name="Methods">メソッド</h2> + +<dl> + <dt>{{domxref("PushManager.getSubscription()")}}</dt> + <dd>既存のプッシュサブスクリプションを受け取ります。これは既存のプッシュサブスクリプションの詳細を含む {{domxref("PushSubscription")}} を解決する {{jsxref("Promise")}} を返します。既存のプッシュサブスクリプションが存在しない場合、<code>null</code> 値で解決されます。</dd> + <dt>{{domxref("PushManager.permissionState()")}}</dt> + <dd>現在の {{domxref("PushSubscription")}} の許可状況で解決される {{jsxref("Promise")}} を返します。許可状況は <code>'granted'</code>、<code>'denied'</code>、<code>'prompt' </code>のいずれかです。</dd> + <dt>{{domxref("PushManager.subscribe()")}}</dt> + <dd>プッシュサービスを提供します。プッシュサブスクリプションの詳細を含む {{domxref("PushSubscription")}} オブジェクトで解決される {{jsxref("Promise")}} を返します。現在の service worker に既存のサブスクリプションがない場合、新しいプッシュサブスクリプションが生成されます。</dd> +</dl> + +<h3 id="Deprecated_methods" name="Deprecated_methods">非推奨のメソッド</h3> + +<dl> + <dt>{{domxref("PushManager.hasPermission()")}} {{deprecated_inline}}</dt> + <dd>リクエストしている Web アプリの<code>PushPermissionStatus</code> で解決される {{jsxref("Promise")}} を返します。この値は <code>granted</code>、<code>denied</code>、<code>default</code> のいずれかです。{{domxref("PushManager.permissionState()")}} で置き換えられました。</dd> + <dt>{{domxref("PushManager.register()")}} {{deprecated_inline}}</dt> + <dd>プッシュサービスを提供します。 {{domxref("PushManager.subscribe()")}} で置き換えられました。</dd> + <dt>{{domxref("PushManager.registrations()")}} {{deprecated_inline}}</dt> + <dd>既存のプッシュサブスクリプションを受け取ります。{{domxref("PushManager.getSubscription()")}} で置き換えられました。</dd> + <dt>{{domxref("PushManager.unregister()")}} {{deprecated_inline}}</dt> + <dd>指定のサブスクリプションエンドポイントを解除して削除します。API のアップデートで、サブスクリプションは、{{domxref("PushSubscription.unsubscribe()")}} メソッドを呼び出して解除することになりました。</dd> +</dl> + +<h2 id="Example" name="Example">例</h2> + +<pre class="brush: js">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.subscriptionId); + console.log(pushSubscription.endpoint); + // ここから、IndexedDB にデータを書き込んだり、いずれかのウィンドウに + // それを送信したり、通知を表示したりできます。 + }, function(error) { + // 開発中は、コンソールにエラーを表示するのに役立ちます。 + // 本番環境では、アプリケーションサーバにエラー情報を送信 + // するためにも 役立ちます。 + console.log(error); + } + ); + });</pre> + +<h2 id="Specifications" name="Specifications">仕様</h2> + +<table class="standard-table"> + <tbody> + <tr> + <th scope="col">仕様</th> + <th scope="col">状態</th> + <th scope="col">コメント</th> + </tr> + <tr> + <td>{{SpecName('Push API','#pushmanager-interface','PushManager')}}</td> + <td>{{Spec2('Push API')}}</td> + <td>初期定義。</td> + </tr> + </tbody> +</table> + +<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザー実装状況</h2> + +<div> +<div class="hidden">このページの互換性テーブルは構造化データから作成されています。データに貢献したい場合、<a href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> をチェックし、プルリクエストを送ってください。</div> + +<p>{{Compat("api.PushManager")}}</p> +</div> + +<h2 id="See_also" name="See_also">関連項目</h2> + +<ul> + <li><a href="/ja/docs/Web/API/Push_API">Push API</a></li> + <li><a href="/ja/docs/Web/API/Service_Worker_API">Service Worker API</a></li> +</ul> diff --git a/files/ja/web/api/pushmanager/permissionstate/index.html b/files/ja/web/api/pushmanager/permissionstate/index.html new file mode 100644 index 0000000000..de1da36a9c --- /dev/null +++ b/files/ja/web/api/pushmanager/permissionstate/index.html @@ -0,0 +1,124 @@ +--- +title: PushManager.permissionState() +slug: Web/API/PushManager/permissionState +tags: + - API + - Experimental + - Method + - PushManager + - Reference + - Service Workers + - permissionState +translation_of: Web/API/PushManager/permissionState +--- +<p>{{SeeCompatTable}}{{ApiRef("Push API")}}</p> + +<p>{{domxref("PushManager")}} インターフェースの <strong><code>permissionState()</code></strong> メソッドは、プッシュマネージャーの許可状態を示す {{domxref("DOMString")}} で解決される {{jsxref("Promise")}} を返します。許可状態は、<code>'prompt' か</code> <code>'denied'、</code><code>'granted' です。</code></p> + +<div class="note"> +<p><strong>ノート</strong>: Firefox 44 では、<a href="/ja/docs/Web/API/Notifications_API">Notifications</a> と <a href="/ja/docs/Web/API/Push_API">Push</a> の許可は統合されています。notifications が許可された場合、 push も使用できます。</p> +</div> + +<h2 id="構文">構文</h2> + +<pre class="syntaxbox">PushManager.permissionState(options).then(function(PushMessagingState) { ... }); +</pre> + +<h3 id="パラメーター">パラメーター</h3> + +<dl> + <dt><code>options {{optional_inline}}</code></dt> + <dd>オプションの設定パラメーターを含むオブジェクト。次のプロパティが設定可能: + <ul> + <li><code>userVisibleOnly</code>: 返されたプッシュサブスクリプションの効果がユーザーに表示するメッセージにだけ使われるかを示す boolean 値。</li> + </ul> + </dd> +</dl> + +<h3 id="戻り値">戻り値</h3> + +<p><code>'prompt' か </code><code>'denied'、'granted' を持つ </code>{{domxref("DOMString")}} で解決される {{jsxref("Promise")}} 。</p> + +<h2 id="仕様">仕様</h2> + +<table class="standard-table"> + <tbody> + <tr> + <th scope="col">仕様</th> + <th scope="col">状態</th> + <th scope="col">コメント</th> + </tr> + <tr> + <td>{{SpecName('Push API','#widl-PushManager-permissionState-Promise-PushPermissionState--PushSubscriptionOptions-options','permissionState()')}}</td> + <td>{{Spec2('Push API')}}</td> + <td>初期定義。</td> + </tr> + </tbody> +</table> + +<h2 id="ブラウザ実装状況">ブラウザ実装状況</h2> + +<div>{{CompatibilityTable}}</div> + +<div id="compat-desktop"> +<table class="compat-table"> + <tbody> + <tr> + <th>機能</th> + <th>Chrome</th> + <th>Firefox (Gecko)</th> + <th>Internet Explorer</th> + <th>Opera</th> + <th>Safari (WebKit)</th> + </tr> + <tr> + <td>基本サポート</td> + <td>{{CompatChrome(42.0)}}</td> + <td>{{CompatGeckoDesktop(44.0)}}<sup>[1]</sup></td> + <td>{{CompatNo}}</td> + <td>{{CompatUnknown}}</td> + <td>{{CompatNo}}</td> + </tr> + </tbody> +</table> +</div> + +<div id="compat-mobile"> +<table class="compat-table"> + <tbody> + <tr> + <th>機能</th> + <th>Android</th> + <th>Android Webview</th> + <th>Firefox Mobile (Gecko)</th> + <th>Firefox OS</th> + <th>IE Mobile</th> + <th>Opera Mobile</th> + <th>Safari Mobile</th> + <th>Chrome for Android</th> + </tr> + <tr> + <td>基本サポート</td> + <td>{{CompatNo}}</td> + <td>{{CompatNo}}</td> + <td>{{CompatGeckoMobile(48)}}<sup>[2]</sup></td> + <td>{{CompatNo}}</td> + <td>{{CompatNo}}</td> + <td>{{CompatNo}}</td> + <td>{{CompatNo}}</td> + <td>{{CompatChrome(42.0)}}</td> + </tr> + </tbody> +</table> +</div> + +<ul> + <li>[1] Push(と <a href="/ja/docs/Web/API/Service_Worker_API">Service Workers</a>) は、<a href="https://www.mozilla.org/ja/firefox/organizations/">Firefox 45 延長サポート版</a>(ESR)では使用できません。</li> + <li>[2] Firefox for Android 48 から、既定で Push を使用できます。</li> +</ul> + +<h2 id="関連項目">関連項目</h2> + +<ul> + <li><a href="/ja/docs/Web/API/Push_API/Using_the_Push_API">Using the Push API</a></li> +</ul> diff --git a/files/ja/web/api/pushmanager/register/index.html b/files/ja/web/api/pushmanager/register/index.html new file mode 100644 index 0000000000..d71e16d511 --- /dev/null +++ b/files/ja/web/api/pushmanager/register/index.html @@ -0,0 +1,77 @@ +--- +title: PushManager.register() +slug: Web/API/PushManager/register +tags: + - API + - Deprecated + - Method + - Reference + - Simple Push API + - メソッド +translation_of: Web/API/PushManager/register +--- +<div>{{deprecated_header}}{{ ApiRef("Push API")}}</div> + +<p><strong><code>register</code></strong> メソッドは、システムにプッシュ通知の新しい端点をリクエストするために使用します。このメソッドは {{domxref("PushManager.subscribe()")}} に置き換えられました。</p> + +<h2 id="Syntax" name="Syntax">構文</h2> + +<pre class="syntaxbox">var request = navigator.push.register();</pre> + +<h3 id="Return" name="Return">返値</h3> + +<p>{{domxref("DOMRequest")}} オブジェクトで、このメソッド呼び出しの成功または失敗を扱います。</p> + +<p>メソッドの呼び出しに成功したら、リクエストの <code>result</code> が端点の URL を表す文字列になります。</p> + +<div class="note"> +<p><strong>メモ:</strong> この URL が必要なくなったら、 {{domxref("Pushmanager.unregister()")}} を使用して自分自身を掃除してください。</p> +</div> + +<h2 id="Example" name="Example">例</h2> + +<pre class="brush: js">var req = navigator.push.register(); + +req.onsuccess = function(e) { + var endpoint = req.result; + debug("New endpoint: " + endpoint ); +} + +req.onerror = function(e) { + debug("Error getting a new endpoint: " + JSON.stringify(e)); +} +</pre> + +<h2 id="Specifications" name="Specifications">仕様書</h2> + +<table class="standard-table"> + <thead> + <tr> + <th scope="col">仕様書</th> + <th scope="col">状態</th> + <th scope="col">備考</th> + </tr> + </thead> + <tbody> + <tr> + <td>{{SpecName('Push API')}}</td> + <td>{{Spec2('Push API')}}</td> + <td><code>PushManager</code> インターフェイスを定義</td> + </tr> + </tbody> +</table> + +<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2> + +<div> +<div class="hidden">このページの互換性一覧表は構造化データから生成されています。データに協力していただけるのであれば、 <a class="external" href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> をチェックアウトしてプルリクエストを送信してください。</div> + +<p>{{Compat("api.PushManager.register")}}</p> +</div> + +<h2 id="See_also" name="See_also">関連情報</h2> + +<ul> + <li>{{domxref("PushManager")}}</li> + <li>{{domxref("DOMRequest")}}</li> +</ul> diff --git a/files/ja/web/api/pushmanager/registrations/index.html b/files/ja/web/api/pushmanager/registrations/index.html new file mode 100644 index 0000000000..79bebd0156 --- /dev/null +++ b/files/ja/web/api/pushmanager/registrations/index.html @@ -0,0 +1,88 @@ +--- +title: PushManager.registrations() +slug: Web/API/PushManager/registrations +tags: + - API + - Deprecated + - Method + - Reference + - Simple Push API + - メソッド +translation_of: Web/API/PushManager/registrations +--- +<div>{{deprecated_header}}{{ApiRef("Push API")}}</div> + +<p><strong><code>registrations</code></strong> メソッドは、プッシュ通知の端点登録の存在に関してシステムに問い合わせするために使用します。</p> + +<h2 id="Syntax" name="Syntax">構文</h2> + +<pre class="syntaxbox">var request = navigator.push.registrations();</pre> + +<h3 id="Return" name="Return">返値</h3> + +<p>{{domxref("DOMRequest")}} オブジェクトで、このメソッド呼び出しの成功または失敗を扱います。</p> + +<p>メソッドの呼び出しが成功した場合、リクエストの <code>result</code> は {{Anch("PushRegistration")}} オブジェクトの配列になります。</p> + +<h3 id="PushRegistration" name="PushRegistration">PushRegistration</h3> + +<p>このオブジェクトは無名の JavaScript オブジェクトで、以下のプロパティがあります。</p> + +<dl> + <dt><code>pushEndpoint</code></dt> + <dd>端点の URL を表す文字列です。</dd> + <dt><code>version</code></dt> + <dd>プッシュ通知の端点の現在のバージョンです。</dd> +</dl> + +<h2 id="Example" name="Example">例</h2> + +<pre class="brush: js">var req = navigator.push.registrations(); + +req.onsuccess = function(e) { + if (req.result.length > 0) { + for (var i = 0, l = req.result.length; i < l; i++) { + console.log("Existing registration", req.result[i].pushEndpoint, req.result[i].version); + } + // Reuse existing endpoints. + } else { + // Register for a new endpoint. + var register = navigator.push.register(); + register.onsuccess = function(e) { + console.log("Registered new endpoint", register.result); + } + } +} +</pre> + +<h2 id="Specifications" name="Specifications">仕様書</h2> + +<table class="standard-table"> + <thead> + <tr> + <th scope="col">仕様書</th> + <th scope="col">状態</th> + <th scope="col">備考</th> + </tr> + </thead> + <tbody> + <tr> + <td>{{SpecName('Push API')}}</td> + <td>{{Spec2('Push API')}}</td> + <td><code>PushManager</code> インターフェイスを定義</td> + </tr> + </tbody> +</table> + +<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2> + +<div class="hidden">このページの互換性一覧表は構造化データから生成されています。データに協力していただけるのであれば、 <a class="external" href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> をチェックアウトしてプルリクエストを送信してください。</div> + +<p>{{Compat("api.PushManager.registrations")}}</p> + +<h2 id="See_also" name="See_also">関連情報</h2> + +<ul> + <li>{{domxref("PushManager")}}</li> + <li>{{domxref("DOMRequest")}}</li> +</ul> diff --git a/files/ja/web/api/pushmanager/subscribe/index.html b/files/ja/web/api/pushmanager/subscribe/index.html new file mode 100644 index 0000000000..0d2476a88f --- /dev/null +++ b/files/ja/web/api/pushmanager/subscribe/index.html @@ -0,0 +1,105 @@ +--- +title: PushManager.subscribe() +slug: Web/API/PushManager/subscribe +tags: + - API + - Experimental + - Method + - PushManager + - Reference + - Web API + - subscribe +translation_of: Web/API/PushManager/subscribe +--- +<p>{{SeeCompatTable}}{{ApiRef("Push API")}}</p> + +<p>{{domxref("PushManager")}} インターフェースの <strong><code>subscribe()</code></strong> メソッドは、プッシュサービスを提供します。</p> + +<p>これは、プッシュサブスクリプションの詳細を含む {{domxref("PushSubscription")}} オブジェクトで解決される {{jsxref("Promise")}} を返します。現在の service worker に既存のサブスクリプションがない場合、新しいプッシュサブスクリプションが生成されます。</p> + +<h2 id="構文">構文</h2> + +<pre class="syntaxbox">PushManager.subscribe(<em>options</em>).then(function(<em>pushSubscription</em>) { ... } );</pre> + +<h3 id="パラメーター">パラメーター</h3> + +<dl> + <dt><code>options</code> {{optional_inline}}</dt> + <dd>オプションの設定パラメータを含むオブジェクト。次のプロパティを設定できる: + <ul> + <li><code>userVisibleOnly</code>: 返されたプッシュサブスクリプションの効果がユーザーに表示するメッセージにだけ使われるかを示す boolean 値。</li> + <li><code>applicationServerKey</code>: プッシュサーバーがアプリケーションサーバーを認証するために使用する <a href="https://ja.wikipedia.org/wiki/%E6%A5%95%E5%86%86%E6%9B%B2%E7%B7%9ADSA">楕円曲線 DSA</a> P-256 公開鍵を含む、Base64 でエンコードされた {{domxref("DOMString")}} または {{domxref("ArrayBuffer")}}。指定した場合は、アプリケーションサーバーから発するすべてのメッセージで <a href="https://tools.ietf.org/html/rfc8292">VAPID</a> 認証スキームを使用しなければならず、また対応する秘密鍵で署名した JWT を含めなければなりません。この鍵は、データを暗号化するために使用する ECDH 鍵と<em><strong>同じではありません</strong></em>。詳しくは "<a href="https://blog.mozilla.org/services/2016/04/04/using-vapid-with-webpush/">Using VAPID with WebPush</a>" をご覧ください。</li> + </ul> + + <div class="note"> + <p><em><strong>注記:</strong> この引数は Chrome など、一部のブラウザーで必須です。</em></p> + </div> + </dd> +</dl> + +<h3 id="戻り値">戻り値</h3> + +<p>{{domxref("PushSubscription")}} オブジェクトを解決する {{jsxref("Promise")}} 。</p> + +<h2 id="例">例</h2> + +<pre class="brush: js">this.onpush = function(event) { + console.log(event.data); + // ここから、IndexedDB にデータを書き込んだり、いずれかのウィンドウに + // それを送信したり、通知を表示したりできます。 +} + +navigator.serviceWorker.register('serviceworker.js'); + +// Use serviceWorker.ready to ensure that you can subscribe for push +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); + } + ); + });</pre> + +<h2 id="仕様">仕様</h2> + +<table class="standard-table"> + <tbody> + <tr> + <th scope="col">仕様</th> + <th scope="col">状態</th> + <th scope="col">コメント</th> + </tr> + <tr> + <td>{{SpecName('Push API', '#widl-PushManager-subscribe-Promise-PushSubscription--PushSubscriptionOptions-options', 'subscribe()')}}</td> + <td>{{Spec2('Push API')}}</td> + <td>初期定義</td> + </tr> + </tbody> +</table> + +<h2 id="ブラウザ実装状況">ブラウザ実装状況</h2> + +<div> + + +<p>{{Compat("api.PushManager.subscribe")}}</p> +</div> + +<h2 id="関連項目">関連項目</h2> + +<ul> + <li><a href="/ja/docs/Web/API/Push_API/Using_the_Push_API">Using the Push API</a></li> +</ul> diff --git a/files/ja/web/api/pushmanager/unregister/index.html b/files/ja/web/api/pushmanager/unregister/index.html new file mode 100644 index 0000000000..b0eea07f96 --- /dev/null +++ b/files/ja/web/api/pushmanager/unregister/index.html @@ -0,0 +1,89 @@ +--- +title: PushManager.unregister() +slug: Web/API/PushManager/unregister +tags: + - API + - Deprecated + - Method + - Reference + - Simple Push API + - メソッド +translation_of: Web/API/PushManager/unregister +--- +<div>{{deprecated_header}}{{ ApiRef("Push API")}}</div> + +<p><strong><code>unregister()</code></strong> メソッドは、システムに特定の端点の登録を解除して削除するよう依頼するために使用していました。更新された API では、加入は {{domxref("PushSubscription.unsubscribe()")}} メソッドで登録解除することができます。</p> + +<h2 id="Syntax" name="Syntax">構文</h2> + +<pre class="syntaxbox">var <var>request</var> = navigator.push.unregister(<var>pushEndpoint</var>);</pre> + +<h3 id="Properties" name="Properties">プロパティ</h3> + +<dl> + <dt>pushEndpoint</dt> + <dd>登録解除する端点です。</dd> +</dl> + +<h3 id="Return" name="Return">返値</h3> + +<p>{{domxref("DOMRequest")}} オブジェクトで、このメソッド呼び出しの成功または失敗を扱います。</p> + +<p>メソッドの呼び出しが成功した場合、リクエストの <code>result</code> が登録解除された端点を表す {{Anch("PushRegistration")}} オブジェクトになります。</p> + +<h3 id="PushRegistration">PushRegistration</h3> + +<p>このオブジェクトは無名の JavaScript オブジェクトで、以下のプロパティがあります。</p> + +<dl> + <dt><code>pushEndpoint</code></dt> + <dd>端点の URL を表す文字列です。</dd> + <dt><code>version</code></dt> + <dd>プッシュ通知の端点の現在のバージョンです。</dd> +</dl> + +<h2 id="Example" name="Example">例</h2> + +<pre class="brush: js">var req = navigator.push.unregister(pushEndpoint); + +req.onsuccess = function(e) { + var endpoint = req.result; + debug("Unregistered endpoint: " + endpoint ); +} + +req.onerror = function(e) { + debug("Error unregistering the endpoint: " + JSON.stringify(e)); +} +</pre> + +<h2 id="Specifications" name="Specifications">仕様書</h2> + +<table class="standard-table"> + <thead> + <tr> + <th scope="col">仕様書</th> + <th scope="col">状態</th> + <th scope="col">備考</th> + </tr> + </thead> + <tbody> + <tr> + <td>{{SpecName('Push API')}}</td> + <td>{{Spec2('Push API')}}</td> + <td><code>PushManager</code> インターフェイスを定義</td> + </tr> + </tbody> +</table> + +<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2> + +<div class="hidden">このページの互換性一覧表は構造化データから生成されています。データに協力していただけるのであれば、 <a class="external" href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> をチェックアウトしてプルリクエストを送信してください。</div> + +<p>{{Compat("api.PushManager.register")}}</p> + +<h2 id="See_also" name="See_also">関連情報</h2> + +<ul> + <li>{{domxref("PushManager")}}</li> + <li>{{domxref("DOMRequest")}}</li> +</ul> |