@capgo/capacitor-nfc

Overview

Public API surface for the Capacitor NFC plugin.

Core Capabilities

• startScanning - Starts listening for NFC tags.
• stopScanning - Stops the ongoing NFC scanning session.
• write - Writes the provided NDEF records to the last discovered tag.
• erase - Attempts to erase the last discovered tag by writing an empty NDEF message.

Public API

Method	Description
startScanning	Starts listening for NFC tags.
stopScanning	Stops the ongoing NFC scanning session.
write	Writes the provided NDEF records to the last discovered tag.
erase	Attempts to erase the last discovered tag by writing an empty NDEF message.
makeReadOnly	Attempts to make the last discovered tag read-only.
share	Shares an NDEF message with another device via peer-to-peer (Android only).
unshare	Stops sharing previously provided NDEF message (Android only).
getStatus	Returns the current NFC adapter status.
showSettings	Opens the system settings page where the user can enable NFC.
getPluginVersion	Returns the version string baked into the native plugin.
isSupported	Checks whether the device has NFC hardware support.
addListener	See the source definitions for current behavior.
addListener	See the source definitions for current behavior.
addListener	See the source definitions for current behavior.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-nfc.

Keep going from @capgo/capacitor-nfc

If you are using @capgo/capacitor-nfc to plan native plugin work, connect it with Using @capgo/capacitor-nfc for the native capability in Using @capgo/capacitor-nfc, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins, and Ionic Enterprise Plugin Alternatives for the product workflow in Ionic Enterprise Plugin Alternatives.