multipaz/org.multipaz.mdoc.request/DeviceRequestParser/DocRequest

DocRequest

class DocRequest

An object used to represent data parsed from the DocRequest CBOR (part of DeviceRequest) as specified in ISO/IEC 18013-5 section 8.3 Device Retrieval.

Properties

Link copied to clipboard
val docType: String

The document type (commonly referred to as docType) in the request.

Link copied to clipboard
val itemsRequest: ByteArray

The bytes of the ItemsRequest CBOR.

Link copied to clipboard
val namespaces: List<String>

Gets the names of namespaces that the reader requested.

Link copied to clipboard
val readerAuth: ByteArray?

The bytes of the ReaderAuth CBOR.

Link copied to clipboard
val readerAuthenticated: Boolean

Whether ItemsRequest was authenticated.

Link copied to clipboard
val readerCertificateChain: X509CertChain?

The certificate chain for the reader which signed the request or null if reader authentication isn't used.

Link copied to clipboard
val requestInfo: Map<String, ByteArray>

The requestInfo associated with the document request, if set.

Link copied to clipboard
val zkSystemSpecs: List<ZkSystemSpec>

The Zk System Specs

Functions

Link copied to clipboard
fun getEntryNames(namespaceName: String): List<String>

Gets the names of data elements in the given namespace.

Link copied to clipboard
fun getIntentToRetain(namespaceName: String, entryName: String): Boolean

Gets the intent-to-retain value set by the reader for a data element in the request.

Link copied to clipboard
fun DeviceRequestParser.DocRequest.toMdocRequest(documentTypeRepository: DocumentTypeRepository, mdocCredential: MdocCredential?, requesterAppId: String? = null, requesterWebsiteOrigin: String? = null): MdocRequest

Convert to a MdocRequest.