NDEFReadingEvent()

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 NDEFReadingEvent() constructor creates a new NDEFReadingEvent object which represents events dispatched on new NFC readings obtained by NDEFReader.

Syntax

new NDEFReadingEvent(type, options)

Parameters

type

A string with the name of the event. It is case-sensitive and browsers always set it to reading.

options

An object that, in addition of the properties defined in Event(), can have the following properties:

serialNumber Optional

The serial number of the device a message was read from. It default to "", and can be set to null.

message

An object with the following members:

data Optional

Contains the data to be transmitted. It can be a string object or literal, an ArrayBuffer, a TypedArray, a DataView, or an array of nested records.

encoding Optional

A string specifying the record's encoding.

id Optional

A developer-defined identifier for the record.

lang Optional

A valid language tag according to RFC 5646: Tags for Identifying Languages (also known as BCP 47).

mediaType Optional

A valid MIME type.

recordType

A string indicating the type of data stored in data. It must be one of the following values:

"absolute-url"

An absolute URL to the data.

"empty"

An empty NDEFRecord.

"mime"

A valid MIME type.

"smart-poster"

A smart poster as defined by the NDEF-SMARTPOSTER specification.

"text"

Text as defined by the NDEF-TEXT specification.

"unknown"

The record type is not known.

"URL"

A URL as defined by the NDEF-URI specification.

Return value

A new NDEFReadingEvent object.

Specifications

Specification
Web NFC API
# dom-ndefreadingevent-constructor

Browser compatibility

BCD tables only load in the browser