NDEFReader

Draft
This page is not complete.

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

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 data from 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.onerror
An event handler for error event which is called to notify that an error occured 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.

Specifications

Specification Status Comment
Web NFC, NDEFReader Draft Initial definition.

Browser compatibility

No compatibility data found. Please contribute data for "api.NDEFReader" (depth: 1) to the MDN compatibility data repository.