`read(options)`

Reads an NFC tag and returns the data read from it.

Syntax

1import { getNFCService } from 'lightning/mobileCapabilities';
2read(options?: NFCServiceOptions): Promise<Object>;

Parameters

options—(Required) An NFCServiceOptions object to configure the NFCService request.

Returns

A Promise object that resolves to an array containing a single NFCMessage object.

A rejected promise returns a NFCServiceFailure.

Usage

Use this function to read data from an NFC tag.

1myNFCService
2  .read(options)
3  .then((readText) => {
4    this.results.records.parsed.payload = readText;
5  })
6  .catch((error) => {
7    this.readText = [];
8    console.error("Error code: " + error.code);
9    console.error("Error message: " + error.message);
10  });

The design pattern of returning an array containing a single NFCMessage object instead of just the NFCMessage object is intentional. It’s to make extensibility updates easier, in case future enhancements to NFCService include the ability to read multiple NFC tags.
If an error occurs, the error is returned via a rejected promise. Handle errors in a catch clause.
When the user cancels the operation, the promise is rejected with a NFCServiceFailure.code value of USER_DISMISSED.

See Also

NFCService Data Types