Iniziare

Installazione

bun add @capgo/capacitor-nfc
bunx cap sync

Importazione

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

API Panoramica

startScanning

Avvia l'ascolto per i tag NFC.

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

await CapacitorNfc.startScanning();

stopScanning

Sospende la sessione di scansione NFC in corso.

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

await CapacitorNfc.stopScanning();

write

Scrive i record NDEF forniti sul tag scoperto più recentemente.

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

await CapacitorNfc.write({} as WriteTagOptions);

erase

Prova a cancellare il tag scoperto più recentemente scrivendo un messaggio NDEF vuoto.

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

await CapacitorNfc.erase();

makeReadOnly

Tenta di rendere la tag più recentemente scoperta in sola lettura.

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

await CapacitorNfc.makeReadOnly();

share

Condivide un messaggio NDEF con un altro dispositivo tramite peer-to-peer (solo per Android).

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

await CapacitorNfc.share({} as ShareTagOptions);

unshare

Smette di condividere il messaggio NDEF precedentemente fornito (solo per Android).

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

await CapacitorNfc.unshare();

getStatus

Restituisce lo stato attuale dell'adattatore NFC.

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

await CapacitorNfc.getStatus();

showSettings

Apre la pagina delle impostazioni del sistema dove l'utente può abilitare il NFC.

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

await CapacitorNfc.showSettings();

isSupported

Controlla se il dispositivo ha supporto hardware per il NFC.

Restituisce true se il dispositivo ha hardware NFC, indipendentemente dal fatto che il NFC sia attualmente abilitato o disabilitato. Restituisce false se il dispositivo non ha hardware NFC.

Utilizza questo metodo per determinare se le funzionalità NFC dovrebbero essere mostrate nella UI del tuo app. Per controllare se il NFC è attualmente abilitato, utilizza getStatus().

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

await CapacitorNfc.isSupported();

Riferimento di tipo

StartScanningOptions

Opzioni che controllano il comportamento di .

export interface StartScanningOptions {
  /**
   * iOS-only: closes the NFC session automatically after the first successful tag read.
   * Defaults to `true`.
   */
  invalidateAfterFirstRead?: boolean;
  /**
   * iOS-only: custom message displayed in the NFC system sheet while scanning.
   */
  alertMessage?: string;
  /**
   * iOS-only: session type to use for NFC scanning.
   * - `'ndef'`: Uses NFCNDEFReaderSession (default). Only detects NDEF-formatted tags.
   * - `'tag'`: Uses NFCTagReaderSession. Detects both NDEF and non-NDEF tags (e.g., raw MIFARE tags).
   *            Allows reading UID from unformatted tags.
   *            **Requires** the `Near Field Communication Tag Reader Session Formats` entitlement
   *            in your app with the `TAG` format included. Without it the session will fail to
   *            start and the promise will reject with a `NO_NFC` error code.
   * Defaults to `'ndef'` for backward compatibility.
   */
  iosSessionType?: 'ndef' | 'tag';
  /**
   * Android-only: raw flags passed to `NfcAdapter.enableReaderMode`.
   * Defaults to enabling all tag types with skipping NDEF checks.
   */
  androidReaderModeFlags?: number;
}

WriteTagOptions

Opzioni utilizzate quando si scrive un messaggio NDEF sul tag corrente.

export interface WriteTagOptions {
  /**
   * Array of records that compose the NDEF message to be written.
   */
  records: NdefRecord[];
  /**
   * When `true`, the plugin attempts to format NDEF-formattable tags before writing.
   * Defaults to `true`.
   */
  allowFormat?: boolean;
}

ShareTagOptions

Opzioni utilizzate quando si condivide un messaggio NDEF con un altro dispositivo utilizzando il modo Android Beam / P2P.

export interface ShareTagOptions {
  records: NdefRecord[];
}

NfcStatus

Stati possibili dell'adattatore NFC restituiti da .

export type NfcStatus = 'NFC_OK' | 'NO_NFC' | 'NFC_DISABLED' | 'NDEF_PUSH_DISABLED';

NfcEvent

Evento di scoperta NFC generico inviato dal plugin.

export interface NfcEvent {
  type: NfcEventType;
  tag: NfcTag;
}

NfcStateChangeEvent

Evento emesso ogni volta che cambia la disponibilità dell'adattatore NFC.

export interface NfcStateChangeEvent {
  status: NfcStatus;
  enabled: boolean;
}

NdefRecord

Struttura JSON che rappresenta un singolo record NDEF.

export interface NdefRecord {
  /**
   * Type Name Format identifier.
   */
  tnf: number;
  /**
   * Type field expressed as an array of byte values.
   */
  type: number[];
  /**
   * Record identifier expressed as an array of byte values.
   */
  id: number[];
  /**
   * Raw payload expressed as an array of byte values.
   */
  payload: number[];
}

NfcEventType

Tipo di evento che descrive il tipo di scoperta NFC avvenuta.

export type NfcEventType = 'tag' | 'ndef' | 'ndef-mime' | 'ndef-formatable';

NfcTag

Rappresentazione delle informazioni complete del tag restituite dalle layer native.

export interface NfcTag {
  /**
   * Raw identifier bytes for the tag.
   */
  id?: number[];
  /**
   * List of Android tech strings (e.g. `android.nfc.tech.Ndef`).
   */
  techTypes?: string[];
  /**
   * Human readable tag type when available (e.g. `NFC Forum Type 2`, `MIFARE Ultralight`).
   */
  type?: string | null;
  /**
   * Maximum writable size in bytes for tags that expose NDEF information.
   */
  maxSize?: number | null;
  /**
   * Indicates whether the tag can be written to.
   */
  isWritable?: boolean | null;
  /**
   * Indicates whether the tag can be permanently locked.
   */
  canMakeReadOnly?: boolean | null;
  /**
   * Array of NDEF records discovered on the tag.
   */
  ndefMessage?: NdefRecord[] | null;
}

Fonte di Verità

Questa pagina è generata dal plugin e viene sincronizzata con il suo stato. src/definitions.tsRisciacqua la sincronizzazione quando le informazioni pubbliche API cambiano nell'area upstream.

Continua da Inizia con l'installazione

Se stai utilizzando Inizia con l'installazione per pianificare dashboard e API operazioni, connettilo con Usando @capgo/capacitor-nfc per la capacità nativa in Usando @capgo/capacitor-nfc API Panoramica per il dettaglio di implementazione in API Panoramica Introduzione per il dettaglio di implementazione in Introduzione API Chiavi per il dettaglio di implementazione in API Chiavi, e Dispositivi per il dettaglio di implementazione in Dispositivi.