ServiceWorkerRegistration - Web API 接口参考 编辑

这是一个实验中的功能
此功能某些浏览器尚在开发中，请参考浏览器兼容性表格以得到在不同浏览器中适合使用的前缀。由于该功能对应的标准文档可能被重新修订，所以在未来版本的浏览器中该功能的语法和行为可能随之改变。

The ServiceWorkerRegistration interface of the ServiceWorker API represents the service worker registration. You register a service worker to control one or more pages that share the same origin.

The lifetime of a service worker registration is beyond that of the ServiceWorkerRegistration objects that represent them within the lifetime of their corresponding service worker clients. The browser maintains a persistent list of active ServiceWorkerRegistration objects.

Note: This feature is available in Web Workers.

Properties

Also implements properties from its parent interface, EventTarget.

ServiceWorkerRegistration.scope 只读

Returns a unique identifier for a service worker registration. This must be on the same origin as the document that registers the ServiceWorker.

ServiceWorkerRegistration.installing 只读

Returns a service worker whose state is installing. This is initially set to null.

ServiceWorkerRegistration.waiting 只读

Returns a service worker whose state is installed. This is initially set to null.

ServiceWorkerRegistration.active 只读

Returns a service worker whose state is either activating or activated. This is initially set to null. An active worker will control a ServiceWorkerClient if the client's URL falls within the scope of the registration (the scope option set when ServiceWorkerContainer.register is first called.)

serviceWorkerRegistration.periodicSync 只读

Returns a reference to the PeriodicSyncManager interface, which manages periodic background synchronization processes.

ServiceWorkerRegistration.pushManager 只读

Returns a reference to the PushManager interface for managing push subscriptions including subscribing, getting an active subscription, and accessing push permission status.

ServiceWorkerRegistration.sync  只读  

Returns a reference to the SyncManager interface, which manages background synchronization processes.

Event handlers

ServiceWorkerRegistration.onupdatefound 只读

An EventListener property called whenever an event of type updatefound is fired; it is fired any time the ServiceWorkerRegistration.installing property acquires a new service worker.

Methods

Also implements methods from its parent interface, EventTarget.

ServiceWorkerRegistration.getNotifications()

Returns a Promise that resolves to an array of Notification objects.

ServiceWorkerRegistration.showNotification()

Displays the notification with the requested title.

ServiceWorkerRegistration.update()

Checks the server for an updated version of the service worker without consulting caches.

ServiceWorkerRegistration.unregister()

Unregisters the service worker registration and returns a promise (see Promise). The service worker will finish any ongoing operations before it is unregistered.

Examples

This code snippet is from the service worker registration-events sample (live demo). The code checks to see if the browser supports service workers and if there's currently a service worker handling requests on this page for the current navigation.

Any new service workers are registered; if there's an existing service worker, the code overrides its default scope so that the registration applies to the current directory and everything underneath it. The example also reports any registration failures.

if ('serviceWorker' in navigator) {
  document.querySelector('#availability').innerText = 'are';
  document.querySelector('#controlled').innerText = navigator.serviceWorker.controller ? 'is' : 'is not';
  navigator.serviceWorker.register('service-worker.js', {scope: './'}).then(function(registration) {
    document.querySelector('#register').textContent = 'succeeded';
  }).catch(function(error) {
    document.querySelector('#register').textContent = 'failed: ' + error;
  });
} else {
  document.querySelector('#availability').innerText = 'are not';
}

Specifications

Specification	Status	Comment
Service Workers ServiceWorkerRegistration	Working Draft	Initial definition.
Push API PushManager	Working Draft	Adds the pushManager property.
Notifications API	Living Standard	Adds the showNotification() method and the getNotifications() method.
Web Background Synchronization	Living Standard	Adds the sync property.

Browser compatibility

We're converting our compatibility data into a machine-readable JSON format. This compatibility table still uses the old format, because we haven't yet converted the data it contains. Find out how you can help!

• Desktop
• Mobile

Feature	Chrome	Firefox (Gecko)	Internet Explorer	Opera	Safari (WebKit)
Basic support	40.0	44.0 (44.0)[1]	未实现	?	未实现
Available in web workers	(Yes)	44.0 (44.0)[1]	未实现	?	未实现
getNotifications(), showNotification()	(Yes)	46.0 (46.0)[1]	未实现	?	未实现
sync property	49.0

Feature	Android	Android Webview	Firefox Mobile (Gecko)	Firefox OS	IE Mobile	Opera Mobile	Safari Mobile	Chrome for Android
Basic support	未实现	未实现	44.0 (44.0)	(Yes)	未实现	?	未实现	40.0
Available in web workers	未实现	未实现	44.0 (44.0)	(Yes)	未实现	?	未实现	(Yes)
getNotifications(), showNotification()	未实现	未实现	46.0 (46.0)	(Yes)	未实现	?	未实现	(Yes)
sync property	未实现	未实现						49.0

[1] Service workers (and Push) have been disabled in the Firefox 45 and 52 Extended Support Releases (ESR.)

See also

• Using Service Workers
• Service workers basic code example
• Is ServiceWorker ready?
• Promise
• Using web workers