multipaz/org.multipaz.documenttype

Package-level declarations

Types

class CannedTransactionData(val transactionType: TransactionType, val attributes: CborMap)

Sample data for request using a particular transaction data type.

data class DocumentAttribute(val type: DocumentAttributeType, val identifier: String, val displayName: String, val description: String, val icon: Icon? = null, val sampleValueMdoc: DataItem? = null, val sampleValueJson: JsonElement? = null, val parentAttribute: DocumentAttribute? = null, val embeddedAttributes: List<DocumentAttribute> = emptyList())

Class containing the metadata of an attribute/data element/claim of a Document Type

DocumentAttributeType

sealed class DocumentAttributeType

Enumeration of the different types of Document Attributes

DocumentCannedRequest

sealed class DocumentCannedRequest

Base class for a well-known document request.

DocumentType

class DocumentType

Class representing the metadata of a Document Type.

DocumentTypeRepository

class DocumentTypeRepository

A class that contains the metadata of Document and transaction types.

Icon

enum Icon : Enum<Icon>

An enumeration of icons used to represent ISO mdoc data elements or JSON-based credential claims.

IntegerOption

data class IntegerOption(val value: Int?, val displayName: String)

Class that represents a combination of an integer value and a name suitable for display

JsonCannedRequest

data class JsonCannedRequest(val vct: String, val claimsToRequest: List<DocumentAttribute>)

A class representing a request for claims.

JsonDocumentType

class JsonDocumentType

Class containing the metadata of an JSON-based Document Type.

MdocCannedRequest

data class MdocCannedRequest(val docType: String, val useZkp: Boolean, val namespacesToRequest: List<MdocNamespaceRequest>)

A class representing a request for a particular set of namespaces and data elements for a particular document type.

MdocDataElement

data class MdocDataElement(val attribute: DocumentAttribute, val mandatory: Boolean)

Class containing the metadata of a data element in a ISO mdoc.

MdocDocumentType

class MdocDocumentType

Class containing the metadata of an ISO mdoc Document Type.

MdocNamespace

class MdocNamespace

Class containing the metadata of a namespace in an ISO mdoc Document Type.

MdocNamespaceRequest

data class MdocNamespaceRequest(val namespace: String, val dataElementsToRequest: Map<MdocDataElement, Boolean>)

A class representing a request for data elements in a namespace.

MultiDocumentCannedRequest

data class MultiDocumentCannedRequest(val id: String, val displayName: String, val dcqlString: String) : DocumentCannedRequest

A well-known request for a multiple documents.

SingleDocumentCannedRequest

data class SingleDocumentCannedRequest(val id: String, val displayName: String, val mdocRequest: MdocCannedRequest?, val jsonRequest: JsonCannedRequest?, val transactionData: List<CannedTransactionData> = listOf()) : DocumentCannedRequest

A well-known request for a single document.

StringOption

data class StringOption(val value: String?, val displayName: String)

Class that represents a combination of a string value and a name suitable for display presentation.

TransactionType

abstract class TransactionType(val displayName: String, val identifier: String, attributes: List<MdocDataElement>, val kbJwtResponseClaimName: String = identifier, val mdocRequestInfoKeyName: String = identifier, val mdocResponseNamespace: String = identifier)

An object that represents a particular transaction data type.