5 lines
12 KiB
JSON
5 lines
12 KiB
JSON
{
|
|
"id": "api/service-worker/SwUpdate",
|
|
"title": "SwUpdate",
|
|
"contents": "\n\n<article>\n <div class=\"breadcrumb-container\">\n <div class=\"breadcrumb\">\n <script type=\"application/ld+json\">\n {\n \"@context\": \"http://schema.org\",\n \"@type\": \"BreadcrumbList\",\n \"itemListElement\": [\n { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://angular.io//api\", \"name\": \"API\" } },\n { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://angular.io/api/service-worker\", \"name\": \"@angular/service-worker\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/service-worker/SwUpdate\", \"name\": \"SwUpdate\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/service-worker\">@angular/service-worker</a>\n </div>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/service-worker/src/update.ts?message=docs(service-worker)%3A%20describe%20your%20change...#L13-L78\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/service-worker/src/update.ts#L13-L78\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n \n <header class=\"api-header\">\n <h1 id=\"swupdate\">SwUpdate<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/service-worker/SwUpdate#swupdate\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label class\">class</label>\n \n \n \n </header>\n \n <aio-toc class=\"embedded\"></aio-toc>\n\n <div class=\"api-body\">\n \n <section class=\"short-description\">\n <p>Subscribe to update notifications from the Service Worker, trigger update\nchecks, and forcibly activate updates.</p>\n\n \n </section>\n \n \n \n <section class=\"class-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nclass <a href=\"api/service-worker/SwUpdate\" class=\"code-anchor\">SwUpdate</a> {\n <a class=\"code-anchor\" href=\"api/service-worker/SwUpdate#available\"><span class=\"member-name\">available</span>: Observable<UpdateAvailableEvent></a>\n <a class=\"code-anchor\" href=\"api/service-worker/SwUpdate#activated\"><span class=\"member-name\">activated</span>: Observable<UpdateActivatedEvent></a>\n <a class=\"code-anchor\" href=\"api/service-worker/SwUpdate#unrecoverable\"><span class=\"member-name\">unrecoverable</span>: Observable<UnrecoverableStateEvent></a>\n <a class=\"code-anchor\" href=\"api/service-worker/SwUpdate#isEnabled\"><span class=\"member-name\">isEnabled</span>: boolean</a>\n <a class=\"code-anchor\" href=\"api/service-worker/SwUpdate#checkForUpdate\"><span class=\"member-name\">checkForUpdate</span>(): Promise<void></a>\n <a class=\"code-anchor\" href=\"api/service-worker/SwUpdate#activateUpdate\"><span class=\"member-name\">activateUpdate</span>(): Promise<void></a>\n}\n</code-example>\n\n \n \n\n</section>\n\n\n \n<section class=\"see-also\">\n <h2 id=\"see-also\">See also<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/service-worker/SwUpdate#see-also\"><i class=\"material-icons\">link</i></a></h2>\n <ul>\n \n <li><a href=\"guide/service-worker-communications\">Service worker communication guide</a>\n</li>\n </ul>\n</section>\n\n\n \n \n \n\n\n\n\n\n\n\n\n<section class=\"instance-properties\">\n <h2 id=\"properties\">Properties<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/service-worker/SwUpdate#properties\"><i class=\"material-icons\">link</i></a></h2>\n <table class=\"is-full-width list-table property-table\">\n <thead>\n <tr>\n <th>Property</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"available\"></a>\n <code class=\"\"><span class=\"member-name\">available</span>: Observable<<a href=\"api/service-worker/UpdateAvailableEvent\" class=\"code-anchor\">UpdateAvailableEvent</a>></code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Emits an <code><a href=\"api/service-worker/UpdateAvailableEvent\" class=\"code-anchor\">UpdateAvailableEvent</a></code> event whenever a new app version is available.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"activated\"></a>\n <code class=\"\"><span class=\"member-name\">activated</span>: Observable<<a href=\"api/service-worker/UpdateActivatedEvent\" class=\"code-anchor\">UpdateActivatedEvent</a>></code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Emits an <code><a href=\"api/service-worker/UpdateActivatedEvent\" class=\"code-anchor\">UpdateActivatedEvent</a></code> event whenever the app has been updated to a new version.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"unrecoverable\"></a>\n <code class=\"\"><span class=\"member-name\">unrecoverable</span>: Observable<<a href=\"api/service-worker/UnrecoverableStateEvent\" class=\"code-anchor\">UnrecoverableStateEvent</a>></code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Emits an <code><a href=\"api/service-worker/UnrecoverableStateEvent\" class=\"code-anchor\">UnrecoverableStateEvent</a></code> event whenever the version of the app used by the service\nworker to serve this client is in a broken state that cannot be recovered from without a full\npage reload.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"isEnabled\"></a>\n <code class=\"\"><span class=\"member-name\">isEnabled</span>: boolean</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>True if the Service Worker is enabled (supported by the browser and enabled via\n<code><a href=\"api/service-worker/ServiceWorkerModule\" class=\"code-anchor\">ServiceWorkerModule</a></code>).</p>\n\n \n </td>\n </tr>\n \n </tbody>\n </table>\n</section>\n\n\n\n<section class=\"instance-methods\">\n <h2 id=\"methods\">Methods<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/service-worker/SwUpdate#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"checkForUpdate\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"checkforupdate\">\n checkForUpdate()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/service-worker/SwUpdate#checkforupdate\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/service-worker/src/update.ts?message=docs(service-worker)%3A%20describe%20your%20change...#L62-L69\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/service-worker/src/update.ts#L62-L69\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n \n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">checkForUpdate</span>(): Promise<void></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns\">Returns</h6>\n <p><code>Promise<void></code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"activateUpdate\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"activateupdate\">\n activateUpdate()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/service-worker/SwUpdate#activateupdate\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/service-worker/src/update.ts?message=docs(service-worker)%3A%20describe%20your%20change...#L70-L77\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/service-worker/src/update.ts#L70-L77\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n \n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">activateUpdate</span>(): Promise<void></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-1\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns-1\">Returns</h6>\n <p><code>Promise<void></code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n</section>\n\n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/service-worker\n - api/service-worker/ServiceWorkerModule\n - api/service-worker/SwRegistrationOptions\n - guide/service-worker-communications\n - guide/service-worker-config\n - guide/service-worker-devops\n - guide/service-worker-intro\n-->\n<!-- links from this doc:\n - /api\n - api/service-worker\n - api/service-worker/ServiceWorkerModule\n - api/service-worker/SwUpdate#activateUpdate\n - api/service-worker/SwUpdate#activated\n - api/service-worker/SwUpdate#activateupdate\n - api/service-worker/SwUpdate#available\n - api/service-worker/SwUpdate#checkForUpdate\n - api/service-worker/SwUpdate#checkforupdate\n - api/service-worker/SwUpdate#isEnabled\n - api/service-worker/SwUpdate#methods\n - api/service-worker/SwUpdate#properties\n - api/service-worker/SwUpdate#see-also\n - api/service-worker/SwUpdate#swupdate\n - api/service-worker/SwUpdate#unrecoverable\n - api/service-worker/UnrecoverableStateEvent\n - api/service-worker/UpdateActivatedEvent\n - api/service-worker/UpdateAvailableEvent\n - guide/service-worker-communications\n - https://github.com/angular/angular/edit/master/packages/service-worker/src/update.ts?message=docs(service-worker)%3A%20describe%20your%20change...#L13-L78\n - https://github.com/angular/angular/edit/master/packages/service-worker/src/update.ts?message=docs(service-worker)%3A%20describe%20your%20change...#L62-L69\n - https://github.com/angular/angular/edit/master/packages/service-worker/src/update.ts?message=docs(service-worker)%3A%20describe%20your%20change...#L70-L77\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/service-worker/src/update.ts#L13-L78\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/service-worker/src/update.ts#L62-L69\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/service-worker/src/update.ts#L70-L77\n-->"
|
|
} |