Diefetch() Methode derBackgroundFetchManager Schnittstelle initiiert einen Hintergrundabrufvorgang, gegeben durch eine oder mehrere URLs oderRequest Objekte.

Syntax

fetch(id, requests)fetch(id, requests, options)

Parameter

id

Eine vom Entwickler definierte Kennung, die an die anderen Methoden übergeben werden kann, um dieBackgroundFetchRegistration für diesen Vorgang abzurufen.

requests

EinRequestInfo Objekt oder ein Array vonRequestInfo Objekten.

JedesRequestInfo Objekt ist einRequest Objekt oder ein String, der alsinput Argument an denRequest() Konstruktor übergeben wird.

optionsOptional

Ein Objekt, das verwendet wird, um den Fortschrittsdialog des Abrufs anzupassen, den der Browser dem Benutzer anzeigt. Es hat die folgenden Eigenschaften:

titleOptional

Ein String, der als Titel für den Fortschrittsdialog verwendet wird.

iconsOptional

Ein Array von Objekten, wobei jedes Objekt ein Symbol darstellt, das der Browser möglicherweise für den Fortschrittsdialog verwendet. Jedes Objekt hat die folgenden Eigenschaften:

src

Ein String, der eine URL zur Symboldatei darstellt.

sizesOptional

Ein String, der die Größen des Bildes darstellt, ausgedrückt mit der gleichen Syntax wie dassizes Attribut des<link> Elements.

typeOptional

Ein String, der denMIME Typ des Symbols darstellt.

labelOptional

Ein String, der den zugänglichen Namen des Symbols darstellt.

downloadTotalOptional

Eine Zahl, die die geschätzte Gesamtgröße des Downloads in Bytes für den Abrufvorgang darstellt. Diese wird verwendet, um dem Benutzer anzuzeigen, wie groß der Download ist, und um den Benutzer über den Fortschritt des Downloads zu informieren.

Sobald die Gesamtgröße des DownloadsdownloadTotal überschreitet, wird der Abruf abgebrochen.

Rückgabewert

EinPromise, das mit einemBackgroundFetchRegistration Objekt aufgelöst wird.

Ausnahmen

TypeError

Wird ausgelöst, wenn keine Anfrage bereitgestellt wird, wenn der Modus einer Anfrageno-cors ist, wenn kein Service Worker vorhanden ist, wenn eine Anfrage bereits mit der angefordertenid existiert oder die Anfrage fehlschlägt.

AbortErrorDOMException

Gibt an, dass der Abruf abgebrochen wurde.

NotAllowedErrorDOMException

Gibt an, dass keine Benutzererlaubnis erteilt wurde, um Hintergrundabrufe auszuführen.

QuotaExceededError

Wird ausgelöst, wenn das Speichern von Anfragen aufgrund Überschreitung des Browser-Speicherquotas nicht möglich war.

Beispiele

Das folgende Beispiel zeigt, wiefetch() verwendet wird, um einen Hintergrundabrufvorgang zu starten. Mit einem aktivenService Worker verwenden Sie dieServiceWorkerRegistration.backgroundFetch Eigenschaft, um auf dasBackgroundFetchManager Objekt zuzugreifen und rufen Sie dessenfetch()Methode auf.

navigator.serviceWorker.ready.then(async (swReg) => {  const bgFetch = await swReg.backgroundFetch.fetch(    "my-fetch",    ["/ep-5.mp3", "ep-5-artwork.jpg"],    {      title: "Episode 5: Interesting things.",      icons: [        {          sizes: "300x300",          src: "/ep-5-icon.png",          type: "image/png",          label: "Downloading a show",        },      ],      downloadTotal: 60 * 1024 * 1024,    },  );});

Spezifikationen

Browser-Kompatibilität