beginNfcReading

Starts listening to NFC tags. Shows a notification message (equivalent to showMessage) if NFC usage is not permitted or not available.

Field Configurations

Key	Type	Description	Default Value
"params" (required)	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"complex"	Boolean	Determines if complex NFC data is getting passed to the on tag actions.	false
"onTagActions" (required)	Array	List of actions that are executed after an NFC tag is detected.	null

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: Scan for NFC tags

Show ExampleHide Example

BeginNfcReading action that displays the ID of a detected NFC tag using a showMessage action.

{
  "type": "beginNFCReading",
  "params": {
    "onTagActions": [
      {
        "type": "showMessage",
        "params": {
          "text": "ID was {{id}}"
        }
      }
    ]
  }
}