NDEFReader

Draft

This page is not complete.

Secure context

This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Experimental

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The NDEFReader interface of the Web NFC API is an abstract interface used to read from and write data to compatible NFC devices, e.g. NFC tags supporting NDEF, when these devices are within the reader's magnetic induction field.

Constructor

NDEFReader.NDEFReader()
Returns an NDEFReader with configuration specified in the parameters or default ones if no parameters are specified.

Properties

In addition to the properties listed below, NDEFReader inherits properties from its parent interface, EventTarget.

NDEFReader.onreading
An event handler for reading event, that notifies about availability of a new reading.
NDEFReader.onreadingerror
An event handler for the readingerror event, which is fired when an error occurs during reading.

Methods

The NDEFReader interface inherits the methods of EventTarget, its parent interface.

NDEFReader.scan()
Called to activate the reader (after ensuring hardware and UA compatibility and obtaining permission from the user) or get an error explaining why feature is not available.
NDEFReader.write()
Called to write NDEF message to a tag (after ensuring hardware and UA compatibility and obtaining permission from the user) or get an error explaining why feature is not available.

Specifications

Specification
Web NFC API
# the-ndefreader-object

Browser compatibility

BCD tables only load in the browser