Skip to main content

NfcGateway

@totemsdk/edge-nfc

@totemsdk/edge-nfc / NfcGateway

Interface: NfcGateway

Properties​

status​

readonly status: "stopped" | "running" | "error"

tags​

readonly tags: NfcTag[]

Currently-visible tags.

Methods​

eraseNdef()​

eraseNdef(tagId): Promise<EdgeOperationResult<unknown>>

Erase NDEF data from a present tag.

Parameters​

tagId​

string

Returns​

Promise<EdgeOperationResult<unknown>>

getTag()​

getTag(tagId): NfcTag | null

Resolve a tag by handle (id) or uid; returns null if not present.

Parameters​

tagId​

string

Returns​

NfcTag | null

onMessage()​

onMessage(handler): () => void

Register a handler for inbound peer-to-peer NDEF messages.

Parameters​

handler​

(records) => void

Returns​

() => void

putMessage()​

putMessage(records): Promise<EdgeOperationResult<unknown>>

Send an NDEF message to a peer NFC-DEP target.

Parameters​

records​

NdefRecord[]

Returns​

Promise<EdgeOperationResult<unknown>>

readNdef()​

readNdef(tagId): Promise<EdgeOperationResult<{ records: NdefRecord[]; }>>

Read NDEF records off a present tag.

Parameters​

tagId​

string

Returns​

Promise<EdgeOperationResult<{ records: NdefRecord[]; }>>

registerHceApduHandler()​

registerHceApduHandler(handler): Promise<void>

Serve an HCE APDU handler to an external reader.

Parameters​

handler​

HceApduHandler

Returns​

Promise<void>

start()​

start(): Promise<void>

Returns​

Promise<void>

stop()​

stop(): Promise<void>

Returns​

Promise<void>

transceive()​

transceive(tagId, apdu): Promise<EdgeOperationResult<{ response: Uint8Array; }>>

ISO 7816-4 APDU exchange (secure element).

Parameters​

tagId​

string

apdu​

Uint8Array

Returns​

Promise<EdgeOperationResult<{ response: Uint8Array; }>>

unregisterHceApduHandler()​

unregisterHceApduHandler(): Promise<void>

Stop serving HCE APDUs.

Returns​

Promise<void>

writeNdef()​

writeNdef(tagId, records): Promise<EdgeOperationResult<unknown>>

Write NDEF records to a present tag.

Parameters​

tagId​

string

records​

NdefRecord[]

Returns​

Promise<EdgeOperationResult<unknown>>