@tauri-apps/plugin-nfc

Property	Type	Defined in
`format`	`NFCTypeNameFormat`	plugins/nfc/guest-js/index.ts:104
`id`	`number`[]	plugins/nfc/guest-js/index.ts:106
`kind`	`number`[]	plugins/nfc/guest-js/index.ts:105
`payload`	`number`[]	plugins/nfc/guest-js/index.ts:107

ScanOptions

Defined in: plugins/nfc/guest-js/index.ts:62

Properties

Property	Type	Description	Defined in
`keepSessionAlive?`	`boolean`	-	plugins/nfc/guest-js/index.ts:63
`message?`	`string`	Message displayed in the UI. iOS only.	plugins/nfc/guest-js/index.ts:65
`successMessage?`	`string`	Message displayed in the UI when the message has been read. iOS only.	plugins/nfc/guest-js/index.ts:67

Tag

Defined in: plugins/nfc/guest-js/index.ts:97

Properties

Property	Type	Defined in
`id`	`number`[]	plugins/nfc/guest-js/index.ts:98
`kind`	`string`[]	plugins/nfc/guest-js/index.ts:99
`records`	`TagRecord`[]	plugins/nfc/guest-js/index.ts:100

TagRecord

Defined in: plugins/nfc/guest-js/index.ts:90

Properties

Property	Type	Defined in
`id`	`number`[]	plugins/nfc/guest-js/index.ts:93
`kind`	`number`[]	plugins/nfc/guest-js/index.ts:92
`payload`	`number`[]	plugins/nfc/guest-js/index.ts:94
`tnf`	`NFCTypeNameFormat`	plugins/nfc/guest-js/index.ts:91

UriFilter

Defined in: plugins/nfc/guest-js/index.ts:10

Properties

Property	Type	Defined in
`host?`	`string`	plugins/nfc/guest-js/index.ts:12
`pathPrefix?`	`string`	plugins/nfc/guest-js/index.ts:13
`scheme?`	`string`	plugins/nfc/guest-js/index.ts:11

WriteOptions

Defined in: plugins/nfc/guest-js/index.ts:70

Properties

Property	Type	Description	Defined in
`kind?`	`ScanKind`	-	plugins/nfc/guest-js/index.ts:71
`message?`	`string`	Message displayed in the UI when reading the tag. iOS only.	plugins/nfc/guest-js/index.ts:73
`successfulReadMessage?`	`string`	Message displayed in the UI when the tag has been read. iOS only.	plugins/nfc/guest-js/index.ts:75
`successMessage?`	`string`	Message displayed in the UI when the message has been written. iOS only.	plugins/nfc/guest-js/index.ts:77

Type Aliases

ScanKind

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

Defined in: plugins/nfc/guest-js/index.ts:29

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`	-	plugins/nfc/guest-js/index.ts:38
`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] ]`	plugins/nfc/guest-js/index.ts:59
`type`	`"ndef"`	-	plugins/nfc/guest-js/index.ts:36
`uri?`	`UriFilter`	-	plugins/nfc/guest-js/index.ts:37

Variables

RTD_TEXT

const RTD_TEXT: number[];

Defined in: plugins/nfc/guest-js/index.ts:7

RTD_URI

const RTD_URI: number[];

Defined in: plugins/nfc/guest-js/index.ts:8

Functions

isAvailable()

function isAvailable(): Promise<boolean>;

Defined in: plugins/nfc/guest-js/index.ts:271

Returns

Promise<boolean>

record()

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

Defined in: plugins/nfc/guest-js/index.ts:110

Parameters

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

Returns

NFCRecord

scan()

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

Defined in: plugins/nfc/guest-js/index.ts:231

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;

Defined in: plugins/nfc/guest-js/index.ts:130

Parameters

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

Returns

NFCRecord

uriRecord()

function uriRecord(uri, id?): NFCRecord;

Defined in: plugins/nfc/guest-js/index.ts:203

Parameters

Parameter	Type
`uri`	`string`
`id?`	`string` \| `number`[]

Returns

NFCRecord

write()

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

Defined in: plugins/nfc/guest-js/index.ts:256

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>

Support on Open Collective Sponsor on GitHub