dot-nfc/com.innovatrics.dot.nfc/NfcTravelDocumentReader

NfcTravelDocumentReader

NFC Travel Document Reader component.

Types

fun interface AccessEstablishmentStartedListener

Interface for handling the start of access establishment, such as BAC/PACE method.

data class Configuration @JvmOverloads constructor(val authorityCertificates: Set<X509Certificate> = emptySet(), val timeoutMillis: Int = DEFAULT_TIMEOUT_MILLIS, isDebugInfoEnabled: Boolean = false)

Configuration for the NFC Travel Document Reader component.

DataAuthenticationStartedListener

fun interface DataAuthenticationStartedListener

Interface for handling the start of data authentication.

ElementaryFilesReadingProgressUpdatedListener

fun interface ElementaryFilesReadingProgressUpdatedListener

Interface for handling the progress update during Elementary Files reading.

FailedListener

fun interface FailedListener

Interface for handling a failure of the reading process.

Listeners

class Listeners(val succeededListener: NfcTravelDocumentReader.SucceededListener, val failedListener: NfcTravelDocumentReader.FailedListener, val accessEstablishmentStartedListener: NfcTravelDocumentReader.AccessEstablishmentStartedListener = noopAccessEstablishmentStartedListener, val elementaryFilesReadingProgressUpdatedListener: NfcTravelDocumentReader.ElementaryFilesReadingProgressUpdatedListener = noopElementaryFilesReadingProgressUpdatedListener, val dataAuthenticationStartedListener: NfcTravelDocumentReader.DataAuthenticationStartedListener = noopDataAuthenticationStartedListener)

Listeners for the NFC travel document reading process.

SucceededListener

fun interface SucceededListener

Interface for handling the successful completion of the NFC travel document reading process.

Functions

cancel

abstract fun cancel()

Cancels the ongoing reading process that was initiated by the read method.

read

abstract fun ~~read~~(tag: Tag, nfcKey: NfcKey, activeAuthenticationChallenge: ByteArray? = null): TravelDocument

abstract fun ~~read~~(tag: Tag, nfcKey: NfcKey, activeAuthenticationChallenge: ByteArray? = null, listeners: NfcTravelDocumentReader.Listeners)

abstract fun read(tag: Tag, password: Password, activeAuthenticationChallenge: ByteArray? = null): TravelDocument

abstract fun read(tag: Tag, password: Password, activeAuthenticationChallenge: ByteArray? = null, listeners: NfcTravelDocumentReader.Listeners)

Read travel document. First it executes appropriate access control method (BAC/PACE). Then it authenticates data and chip, and finally it returns travel document created from read Data Groups. This operation should be called on a background thread. Ongoing reading can be canceled by invoking the cancel method.