cargdev/angular
1
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(service-worker): add example app for SwPush API docs (#32139)

Browse Source 
Previously, the `SwPush` API docs were using hard-coded code snippets.

This commit switches to using code snippets from an actual example app,
which ensures that the code shown in the docs will at least continue to
compile successfully.

PR Close #32139
This commit is contained in:
George Kalpakas
2019-08-27 23:17:51 +03:00
committed by atscott
parent ac11a0be15
commit 65aaffcfe4
7 changed files with 196 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
packages/service-worker/src/push.ts
View File

@ -23,30 +23,14 @@ import {ERR_SW_NOT_SUPPORTED, NgswCommChannel, PushEvent} from './low_level';
* You can inject a `SwPush` instance into any component or service
* as a dependency.
*
* ```ts
* import {SwPush} from '@angular/service-worker';
* ...
* constructor(private swPush: SwPush) {}
* ...
* ```
* <code-example path="service-worker/push/module.ts" region="inject-sw-push" header="app.component.ts"></code-example>
*
* To subscribe, call `SwPush.requestSubscription()`, which asks the user for permission.
* The call returns a `Promise` with a new
* [`PushSubscription`](https://developer.mozilla.org/en-US/docs/Web/API/PushSubscription)
* instance.
*
* ```ts
* async subscribeToPush() {
* try {
* const sub = await this.swPush.requestSubscription({
* serverPublicKey: PUBLIC_VAPID_KEY_OF_SERVER,
* });
* // TODO: Send to server.
* } catch (e) {
* console.error('Could not subscribe:', e);
* }
* }
* ```
* <code-example path="service-worker/push/module.ts" region="subscribe-to-push" header="app.component.ts"></code-example>
*
* A request is rejected if the user denies permission, or if the browser
* blocks or does not support the Push API or ServiceWorkers.
@ -90,11 +74,7 @@ import {ERR_SW_NOT_SUPPORTED, NgswCommChannel, PushEvent} from './low_level';
* An application can subscribe to `SwPush.notificationClicks` observable to be notified when a user
* clicks on a notification. For example:
*
* ```ts
* swPush.notificationClicks.subscribe(({action, notification}) => {
* // TODO: Do something in response to notification click.
* });
* ```
* <code-example path="service-worker/push/module.ts" region="subscribe-to-notification-clicks" header="app.component.ts"></code-example>
*
* @see [Push Notifications](https://developers.google.com/web/fundamentals/codelabs/push-notifications/)
* @see [Angular Push Notifications](https://blog.angular-university.io/angular-push-notifications/)