NFC Plugin Capacitor

Utiliser @capgo/capacitor-nfc

Surface publique API pour le plugin NFC Capacitor.

Installer

bun add @capgo/capacitor-nfc
bunx cap sync

bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.

Importer

import { CapacitorNfc } from '@capgo/capacitor-nfc';

Aperçu de API

Méthode	Description
startScanning	Lance l'écoute des tags NFC.
stopScanning	Arrête la session de scan NFC en cours.
write	Écrit les enregistrements NDEF fournis sur le dernier tag détecté.
erase	Tente d'effacer le dernier tag détecté en écrivant un message NDEF vide.
makeReadOnly	Tente de passer le dernier tag détecté en lecture seule.
share	Partage un message NDEF avec un autre appareil via peer-to-peer (Android uniquement).
unshare	Arrête le partage du message NDEF précédemment fourni (Android uniquement).
getStatus	Retourne l'état actuel de l'adaptateur NFC.
showSettings	Ouvre la page de paramètres système où l'utilisateur peut activer le NFC.
isSupported	Vérifie si l'appareil dispose du support matériel NFC.

Exemples

startScanning()

Lance l'écoute des tags NFC.

import { CapacitorNfc } from '@capgo/capacitor-nfc';

await CapacitorNfc.startScanning();

stopScanning()

Arrête la session de scan NFC en cours.

import { CapacitorNfc } from '@capgo/capacitor-nfc';

await CapacitorNfc.stopScanning();

write()

Écrit les enregistrements NDEF fournis sur le dernier tag détecté.

import { CapacitorNfc } from '@capgo/capacitor-nfc';

await CapacitorNfc.write({
  records: [
    {
      tnf: 1,
      type: [1],
      id: [1],
      payload: [1],
    },
  ],
});

erase()

Tente d'effacer le dernier tag détecté en écrivant un message NDEF vide.

import { CapacitorNfc } from '@capgo/capacitor-nfc';

await CapacitorNfc.erase();

makeReadOnly()

Tente de passer le dernier tag détecté en lecture seule.

import { CapacitorNfc } from '@capgo/capacitor-nfc';

await CapacitorNfc.makeReadOnly();

share()

Partage un message NDEF avec un autre appareil via peer-to-peer (Android uniquement).

import { CapacitorNfc } from '@capgo/capacitor-nfc';

await CapacitorNfc.share({
  records: [
    {
      tnf: 1,
      type: [1],
      id: [1],
      payload: [1],
    },
  ],
});

Le tableau ci-dessus liste les 10 méthodes principales. Les helpers de version et de listener, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.

Écouter les événements

addListener renvoie un handle. Appelez handle.remove() lorsque l'écran est démonté.

Référence complète

• dépôt GitHub
• Documentation
• Référence API

Continuer avec l'utilisation de @capgo/capacitor-nfc

Si vous utilisez Utiliser @capgo/capacitor-nfc pour planifier les opérations du dashboard et de API, connectez-l’avec @capgo/capacitor-nfc pour les détails d'implémentation de @capgo/capacitor-nfc, Prise en main pour les détails d'implémentation dans Getting Started Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'Introduction, et Clés API pour les détails d'implémentation dans les clés API.