@tauri-apps/plugin-nfc

Enumerations

NFCTypeNameFormat

Source: undefined

Enumeration Members

AbsoluteURI

AbsoluteURI: 3;

Source: undefined

Empty

Empty: 0;

Source: undefined

Media

Media: 2;

Source: undefined

NfcExternal

NfcExternal: 4;

Source: undefined

NfcWellKnown

NfcWellKnown: 1;

Source: undefined

Unchanged

Unchanged: 6;

Source: undefined

Unknown

Unknown: 5;

Source: undefined

---

TechKind

Source: undefined

Enumeration Members

IsoDep

IsoDep: 0;

Source: undefined

MifareClassic

MifareClassic: 1;

Source: undefined

MifareUltralight

MifareUltralight: 2;

Source: undefined

Ndef

Ndef: 3;

Source: undefined

NdefFormatable

NdefFormatable: 4;

Source: undefined

NfcA

NfcA: 5;

Source: undefined

NfcB

NfcB: 6;

Source: undefined

NfcBarcode

NfcBarcode: 7;

Source: undefined

NfcF

NfcF: 8;

Source: undefined

NfcV

NfcV: 9;

Source: undefined

Interfaces

NFCRecord

Source: undefined

Properties

Property	Type	Defined in
format	NFCTypeNameFormat	Source: undefined
id	number[]	Source: undefined
kind	number[]	Source: undefined
payload	number[]	Source: undefined

---

ScanOptions

Source: undefined

Properties

Property	Type	Description	Defined in
keepSessionAlive?	boolean	-	Source: undefined
message?	string	Message displayed in the UI. iOS only.	Source: undefined
successMessage?	string	Message displayed in the UI when the message has been read. iOS only.	Source: undefined

---

Tag

Source: undefined

Properties

Property	Type	Defined in
id	number[]	Source: undefined
kind	string[]	Source: undefined
records	TagRecord[]	Source: undefined

---

TagRecord

Source: undefined

Properties

Property	Type	Defined in
id	number[]	Source: undefined
kind	number[]	Source: undefined
payload	number[]	Source: undefined
tnf	NFCTypeNameFormat	Source: undefined

---

UriFilter

Source: undefined

Properties

Property	Type	Defined in
host?	string	Source: undefined
pathPrefix?	string	Source: undefined
scheme?	string	Source: undefined

---

WriteOptions

Source: undefined

Properties

Property	Type	Description	Defined in
kind?	ScanKind	-	Source: undefined
message?	string	Message displayed in the UI when reading the tag. iOS only.	Source: undefined
successfulReadMessage?	string	Message displayed in the UI when the tag has been read. iOS only.	Source: undefined
successMessage?	string	Message displayed in the UI when the message has been written. iOS only.	Source: undefined

Type Aliases

ScanKind

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

Source: undefined

Union Members

Type Literal

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

---

Type Literal

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

Name	Type	Description	Defined in
mimeType?	string	-	Source: undefined
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: undefined
type	"ndef"	-	Source: undefined
uri?	UriFilter	-	Source: undefined

Variables

RTD_TEXT

const RTD_TEXT: number[];

Source: undefined

---

RTD_URI

const RTD_URI: number[];

Source: undefined

Functions

isAvailable()

function isAvailable(): Promise<boolean>;

Source: undefined

Returns

Promise<boolean>

---

record()

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

Source: undefined

Parameters

Parameter	Type
format	NFCTypeNameFormat
kind	string | number[]
id	string | number[]
payload	string | number[]

Returns

NFCRecord

---

scan()

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

Source: undefined

Scans an NFC tag.

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

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

Parameters

Parameter	Type	Description
kind	ScanKind	-
options?	ScanOptions	-

Returns

Promise<Tag>

---

textRecord()

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

Source: undefined

Parameters

Parameter	Type	Default value
text	string	undefined
id?	string | number[]	undefined
language?	string	'en'

Returns

NFCRecord

---

uriRecord()

function uriRecord(uri, id?): NFCRecord;

Source: undefined

Parameters

Parameter	Type
uri	string
id?	string | number[]

Returns

NFCRecord

---

write()

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

Source: undefined

Write to an NFC tag.

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

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[]	-
options?	WriteOptions	-

Returns

Promise<void>