ServiceWorkerGlobalScope: backgroundfetchclick event

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

addEventListener("backgroundfetchclick", (event) => { })

onbackgroundfetchclick = (event) => { }

Event type

A BackgroundFetchEvent.

Event properties

Inherits properties from its parent, ExtendableEvent.

BackgroundFetchEvent.registration

Returns the BackgroundFetchRegistration whose progress dialog the user clicked on.

Description

When a background fetch operation starts, the browser shows a UI element to the user to indicate the progress of the operation. If the user clicks this element, the browser starts the service worker, if necessary, and fires the backgroundfetchclick event in the service worker's global scope.

A common task for the handler in this situation is to open a window giving the user more details about the fetch operation.

Examples

Opening a window with more details

This event handler uses the global clients property to open a window giving the user more details about the fetch. It opens a different window depending on whether the fetch has completed or not.

addEventListener("backgroundfetchclick", (event) => {
  const registration = event.registration;

  if (registration.result === "success") {
    clients.openWindow("/play-movie");
  } else {
    clients.openWindow("/movie-download-progress");
  }
});

Specifications

Browser compatibility

See also

• Background Fetch API