Package-level declarations
Types
Link copied to clipboard
The type of handover which occurred.
Link copied to clipboard
class MdocNfcEngagementHelper(val eDeviceKey: EcPublicKey, val onHandoverComplete: (connectionMethods: List<MdocConnectionMethod>, encodedDeviceEngagement: ByteString, handover: DataItem) -> Unit, val onError: (error: Exception) -> 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
class MdocNfcV2EngagementHelper(val eDeviceKey: EcPublicKey, val onHandoverComplete: (connectionMethod: MdocConnectionMethod, encodedDeviceEngagement: ByteString, handover: DataItem) -> Unit, val onMessageReceived: suspend (ByteString) -> Unit, val onError: (error: Exception) -> Unit, val negotiatedHandoverPicker: (connectionMethods: List<MdocConnectionMethod>) -> MdocConnectionMethod, val apduCommandMaxSize: Long = 65536)
Helper used for NFC engagement on the mdoc side.
Link copied to clipboard
Options for when performing handover as a mdoc reader.
Link copied to clipboard
data class MdocReaderNfcHandoverResult(val connectionMethods: List<MdocConnectionMethod>, val encodedDeviceEngagement: ByteString, val handover: DataItem, val type: MdocHandoverType)
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 type: MdocHandoverType, val processingDuration: Duration)
Result from scanMdocReader.
Functions
Link copied to clipboard
suspend fun mdocReaderNfcHandover(tag: NfcIsoTag, negotiatedHandoverConnectionMethods: List<MdocConnectionMethod>, options: MdocReaderNfcHandoverOptions = MdocReaderNfcHandoverOptions()): MdocReaderNfcHandoverResult?
Perform NFC Engagement as a mdoc reader.
Link copied to clipboard
suspend fun NfcTagReader.scanMdocReader(message: String?, options: MdocTransportOptions, handoverOptions: MdocReaderNfcHandoverOptions, transportFactory: MdocTransportFactory = MdocTransportFactory.Default, selectConnectionMethod: suspend (connectionMethods: List<MdocConnectionMethod>) -> MdocConnectionMethod?, negotiatedHandoverConnectionMethods: List<MdocConnectionMethod>, nfcScanOptions: NfcScanOptions = NfcScanOptions(), context: CoroutineContext = Dispatchers.Default): ScanMdocReaderResult?
Performs NFC engagement as a mdoc reader.