multipaz-android-legacy/com.android.identity.android.mdoc.deviceretrieval/DeviceRetrievalHelper

DeviceRetrievalHelper

Helper used for establishing engagement with, interacting with, and presenting documents to a remote mdoc reader device.

This class implements the interface between an mdoc and mdoc reader using the connection setup and device retrieval interfaces defined in ISO/IEC 18013-5:2021.

Reverse engagement as per drafts of 18013-7 and 23220-4 is supported. These protocols are not finalized so should only be used for testing.

Types

Builder

class Builder(context: Context, listener: DeviceRetrievalHelper.Listener, executor: Executor, eDeviceKey: EcPrivateKey)

Builder for DeviceRetrievalHelper.

Companion

object Companion

Listener

interface Listener

Interface for listening to messages from the remote verifier device.

Properties

deviceEngagement

val deviceEngagement: ByteArray

The bytes of the device engagement being used.

eReaderKey

val eReaderKey: EcPublicKey

Gets the ephemeral reader key.

handover

val handover: ByteArray

The bytes of the handover being used.

isTransportSpecificTerminationSupported

val isTransportSpecificTerminationSupported: Boolean

Whether transport specific termination is available for the current connection.

scanningTimeMillis

val scanningTimeMillis: Long

The time spent doing BLE scanning or 0 if no scanning happened.

sessionTranscript

val sessionTranscript: ByteArray

The bytes of the session transcript.

Functions

disconnect

fun disconnect()

Stops the presentation and shuts down the transport.

reportDeviceDisconnected

fun reportDeviceDisconnected(transportSpecificTermination: Boolean)

reportDeviceRequest

fun reportDeviceRequest(deviceRequestBytes: ByteArray)

reportEReaderKeyReceived

fun reportEReaderKeyReceived(eReaderKey: EcPublicKey)

reportError

fun reportError(error: Throwable)

sendDeviceResponse

fun sendDeviceResponse(deviceResponseBytes: ByteArray?, status: Long?)

Send a response to the remote mdoc verifier.

sendTransportSpecificTermination

fun sendTransportSpecificTermination()

Sends a transport-specific termination message.

start

fun start()