NFC

Improve this doc

The NFC plugin allows you to read and write NFC tags. You can also beam to, and receive from, other NFC enabled devices.

Use to

• read data from NFC tags
• write data to NFC tags
• send data to other NFC enabled devices
• receive data from NFC devices

This plugin uses NDEF (NFC Data Exchange Format) for maximum compatibilty between NFC devices, tag types, and operating systems.

Repo: https://github.com/chariotsolutions/phonegap-nfc

Installation

1. Install the Cordova and Ionic Native plugins:
   

   $ ionic cordova plugin add phonegap-nfc
   $ npm install --save @ionic-native/nfc@4
   

2. Add this plugin to your app's module

Supported platforms

• Android
• BlackBerry 10
• Windows
• Windows Phone 8

Usage

import { NFC, Ndef } from '@ionic-native/nfc';

constructor(private nfc: NFC, private ndef: Ndef) { }

...

this.nfc.addNdefListener(() => {
  console.log('successfully attached ndef listener');
}, (err) => {
  console.log('error attaching ndef listener', err);
}).subscribe((event) => {
  console.log('received ndef message. the tag contains: ', event.tag);
  console.log('decoded tag id', this.nfc.bytesToHexString(event.tag.id));

  let message = this.ndef.textRecord('Hello world');
  this.nfc.share([message]).then(onSuccess).catch(onError);
});

Instance Members

FLAG_READER

beginSession(onSuccess, onFailure)

Starts the NFCNDEFReaderSession allowing iOS to scan NFC tags.

addNdefListener(onSuccess, onFailure)

Registers an event listener for any NDEF tag.

addTagDiscoveredListener(onSuccess, onFailure)

Registers an event listener for tags matching any tag type.

addMimeTypeListener(mimeType, onSuccess, onFailure)

Registers an event listener for NDEF tags matching a specified MIME type.

addNdefFormatableListener(onSuccess, onFailure)

Registers an event listener for formatable NDEF tags.

write(message)

Writes an NdefMessage(array of ndef records) to a NFC tag.

makeReadOnly()

Makes a NFC tag read only. Warning this is permanent.

share(message)

Shares an NDEF Message(array of ndef records) via peer-to-peer.

unshare()

Stop sharing NDEF data via peer-to-peer.

erase()

Erase a NDEF tag

handover(uris)

Send a file to another device via NFC handover.

stopHandover()

Stop sharing NDEF data via NFC handover.

showSettings()

Opens the device’s NFC settings.

enabled()

Check if NFC is available and enabled on this device.

bytesToString(bytes)

stringToBytes(str)

Convert string to byte array.

bytesToHexString(bytes)

Convert byte array to hex string

readerMode()

Read NFC tags sending the tag data to the success callback.