multipaz/org.multipaz.nfc

Package-level declarations

Types

class CcidException(message: String) : IOException

Custom exception class for CCID-specific errors. This exception is thrown when an error occurs during communication with the smart card, such as an invalid response or a command failure.

CommandApdu

data class CommandApdu(val cla: Int, val ins: Int, val p1: Int, val p2: Int, val payload: ByteString, val le: Int)

A Command APDU according to ISO/IEC 7816.

ExternalNfcReader

sealed class ExternalNfcReader

Base class for external NFC readers.

ExternalNfcReaderState

enum ExternalNfcReaderState : Enum<ExternalNfcReaderState>

The status of a ExternalNfcReader.

ExternalNfcReaderStore

class ExternalNfcReaderStore(storage: Storage, partitionId: String)

A persistent store for externally connected NFC readers.

ExternalNfcReaderUsb

data class ExternalNfcReaderUsb(val id: String, val addedAt: Instant, val displayName: String, val vendorId: Int, val productId: Int) : ExternalNfcReader

An external NFC reader connected via USB.

HandoverRequestRecord

data class HandoverRequestRecord(val version: Int, val embeddedMessage: NdefMessage)

Handover Request record.

HandoverSelectRecord

data class HandoverSelectRecord(val version: Int, val embeddedMessage: NdefMessage)

Handover Select record.

NdefMessage

data class NdefMessage(val records: List<NdefRecord>)

An immutable NDEF message.

NdefRecord

data class NdefRecord(val tnf: NdefRecord.Tnf, val type: ByteString = ByteString(), val id: ByteString = ByteString(), val payload: ByteString = ByteString())

An immutable NDEF Record.

Nfc

object Nfc

Constants and utilities related to NFC.

NfcCommandFailedException

class NfcCommandFailedException(message: String, val status: Int) : Exception

Exception thrown if an NFC command doesn't return success.

NfcIsoTag

abstract class NfcIsoTag

Class representing a ISO/IEC 14443-4 tag.

NfcIsoTagAndroid

class NfcIsoTagAndroid(tag: IsoDep, context: CoroutineContext, updateMessage: (message: String) -> Unit) : NfcIsoTag

NfcScanOptions

data class NfcScanOptions(val pollingFrameData: ByteString? = null)

Options used to influence NFC scanning.

NfcTagLostException

class NfcTagLostException : Exception

Exception thrown if a NfcIsoTag is removed while trying to communicate with it.

NfcTagReader

interface NfcTagReader

An interface for reading NFC tags.

ResponseApdu

data class ResponseApdu(val status: Int, val payload: ByteString = ByteString())

A response APDU according to ISO/IEC 7816-4.

ServiceParameterRecord

data class ServiceParameterRecord(val tnepVersion: Int, val serviceNameUri: String, val tnepCommunicationMode: Int, val wtInt: Int, val nWait: Int, val maxNdefSize: Int)

Service Parameter Record.

ServiceSelectRecord