Settings

data class Settings(val source: PresentmentSource, val promptModel: PromptModel, val presentmentModel: PresentmentModel?, val launchUi: () -> Unit? = null, val sessionEncryptionCurve: EcCurve, val useNegotiatedHandover: Boolean, val negotiatedHandoverPreferredOrder: List<String>, val staticHandoverBleCentralClientModeEnabled: Boolean, val staticHandoverBlePeripheralServerModeEnabled: Boolean, val staticHandoverNfcDataTransferEnabled: Boolean, val bleDirectL2capEnabled: Boolean = false, val transportOptions: MdocTransportOptions, val transportFactory: MdocTransportFactory = MdocTransportFactory.Default, val capabilities: Map<Capability, DataItem> = mapOf( Capability.READER_AUTH_ALL_SUPPORT to true.toDataItem(), Capability.EXTENDED_REQUEST_SUPPORT to true.toDataItem() ))

Settings provided by the application for how to configure NFC engagement.

Constructors

Link copied to clipboard
constructor(source: PresentmentSource, promptModel: PromptModel, presentmentModel: PresentmentModel?, launchUi: () -> Unit? = null, sessionEncryptionCurve: EcCurve, useNegotiatedHandover: Boolean, negotiatedHandoverPreferredOrder: List<String>, staticHandoverBleCentralClientModeEnabled: Boolean, staticHandoverBlePeripheralServerModeEnabled: Boolean, staticHandoverNfcDataTransferEnabled: Boolean, bleDirectL2capEnabled: Boolean = false, transportOptions: MdocTransportOptions, transportFactory: MdocTransportFactory = MdocTransportFactory.Default, capabilities: Map<Capability, DataItem> = mapOf( Capability.READER_AUTH_ALL_SUPPORT to true.toDataItem(), Capability.EXTENDED_REQUEST_SUPPORT to true.toDataItem() ))

Properties

Link copied to clipboard

true if ISO/IEC 18013-5 Second Edition direct BLE L2CAP modes (MdocConnectionMethod.Ble.DirectL2capPeripheral and MdocConnectionMethod.Ble.DirectL2capCentral) should be offered/accepted during NFC handover.

Link copied to clipboard

the capabilities to convey to the mdoc reader.

Link copied to clipboard
val launchUi: () -> Unit?

a callback invoked when handover completes to launch the presentment UI, or null.

Link copied to clipboard

a list of the preferred order for which kind of org.multipaz.mdoc.transport.MdocTransport to create when using NFC negotiated handover.

Link copied to clipboard

the PresentmentModel to update during presentment, or null.

Link copied to clipboard
Link copied to clipboard

the Elliptic Curve Cryptography curve to use for session encryption.

Link copied to clipboard

the PresentmentSource to use as the source of truth for what to present.

true if mdoc BLE Central Client mode should be offered when using NFC static handover.

true if mdoc BLE Peripheral Server mode should be offered when using NFC static handover.

Link copied to clipboard

true if NFC data transfer should be offered when using NFC static handover

Link copied to clipboard

the MdocTransportFactory to use for creating transports.

Link copied to clipboard

the MdocTransportOptions to use for newly created connections.

Link copied to clipboard

if true NFC negotiated handover will be used, otherwise NFC static handover.