@tauri-apps/plugin-nfc

屬性	類型	定義於
`format`	`NFCTypeNameFormat`	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L104
`id`	`number`[]	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L106
`kind`	`number`[]	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L105
`payload`	`number`[]	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L107

ScanOptions

屬性

屬性	類型	描述	定義於
`keepSessionAlive?`	`boolean`	-	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L63
`message?`	`string`	在 UI 中顯示的訊息。僅限 iOS。	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L65
`successMessage?`	`string`	當訊息已被讀取時，在 UI 中顯示的訊息。僅限 iOS。	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L67

Tag

屬性

屬性	類型	定義於
`id`	`number`[]	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L98
`kind`	`string`[]	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L99
`records`	`TagRecord`[]	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L100

TagRecord

屬性

屬性	類型	定義於
`id`	`number`[]	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L93
`kind`	`number`[]	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L92
`payload`	`number`[]	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L94
`tnf`	`NFCTypeNameFormat`	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L91

UriFilter

屬性

屬性	類型	定義於
`host?`	`string`	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L12
`pathPrefix?`	`string`	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L13
`scheme?`	`string`	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L11

WriteOptions

屬性

屬性	類型	描述	定義於
`kind?`	`ScanKind`	-	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L71
`message?`	`string`	在 UI 中顯示的訊息，當讀取標籤時。僅限 iOS。	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L73
`successfulReadMessage?`	`string`	當標籤已被讀取時，在 UI 中顯示的訊息。僅限 iOS。	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L75
`successMessage?`	`string`	當訊息已被寫入時，在 UI 中顯示的訊息。僅限 iOS。	原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L77

類型別名

ScanKind

type ScanKind: object | object;

原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L29

變數

RTD_TEXT

const RTD_TEXT: number[];

原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L7

RTD_URI

const RTD_URI: number[];

原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L8

函式

isAvailable()

function isAvailable(): Promise<boolean>

回傳

Promise<boolean>

原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L271

record()

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

參數

參數	類型
`format`	`NFCTypeNameFormat`
`kind`	`string` \| `number`[]
`id`	`string` \| `number`[]
`payload`	`string` \| `number`[]

回傳

NFCRecord

原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L110

scan()

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

掃描 NFC 標籤。

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

請參閱 https://developer.android.com/develop/connectivity/nfc/nfc#ndef 以取得更多資訊。

參數

參數	類型	描述
`kind`	`ScanKind`
`options`?	`ScanOptions`

回傳

Promise<Tag>

原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L231

textRecord()

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

參數

參數	類型	預設值
`text`	`string`	`undefined`
`id`?	`string` \| `number`[]	`undefined`
`language`?	`string`	`'en'`

回傳

NFCRecord

原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L130

uriRecord()

function uriRecord(uri, id?): NFCRecord

參數

參數	類型
`uri`	`string`
`id`?	`string` \| `number`[]

回傳

NFCRecord

原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L203

write()

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

寫入 NFC 標籤。

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

如果您先前沒有呼叫 scan 並將 ScanOptions.keepSessionAlive 設定為 true，它會先掃描標籤，然後再寫入。

參數

參數	類型	描述
`records`	`NFCRecord`[]
`options`?	`WriteOptions`

回傳

Promise<void>

原始碼: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L256