@tauri-apps/plugin-nfc

Property	Type	Description	Defined in
`format`	`NFCTypeNameFormat`	The Type Name Format (TNF) of the record.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L209
`id`	`number`[]	The record identifier. Can be empty.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L217
`kind`	`number`[]	The record type, interpreted according to NFCRecord.format. For well known records this is a Record Type Definition (RTD) value such as RTD_TEXT or RTD_URI.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L215
`payload`	`number`[]	The record payload bytes.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L219

ScanOptions

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L119

Options for the scan function.

Properties

Property	Type	Description	Defined in
`keepSessionAlive?`	`boolean`	Whether the connection to the scanned tag must be kept open after the scan resolves, so that a following write call writes to that tag instead of scanning a new one. Defaults to `false`.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L125
`message?`	`string`	Message displayed in the UI. iOS only.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L127
`successMessage?`	`string`	Message displayed in the UI when the message has been read. iOS only.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L129

Tag

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L193

An NFC tag that has been scanned.

Properties

Property	Type	Description	Defined in
`id`	`number`[]	The tag identifier bytes, as reported by the operating system.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L195
`kind`	`string`[]	The technologies the tag supports, e.g. `["android.nfc.tech.Ndef"]` on Android.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L197
`records`	`TagRecord`[]	The NDEF records stored on the tag. Empty when the tag holds no NDEF message.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L199

TagRecord

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L178

An NDEF record read from a scanned tag.

Properties

Property	Type	Description	Defined in
`id`	`number`[]	The record identifier bytes. Can be empty.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L187
`kind`	`number`[]	The record type bytes.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L185
`payload`	`number`[]	The record payload bytes.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L189
`tnf`	`NFCTypeNameFormat`	The Type Name Format (TNF) of the record, which defines how TagRecord.kind is interpreted.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L183

UriFilter

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L34

Filters the tags to scan by the URI of their payload.

Every property is optional and only the ones that are set take part in the filter. Android only, the iOS implementation ignores this filter.

Properties

Property	Type	Description	Defined in
`host?`	`string`	Only match URIs with this authority (host), e.g. `tauri.app`.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L38
`pathPrefix?`	`string`	Only match URIs whose path starts with this prefix, e.g. `/docs`.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L40
`scheme?`	`string`	Only match URIs with this scheme, e.g. `https`.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L36

WriteOptions

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L133

Options for the write function.

Properties

Property	Type	Description	Defined in
`kind?`	`ScanKind`	The kind of scan to perform to find the tag to write to. Required on Android unless a scan session is kept alive.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L138
`message?`	`string`	Message displayed in the UI when reading the tag. iOS only.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L140
`successfulReadMessage?`	`string`	Message displayed in the UI when the tag has been read. iOS only.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L142
`successMessage?`	`string`	Message displayed in the UI when the message has been written. iOS only.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L144

Type Aliases

ScanKind

type ScanKind =
  | {
  mimeType?: string;
  type: "tag";
  uri?: UriFilter;
}
  | {
  mimeType?: string;
  techLists?: TechKind[][];
  type: "ndef";
  uri?: UriFilter;
};

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L76

The kind of scan to perform, which defines which tags are matched.

Use tag to match any discovered tag and ndef to only match tags carrying an NDEF message.

Union Members

Type Literal

{
  mimeType?: string;
  type: "tag";
  uri?: UriFilter;
}

Name	Type	Description	Defined in
`mimeType?`	`string`	Only match tags whose payload has this MIME type, e.g. `text/plain`. Android only.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L83
`type`	`"tag"`	Matches any tag that is discovered, whether it carries an NDEF message or not.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L79
`uri?`	`UriFilter`	Only match tags whose payload URI matches this filter. Android only.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L81

Type Literal

{
  mimeType?: string;
  techLists?: TechKind[][];
  type: "ndef";
  uri?: UriFilter;
}

Name	Type	Description	Defined in
`mimeType?`	`string`	Only match tags whose NDEF payload has this MIME type, e.g. `text/plain`. Android only.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L94
`techLists?`	`TechKind`[][]	Each of the tech-lists is considered independently and the activity is considered a match if any single tech-list matches the tag that was discovered. This provides AND and OR semantics for filtering desired techs. See https://developer.android.com/reference/android/nfc/NfcAdapter#ACTION_TECH_DISCOVERED for more information. Examples `import type { TechKind } from "@tauri-apps/plugin-nfc" const techLists = [ // capture anything using NfcF [TechKind.NfcF], // capture all MIFARE Classics with NDEF payloads [TechKind.NfcA, TechKind.MifareClassic, TechKind.Ndef] ]`	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L115
`type`	`"ndef"`	Only matches tags that carry an NDEF message.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L87
`uri?`	`UriFilter`	Only match tags whose NDEF payload URI matches this filter. Android only.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L89

