BackgroundFetchRegistration

Instanz-Eigenschaften

Erbt auch Eigenschaften von seinem bergeordneten Objekt, EventTarget.

BackgroundFetchRegistration.id Schreibgeschtzt

Ein String, der die ID des Hintergrundabrufs enthlt.

BackgroundFetchRegistration.uploadTotal Schreibgeschtzt

Ein Number, das die Gesamtanzahl der zu hochladenden Bytes enthlt.

BackgroundFetchRegistration.uploaded Schreibgeschtzt

Ein Number, das die erfolgreich gesendete Gre in Bytes enthlt, anfangs 0.

BackgroundFetchRegistration.downloadTotal Schreibgeschtzt

Ein Number, das die Gesamtanzahl in Bytes dieses Downloads enthlt. Dies ist der Wert, der beim Registrieren des Hintergrundabrufs festgelegt wurde, oder 0.

BackgroundFetchRegistration.downloaded Schreibgeschtzt

Ein Number, das die Anzahl der heruntergeladenen Bytes enthlt, anfangs 0.

BackgroundFetchRegistration.result Schreibgeschtzt

Gibt anfangs einen leeren String zurck, bei Abschluss entweder den String "success" oder "failure".

BackgroundFetchRegistration.failureReason Schreibgeschtzt

Ein String mit einem Wert, der einen Grund fr einen Fehlschlag des Hintergrundabrufs angibt. Kann einen der folgenden Werte haben: "", "aborted", "bad-status", "fetch-error", "quota-exceeded", "download-total-exceeded".

BackgroundFetchRegistration.recordsAvailable Schreibgeschtzt

Ein Boolean, der anzeigt, ob das recordsAvailable-Flag gesetzt ist.

Instanz-Methoden

Erbt auch Methoden von seinem bergeordneten Objekt, EventTarget.

BackgroundFetchRegistration.abort()

Bricht den Hintergrundabruf ab. Gibt ein Promise zurck, das mit true aufgelst wird, wenn der Abruf erfolgreich abgebrochen wurde.

BackgroundFetchRegistration.match()

Gibt ein einzelnes BackgroundFetchRecord-Objekt zurck, das die erste bereinstimmung fr die Argumente darstellt.

BackgroundFetchRegistration.matchAll()

Gibt ein Promise zurck, das mit einem Array von BackgroundFetchRecord-Objekten aufgelst wird, die Anfragen und Antworten enthalten.

Ereignisse

Erbt auch Ereignisse von seinem bergeordneten Objekt, EventTarget.

Diese Ereignisse knnen mit addEventListener() berwacht werden, oder indem ein Ereignis-Listener der oneventname-Eigenschaft dieser Schnittstelle zugewiesen wird.

progress

Wird ausgelst, wenn sich einer der folgenden Eigenschaften ndert: uploaded, downloaded, result oder failureReason.

Beispiele

Der folgende Code erstellt ein BackGroundFetchRegistration als bgFetch mit einer id von "my-fetch".

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",
        },
      ],
      downloadTotal: 60 * 1024 * 1024,
    },
  );
});

Das Protokollieren der id zur Konsole gibt "my-fetch" zurck.

console.log(bgFetch.id); // "my-fetch"

Die match()-Methode kann verwendet werden, um einen bestimmten BackgroundFetchRecord zu finden, der zu der Registrierung gehrt.

bgFetch.match("/ep-5.mp3").then(async (record) => {
  if (!record) {
    console.log("No record found");
    return;
  }

  console.log(`Here's the request`, record.request);
  const response = await record.responseReady;
  console.log(`And here's the response`, response);
});

Spezifikationen

Browser-Kompatibilitt