![capacitor support](https://img.shields.io/badge/capacitor%20support-v5-brightgreen?logo=capacitor)
capacitor-nfc-launch
This plugin reads the message of a self-written NFC tag. Just tap the device on a NFC tag and you will get the response in the 'message' listener. Your app will also start automatically and trigger the event listener.
Supported platforms
Platform | Supported |
---|
Android | ✔ |
iOS | ✖ |
Web | ✖ |
Install
npm i capacitor-nfc-launch
npx cap sync android
AndroidManifest.xml
<intent-filter android:autoVerify="true">
<action android:name="android.nfc.action.NDEF_DISCOVERED"/>
<category android:name="android.intent.category.DEFAULT" />
// The plugin will only fire the event, if a NFC tag with this Content-Type has been sent
<data android:mimeType="application/APPBUNDLEID" />
</intent-filter>
How to write the tag
Download and open the app NFC Tools. Choose 'write' and add a dataset of the type 'data' (last entry in list).
Content-Type: application/APPBUNDLEID
Data: 'My example data'
Usage
app.component.ts
import { NFCLaunch } from 'capacitor-nfc-launch';
if (Capacitor.isNativePlatform()) {
NFCLaunch.addListener('message', (data: any) => {
console.log(data.message);
});
}
API
addListener('message', ...)
addListener(eventName: 'message', listenerFunc: MessageListener) => Promise<PluginListenerHandle> & PluginListenerHandle
Add a listener to a NFC message event
Returns: any
removeAllListeners()
removeAllListeners() => any
Removes all listeners.
Returns: any
Interfaces
PluginListenerHandle
Type Aliases
MessageListener
(response: any): void