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.
Platform | Supported |
---|---|
Android | ✔ |
iOS | ✖ |
Web | ✖ |
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>
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'
app.component.ts
import { NFCLaunch } from 'capacitor-nfc-launch';
if (Capacitor.isNativePlatform()) {
NFCLaunch.addListener('message', (data: any) => {
console.log(data.message); // Outputs: My example data
});
}
addListener(eventName: 'message', listenerFunc: MessageListener) => Promise<PluginListenerHandle> & PluginListenerHandle
Add a listener to a NFC message event
Param | Type |
---|---|
eventName |
'message' |
listenerFunc |
MessageListener |
Returns: any
removeAllListeners() => any
Removes all listeners.
Returns: any
Prop | Type |
---|---|
remove |
() => any |
(response: any): void