Variables

RTD_TEXT

const RTD_TEXT: number[];

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L20

Record Type Definition (RTD) of an NDEF well known text record, the "T" (0x54) byte.

Since

2.0.0

RTD_URI

const RTD_URI: number[];

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L26

Record Type Definition (RTD) of an NDEF well known URI record, the "U" (0x55) byte.

Since

2.0.0

Functions

isAvailable()

function isAvailable(): Promise<boolean>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L464

Checks whether NFC is supported by the device and currently usable by the app.

Resolves to false on Android when the device has no NFC adapter or NFC is disabled in the device settings, and on iOS when the NFCReaderUsageDescription entry is missing from the Info.plist file or NFC tag reading is unavailable.

Returns

Promise<boolean>

A promise resolving to whether NFC is available on the device.

Example

import { isAvailable } from '@tauri-apps/plugin-nfc';
const canScan = await isAvailable();

Since

2.0.0

record()

function record(
   format,
   kind,
   id,
   payload
): NFCRecord;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L242

Creates an NDEF record with the given type name format, type, identifier and payload.

Strings are encoded as UTF-8 byte arrays.

Parameters

Parameter	Type	Description
`format`	`NFCTypeNameFormat`	The Type Name Format (TNF) of the record.
`kind`	`string` \| `number`[]	The record type, interpreted according to `format`.
`id`	`string` \| `number`[]	The record identifier. Use an empty string or array when the record has none.
`payload`	`string` \| `number`[]	The record payload.

Returns

NFCRecord

The NDEF record, ready to be written with write.

Example

import { record, NFCTypeNameFormat, write } from '@tauri-apps/plugin-nfc';
const mimeRecord = record(NFCTypeNameFormat.Media, 'text/plain', '', 'hello world');
await write([mimeRecord], { kind: { type: 'ndef' } });

Since

2.0.0

scan()

function scan(kind, options?): Promise<Tag>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L404

Scans an NFC tag, resolving when a tag matching the given filters is read.

See https://developer.android.com/develop/connectivity/nfc/nfc#ndef for more information.

Parameters

Parameter	Type	Description
`kind`	`ScanKind`	The kind of scan to perform, which defines how tags are matched.
`options?`	`ScanOptions`	Additional scan options such as the iOS UI messages and whether the session must be kept alive for a following write call.

Returns

Promise<Tag>

A promise resolving to the tag that has been scanned.

Example

import { scan } from '@tauri-apps/plugin-nfc';
const tag = await scan({ type: 'tag' });

Since

2.0.0

textRecord()

function textRecord(
   text,
   id?,
   language?
): NFCRecord;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L281

Creates an NDEF well known text record (RTD_TEXT).

The payload is the UTF-8 encoded text prefixed by the language code and by a status byte holding the length of that language code.

Parameters

Parameter	Type	Default value	Description
`text`	`string`	`undefined`	The text to store in the record.
`id?`	`string` \| `number`[]	`undefined`	The record identifier. Defaults to an empty identifier.
`language?`	`string`	`'en'`	The IANA language code of the text. Defaults to `en`.

Returns

NFCRecord

The NDEF record, ready to be written with write.

Example

import { textRecord, write } from '@tauri-apps/plugin-nfc';
await write([textRecord('hello world')], { kind: { type: 'ndef' } });

Since

2.0.0

uriRecord()

function uriRecord(uri, id?): NFCRecord;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L372

Creates an NDEF well known URI record (RTD_URI).

The URI is encoded with the NDEF URI abbreviation scheme: a known prefix such as https:// is replaced by the identifier code byte that starts the payload.

Parameters

Parameter	Type	Description
`uri`	`string`	The URI to store in the record.
`id?`	`string` \| `number`[]	The record identifier. Defaults to an empty identifier.

Returns

NFCRecord

The NDEF record, ready to be written with write.

Example

import { uriRecord, write } from '@tauri-apps/plugin-nfc';
await write([uriRecord('https://tauri.app')], { kind: { type: 'ndef' } });

Since

2.0.0

write()

function write(records, options?): Promise<void>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L432

Write to an NFC tag.

If you did not previously call scan with ScanOptions.keepSessionAlive set to true, it will first scan the tag then write to it.

Parameters

Parameter	Type	Description
`records`	`NFCRecord`[]	The NDEF records to write to the tag.
`options?`	`WriteOptions`	Additional write options such as the kind of scan used to find the tag and the iOS UI messages.

Returns

Promise<void>

Example

import { uriRecord, write } from '@tauri-apps/plugin-nfc';
await write([uriRecord('https://tauri.app')], { kind: { type: 'ndef' } });

Since

2.0.0

Support on Open Collective Sponsor on GitHub