@tauri-apps/plugin-nfc
Enumerations
NFCTypeNameFormat
Enumeration Members
AbsoluteURI
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L84
Empty
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L81
Media
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L83
NfcExternal
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L85
NfcWellKnown
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L82
Unchanged
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L87
Unknown
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L86
TechKind
Enumeration Members
IsoDep
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L17
MifareClassic
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L18
MifareUltralight
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L19
Ndef
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L20
NdefFormatable
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L21
NfcA
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L22
NfcB
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L23
NfcBarcode
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L24
NfcF
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L25
NfcV
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L26
Interfaces
NFCRecord
Properties
Property | Type |
---|---|
format | NFCTypeNameFormat |
id | number [] |
kind | number [] |
payload | number [] |
ScanOptions
Properties
Property | Type | Description |
---|---|---|
keepSessionAlive? | boolean | - |
message? | string | Message displayed in the UI. iOS only. |
successMessage? | string | Message displayed in the UI when the message has been read. iOS only. |
Tag
Properties
Property | Type |
---|---|
id | number [] |
kind | string [] |
records | TagRecord [] |
TagRecord
Properties
Property | Type |
---|---|
id | number [] |
kind | number [] |
payload | number [] |
tnf | NFCTypeNameFormat |
UriFilter
Properties
Property | Type |
---|---|
host? | string |
pathPrefix? | string |
scheme? | string |
WriteOptions
Properties
Property | Type | Description |
---|---|---|
kind? | ScanKind | - |
message? | string | Message displayed in the UI when reading the tag. iOS only. |
successMessage? | string | Message displayed in the UI when the message has been written. iOS only. |
successfulReadMessage? | string | Message displayed in the UI when the tag has been read. iOS only. |
Type Aliases
ScanKind
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L29
Variables
RTD_TEXT
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L7
RTD_URI
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L8
Functions
isAvailable()
Returns
Promise
<boolean
>
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L273
record()
Parameters
Parameter | Type |
---|---|
format | NFCTypeNameFormat |
kind | string | number [] |
id | string | number [] |
payload | string | number [] |
Returns
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L110
scan()
Scans an NFC tag.
See https://developer.android.com/develop/connectivity/nfc/nfc#ndef for more information.
Parameters
Parameter | Type | Description |
---|---|---|
kind | ScanKind | |
options ? | ScanOptions |
Returns
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L233
textRecord()
Parameters
Parameter | Type | Default value |
---|---|---|
text | string | undefined |
id ? | string | number [] | undefined |
language ? | string | "en" |
Returns
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L130
uriRecord()
Parameters
Parameter | Type |
---|---|
uri | string |
id ? | string | number [] |
Returns
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L205
write()
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 [] | |
options ? | WriteOptions |
Returns
Promise
<void
>
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/nfc/guest-js/index.ts#L258
© 2024 Tauri Contributors. CC-BY / MIT