ReaderEngagement

data class ReaderEngagement

Reader Engagement according to ISO/IEC 18013-5.

To construct an instance use buildReaderEngagement.

For an engagement received from a remote mdoc reader use the ReaderEngagement.Companion.fromDataItem method.

Types

Link copied to clipboard
class Builder(val eReaderKey: EcPublicKey? = null, val version: String? = null)

A builder for ReaderEngagement.

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

the Device Retrieval methods in the engagement, if any.

Link copied to clipboard

the ephemeral session encryption key for the mdoc reader, if present.

Link copied to clipboard
val eReaderKeyBytes: ByteString?

the exact bytes of the eReaderKey as encoded by the mdoc reader, including the #6.24 tag, if present.

Link copied to clipboard

additional RFU or private extension entries in the ReaderEngagement map (* uint => RFU, * nint => Ext), keyed by CBOR integer key (keys 0, 1, and 2 are reserved).

Link copied to clipboard

the version of the reader engagement structure, e.g. "1.0" or "1.1".

Functions

Link copied to clipboard

Generates CBOR compliant with the CDDL for ReaderEngagement according to ISO/IEC 18013-5 using MdocEngagementType.READER_QR.

fun toDataItem(engagementType: MdocEngagementType): DataItem

Generates CBOR compliant with the CDDL for ReaderEngagement according to ISO/IEC 18013-5.