NDEFReader: write()-Methode

message

Die zu schreibende Nachricht, entweder ein String, ein ArrayBuffer, ein TypedArray, ein DataView oder ein Array von Datensätzen. Ein Datensatz hat die folgenden Mitglieder:

data Optional

Enthält die zu übertragenden Daten, entweder ein String, ein ArrayBuffer, ein TypedArray, ein DataView oder ein Array von verschachtelten Datensätzen

encoding Optional

Ein String, der die Kodierung des Datensatzes angibt.

id Optional

Eine vom Entwickler definierte Kennung für den Datensatz.

lang Optional

Ein gültiges Sprach-Tag entsprechend RFC 5646: Tags for Identifying Languages (auch bekannt als BCP 47).

mediaType Optional

Ein gültiger MIME-Typ.

recordType

Ein String, der den Typ der in data gespeicherten Daten angibt. Es muss einer der folgenden Werte sein:

"absolute-url"

Eine absolute URL zu den Daten.

"empty"

Ein leerer NDEFRecord.

"mime"

Ein gültiger MIME-Typ.

"smart-poster"

Ein Smart-Poster wie in der NDEF-SMARTPOSTER Spezifikation definiert.

"text"

Text wie in der NDEF-TEXT Spezifikation definiert.

"unknown"

Der Datensatztyp ist unbekannt.

"URL"

Eine URL wie in der NDEF-URI Spezifikation definiert.

options Optional

Ein Objekt mit den folgenden Eigenschaften:

overwrite

Ein boolescher Wert, der angibt, ob vorhandene Datensätze überschrieben werden sollen, falls solche existieren.

signal Optional

Ein AbortSignal, das es ermöglicht, den aktuellen Schreibvorgang abzubrechen.

Ein Promise, das entweder aufgelöst wird, wenn eine Nachricht auf das Tag geschrieben wurde, oder abgelehnt wird, wenn ein Hardware- oder Berechtigungsfehler auftritt.

Diese Methode wirft keine Ausnahmen; stattdessen wird das zurückgegebene Promise abgelehnt und ein DOMException übergeben, dessen name einer der folgenden ist:

AbortError

Der Scan-Vorgang wurde mit dem in den options-Argumenten übergebenen AbortSignal abgebrochen.

NotAllowedError

Die Berechtigung für diese Operation wurde abgelehnt oder overwrite ist false und es gibt bereits Datensätze auf dem Tag.

NotSupportedError

Es gibt keinen mit Web NFC kompatiblen NFC-Adapter, oder der verfügbare NFC-Adapter unterstützt das Senden von Nachrichten nicht oder die Verbindung kann nicht hergestellt werden.

NotReadableError

Der UA darf nicht auf den zugrunde liegenden NFC-Adapter zugreifen (z.B. aufgrund von Benutzereinstellung).

NetworkError

Übertragung nach dem Start fehlgeschlagen (z.B. das Tag wurde vom Leser entfernt).

Das folgende Beispiel zeigt, wie ein String auf ein NFC-Tag geschrieben wird und wie auftretende Fehler verarbeitet werden.

const ndef = new NDEFReader();
ndef
  .write("Hello World")
  .then(() => {
    console.log("Message written.");
  })
  .catch((error) => {
    console.log(`Write failed :-( try again: ${error}.`);
  });

Das folgende Beispiel zeigt, wie ein oben beschriebener Datensatz auf ein NFC-Tag geschrieben wird und wie auftretende Fehler verarbeitet werden.

const ndef = new NDEFReader();
try {
  await ndef.write({
    records: [{ recordType: "url", data: "http://example.com/" }],
  });
} catch {
  console.log("Write failed :-( try again.");
}

Es ist manchmal nützlich, eine zeitliche Begrenzung für einen Schreibvorgang festzulegen. Zum Beispiel bitten Sie den Benutzer, ein Tag zu berühren, aber kein Tag wird innerhalb einer bestimmten Zeitspanne gefunden, dann erfolgt ein Timeout.

const ndef = new NDEFReader();
ndef.onreading = (event) => console.log("We read a tag!");

function write(data, { timeout } = {}) {
  return new Promise((resolve, reject) => {
    const controller = new AbortController();
    controller.signal.onabort = () => reject("Time is up, bailing out!");
    setTimeout(() => controller.abort(), timeout);

    ndef.addEventListener(
      "reading",
      (event) => {
        ndef.write(data, { signal: controller.signal }).then(resolve, reject);
      },
      { once: true },
    );
  });
}

await ndef.scan();
try {
  // Let's wait for 5 seconds only.
  await write("Hello World", { timeout: 5_000 });
} catch (err) {
  console.error("Something went wrong", err);
} finally {
  console.log("We wrote to a tag!");
}