Allez directement au contenu principal
@capgo/capacitor-NFC APIs de dispositifs Source

NFC plugin Capacitor

Découverte, lecture et écriture de tag NFC natif pour les applications Capacitor sur iOS et Android

Installer

bun add @capgo/capacitor-nfc bunx cap sync
npm, pnpm ou yarn
  • npm install @capgo/capacitor-nfc
  • pnpm add @capgo/capacitor-nfc
  • yarn add @capgo/capacitor-nfc

Guide

Comment utiliser le NFC dans Capacitor

Testez sur appareil

Téléchargez l'application Capgo, puis scannez le QR code.

Lien QR de prévisualisation du plugin NFC code

Utilisation de @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. Exécutez-l’à nouveau après chaque mise à jour du plugin.

Importer

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

API en un coup d'œil

Méthode Description
startScanning Démarrer l'écoute des balises NFC.
stopScanning Arrêtez la session d'écoute NFC en cours.
write Écrit les enregistrements NDEF fournis dans la dernière balise découverte.
erase Essaye d'effacer la dernière balise découverte en écrivant un message NDEF vide.
makeReadOnly Essaye de rendre la dernière balise découverte non modifiable.
share Partagez un message NDEF avec un autre appareil via peer-to-peer (seulement Android).
unshare Arrêtez de partager le message NDEF fourni précédemment (seulement Android).
getStatus Renvoie le statut actuel de l'adaptateur NFC.
showSettings Ouvre la page de paramètres système où l'utilisateur peut activer l'NFC.
isSupported Vérifie si le dispositif dispose d'un support matériel NFC.

Exemples

startScanning()

Écoute les balises NFC.

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

await CapacitorNfc.startScanning();

stopScanning()

Arrête la session de balayage NFC en cours.

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

await CapacitorNfc.stopScanning();

write()

Écrit les enregistrements NDEF fournis sur la dernière tag découvert.

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écouvert en écrivant un message NDEF vide.

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

await CapacitorNfc.erase();

makeReadOnly()

Écrit les enregistrements NDEF fournis dans la dernière balise découverte.

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

await CapacitorNfc.makeReadOnly();

share()

Essaye d'effacer la dernière balise découverte en écrivant un message NDEF vide.

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

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

La table ci-dessus liste les 10 méthodes de base. Les aides pour les listeners et les versions, ainsi que la pleine convention de chaque méthode, sont documentées dans le dépôt GitHub.

Écoutez les événements

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

Référence complète

Continuez à partir de l'utilisation de @capgo/capacitor-nfc

Si vous utilisez L'utilisation de @capgo/capacitor-nfc pour planifier le tableau de bord et les opérations API, connectez-l’avec @capgo/capacitor-NFC Détails de mise en œuvre pour @capgo/capacitor-nfc, Prise en main Détails de mise en œuvre pour Prise en main, Vue d'ensemble de @API Détails de mise en œuvre pour Vue d'ensemble de @API, Introduction Détails de mise en œuvre pour Introduction, et Clés de @API Détails de mise en œuvre pour Clés de @API.

FAQ

FAQ du plugin NFC

Comment installez-vous le plugin NFC dans une application Capacitor?

Exécutez « bun add @capgo/capacitor-nfc » (ou « npm install @capgo/capacitor-nfc »), puis exécutez « bunx cap sync » afin que les projets iOS et Android prennent en compte le code natif code. Importez-l’à partir de « @capgo/capacitor-nfc » dans votre application code.

Le plugin @capgo/capacitor-nfc fonctionne-t-il avec React, Vue et Angular ?

Oui. NFC est un Capacitor package, il fonctionne donc avec n'importe quel framework web qui tourne à l'intérieur de Capacitor, y compris Ionic, React, Vue, Angular, Svelte et JavaScript pur.

Quelle est la version Capacitor prise en charge par @capgo/capacitor-nfc ?

Capgo plugins suivent la version majeure de Capacitor : utilisez la version majeure du plugin qui correspond à votre version majeure de Capacitor (par exemple, plugin v8 avec Capacitor 8). La table de compatibilité dans le README du GitHub liste les versions maintenues.

Le plugin @capgo/capacitor-nfc est-il gratuit et open source ?

Oui. Le code source de code est public sur GitHub à https://github.com/Cap-go/capacitor-nfc/ et le package est gratuit pour l'installation depuis npm. Les rapports de bugs et les demandes de pull sont les bienvenus.

Puis-je mettre à jour code qui utilise NFC sans passer par une revue de l'App Store ?

L'installation ou la mise à niveau du plugin modifie le code natif, il nécessite donc une nouvelle construction de l'application. Après cela, les modifications JavaScript, HTML et CSS qui appellent le plugin peuvent être déployées instantanément avec les mises à jour en direct de Capgo.

Envoyer les modifications NFC sans attendre la revue de l'application

Une fois le plugin est dans votre magasin de build, Capgo les mises à jour en direct poussent vos modifications JavaScript, HTML et CSS vers les utilisateurs en quelques minutes.

Commencez avec Capgo