Use the NFCService API

Add NFCService to a Lightning Web Component

In your component’s JavaScript file, import NFCService using the standard JavaScript import statement. Specifically, import the getNFCService() factory function from the lightning/mobileCapabilities module, like so:

import { getNFCService } from 'lightning/mobileCapabilities';

After it’s imported into your component, use the factory function to get an instance of NFCService. With your NFCService instance, use the utility functions and constants to verify availability. Then use NFC-related functions to perform the associated functionality.

Test NFCService Availability

NFCService depends on physical device hardware and platform features. A component that uses NFCService renders without errors on a desktop computer or in a mobile browser, but NFC scanning functions fail. To avoid these errors, test if NFCService functionality is available before you use it.

handleBeginNFCEventClick(event) {
    const myNFCService = getNFCService();
    if(myNFCService.isAvailable()) {
        // Perform NFC-related operations
    }
    else {
        // NFCService not available, or consuming app hasn’t implemented it         
        // Not running on hardware with NFC capabilities
        // Handle with message, error, beep, and so on
    }
}

Read an NFC Tag

Perform NFC read operations with read(). First, call the read() function, optionally passing in an NFCServiceOptions object as a parameter. Then, handle the result of the operation in any manner you wish.

For example:

myNFCService
  .read(options)
  .then((result) => {
    // Do something with the result of the read operation
    console.log(result);
    this.readResult = result.value;
  })
  .catch((error) => {
    // Handle cancellation and read errors here
    console.error(error);
  });

Erase an NFC Tag

Perform NFC erase operations with erase(). First, call the erase() function, optionally passing in an NFCServiceOptions object as a parameter. Then, handle the result of the operation in any manner you wish.

For example:

myNFCService
  .erase(options)
  .then((successMessage) => {
    // Receive a success message following a successful erase operation
    console.log(successMessage);
  })
  .catch((error) => {
    // Handle cancellation and erase errors here
    console.error(error);
  });

Write to an NFC Tag

Perform NFC write operations with write(). First, call the write() function, optionally passing in an NFCServiceOptions object as a parameter. Then, handle the result of the operation in any manner you wish.

For example:

myNFCService
  .write(options)
  .then((successMessage) => {
    // Receive a success message following a successful write operation
    console.log(successMessage);
  })
  .catch((error) => {
    // Handle cancellation and write errors here
    console.error(error);
  });