`write(options)`

Write text to an NFC tag.

Syntax

1import { getNFCService } from 'lightning/mobileCapabilities';
2write(
3  payloads: NFCRecord[],
4  options?: NFCServiceOptions
5): Promise<Object>;

Parameters

payloads–(Required) An array of NFCRecord objects containing the raw bytes to be written.
options-An NFCServiceOptions object to configure the NFCService request.

Returns

If successful, the OS returns a Promise object that resolves to null. If unsuccessful, the OS returns a Promise object that rejects to NFCServiceFailure.

Usage

Use this function to write text to an NFC tag.

1myNFCService
2  .write(payloads, options)
3  .then(() => {
4    console.log("Payload was written successfully!");
5  })
6  .catch((error) => {
7    console.error("Error code: " + error.code);
8    console.error("Error message: " + error.message);
9  });

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.

The caller is responsible for ensuring that the payload of the NFCRecord object is correctly formatted, per NFC specifications. To help with this, we’ve provided two helper functions, createTextRecord() and createUriRecord(). By using these functions, you can convert your text or URI payload to an NFC record first, and then pass those records to the write() method to be written to the tag.

Note

See Also