Anleitung
NFC in Capacitor nutzen
Mit @capgo/capacitor-nfc
Öffentliche API-Oberfläche für das Capacitor NFC-Plugin.
Installieren
bun add @capgo/capacitor-nfc
bunx cap sync
bunx cap sync kopiert den nativen code des Plugins in deine nativen Projekte. Nach jedem Plugin-Upgrade erneut ausführen.
Importieren
import { CapacitorNfc } from '@capgo/capacitor-nfc';
API auf einen Blick
| Methode | Beschreibung |
|---|---|
startScanning |
Beginnt, auf NFC-Tags zu lauschen. |
stopScanning |
Beendet die laufende NFC-Scan-Session. |
write |
Schreibt die bereitgestellten NDEF-Records auf den zuletzt erkannten Tag. |
erase |
Versucht, den zuletzt erkannten Tag durch Schreiben einer leeren NDEF-Message zu löschen. |
makeReadOnly |
Versucht, den zuletzt erkannten Tag schreibgeschützt zu machen. |
share |
Teilt eine NDEF-Nachricht via Peer-to-Peer mit einem anderen Gerät (nur Android). |
unshare |
Beendet das Teilen der zuvor bereitgestellten NDEF-Nachricht (nur Android). |
getStatus |
Gibt den aktuellen Status des NFC-Adapters zurück. |
showSettings |
Öffnet die Systemeinstellungen, in denen der Benutzer NFC aktivieren kann. |
isSupported |
Prüft, ob das Gerät NFC-Hardware unterstützt. |
Beispiele
startScanning()
Beginnt, auf NFC-Tags zu lauschen.
import { CapacitorNfc } from '@capgo/capacitor-nfc';
await CapacitorNfc.startScanning();
stopScanning()
Beendet die laufende NFC-Scan-Session.
import { CapacitorNfc } from '@capgo/capacitor-nfc';
await CapacitorNfc.stopScanning();
write()
Schreibt die bereitgestellten NDEF-Records auf den zuletzt erkannten Tag.
import { CapacitorNfc } from '@capgo/capacitor-nfc';
await CapacitorNfc.write({
records: [
{
tnf: 1,
type: [1],
id: [1],
payload: [1],
},
],
});
erase()
Versucht, den zuletzt erkannten Tag durch Schreiben einer leeren NDEF-Message zu löschen.
import { CapacitorNfc } from '@capgo/capacitor-nfc';
await CapacitorNfc.erase();
makeReadOnly()
Versucht, den zuletzt erkannten Tag schreibgeschützt zu machen.
import { CapacitorNfc } from '@capgo/capacitor-nfc';
await CapacitorNfc.makeReadOnly();
share()
Teilt eine NDEF-Nachricht via Peer-to-Peer mit einem anderen Gerät (nur Android).
import { CapacitorNfc } from '@capgo/capacitor-nfc';
await CapacitorNfc.share({
records: [
{
tnf: 1,
type: [1],
id: [1],
payload: [1],
},
],
});
Die obige Tabelle listet die 10 Kernmethoden auf. Listener- und Versions-Helper sowie der vollständige Contract jeder Methode sind dokumentiert in GitHub Repository.
Events abonnieren
addListener gibt ein Handle zurück. Rufe handle.remove() wenn der Screen unmountet wird.
Vollständige Referenz
Weiter geht's nach „Using @capgo/capacitor-nfc“
Wenn du es nutzt Mit @capgo/capacitor-nfc um Dashboard- und API-Operationen zu planen, verbinde es mit @capgo/capacitor-nfc für die Implementierungsdetails in @capgo/capacitor-nfc, Erste Schritte für die Implementierungsdetails in Erste Schritte, API Übersicht für Details zur Implementierung im API Overview, Einführung für die Implementierungsdetails in der Einleitung und API Schlüssel für die Implementierungsdetails in den API Keys.