multipaz/org.multipaz.nfc

Package-level declarations

Types

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.

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, tagContext: CoroutineContext) : NfcIsoTag

NfcTagLostException

class NfcTagLostException : Exception

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

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

data class ServiceSelectRecord(val serviceName: String)

TnepStatusRecord

data class TnepStatusRecord(val status: Int)

Properties

nfcTagScanningSupported

actual val nfcTagScanningSupported: Boolean

expect val nfcTagScanningSupported: Boolean

Is set to true if the device supports NFC scanning.

actual val nfcTagScanningSupported: Boolean = true

actual val nfcTagScanningSupported: Boolean = false

nfcTagScanningSupportedWithoutDialog

actual val nfcTagScanningSupportedWithoutDialog: Boolean

expect val nfcTagScanningSupportedWithoutDialog: Boolean

Is set to true if the device supports NFC scanning and scanNfcTag works without showing a dialog.

actual val nfcTagScanningSupportedWithoutDialog: Boolean = false

Functions

fromWtInt

fun Duration.Companion.fromWtInt(wtInt: Int): Duration

Converts Minimum Waiting Time to a duration.

scanNfcTag

actual suspend fun <T : Any> scanNfcTag(message: String?, tagInteractionFunc: suspend (tag: NfcIsoTag, updateMessage: (message: String) -> Unit) -> T?): T

expect suspend fun <T : Any> scanNfcTag(message: String?, tagInteractionFunc: suspend (tag: NfcIsoTag, updateMessage: (message: String) -> Unit) -> T?): T

Shows a dialog prompting the user to scan a NFC tag.

actual suspend fun <T : Any> scanNfcTag(message: String?, tagInteractionFunc: suspend (<Error class: unknown class>, updateMessage: (message: String) -> Unit) -> T?): T

actual suspend fun <T : Any> scanNfcTag(message: String?, tagInteractionFunc: suspend (tag: NfcIsoTag, updateMessage: (message: String) -> Unit) -> T?): T