Package-level declarations

Types

Link copied to clipboard
class MdocNfcEngagementHelper(val eDeviceKey: EcPublicKey, val onHandoverComplete: (connectionMethods: List<MdocConnectionMethod>, encodedDeviceEngagement: ByteString, handover: DataItem) -> Unit, val onError: (error: Throwable) -> Unit, val staticHandoverMethods: List<MdocConnectionMethod>? = null, val negotiatedHandoverPicker: (connectionMethods: List<MdocConnectionMethod>) -> MdocConnectionMethod? = null)

Helper used for NFC engagement on the mdoc side.

Link copied to clipboard
data class MdocReaderNfcHandoverResult(val connectionMethods: List<MdocConnectionMethod>, val encodedDeviceEngagement: ByteString, val handover: DataItem)

The result of a successful NFC handover operation

Link copied to clipboard
data class ScanMdocReaderResult(val transport: MdocTransport, val encodedDeviceEngagement: ByteString, val handover: DataItem, val processingDuration: Duration)

Result from scanMdocReader.

Functions

Link copied to clipboard
suspend fun mdocReaderNfcHandover(tag: NfcIsoTag, negotiatedHandoverConnectionMethods: List<MdocConnectionMethod>): MdocReaderNfcHandoverResult?

Perform NFC Engagement as a mdoc reader.

Link copied to clipboard
suspend fun NfcTagReader.scanMdocReader(message: String?, options: MdocTransportOptions, transportFactory: MdocTransportFactory = MdocTransportFactory.Default, selectConnectionMethod: suspend (connectionMethods: List<MdocConnectionMethod>) -> MdocConnectionMethod?, negotiatedHandoverConnectionMethods: List<MdocConnectionMethod>, nfcScanOptions: NfcScanOptions = NfcScanOptions(), context: CoroutineContext = Dispatchers.IO): ScanMdocReaderResult?

Performs NFC engagement as a mdoc reader.