QrEngagementHelper

Helper used for QR engagement.

This implements QR engagement as defined in ISO/IEC 18013-5:2021.

Applications can instantiate a QrEngagementHelper using QrEngagementHelper.Builder, specifying which device retrieval methods to support using QrEngagementHelper.Builder.setConnectionMethods or QrEngagementHelper.Builder.setTransports.

When a remote mdoc reader connects to one of the advertised transports, the Listener.onDeviceConnected is called and the application can use the passed-in DataTransport for transacting with the mdoc reader.

Types

Link copied to clipboard
class Builder(context: Context, eDeviceKey: EcPublicKey, options: DataTransportOptions, listener: QrEngagementHelper.Listener, executor: Executor)

Creates a new builder for QrEngagementHelper.

Link copied to clipboard
object Companion
Link copied to clipboard
interface Listener

Listener interface for QrEngagementHelper.

Properties

Link copied to clipboard

The bytes of the DeviceEngagement CBOR.

Link copied to clipboard

DeviceEngagement CBOR as as a URI-encoded string.

Link copied to clipboard

The bytes of the Handover CBOR.

Functions

Link copied to clipboard
fun close()

Close all transports currently being listened on.