@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.cn/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.org.cn")], { 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