multipaz/org.multipaz.document

Package-level declarations

Types

AbstractDocumentMetadata

interface AbstractDocumentMetadata

Interface for application metadata for a Document.

This class represents a document created in DocumentStore.

class DocumentAdded(documentId: String) : DocumentEvent

A document was added to the DocumentStore.

data class DocumentBadge(val text: String, val color: DocumentBadgeColor)

A badge to display on a document.

DocumentBadgeColor

data class DocumentBadgeColor(val red: Int, val green: Int, val blue: Int)

Data type for the color of a badge.

DocumentDeleted

class DocumentDeleted(documentId: String) : DocumentEvent

A document was deleted from the DocumentStore.

sealed class DocumentEvent

Event describing a change in a Document in the DocumentStore or DocumentStore itself.

DocumentRequest

class ~~DocumentRequest~~(val requestedDataElements: List<DocumentRequest.DataElement>)

Document request.

class DocumentStore

Class for storing real-world identity documents.

DocumentUpdated

class DocumentUpdated(documentId: String) : DocumentEvent

A document in the DocumentStore was updated.

object DocumentUtil

A set of utilities and helpers for working with documents.

ImportMpzPassException

class ImportMpzPassException(message: String? = null, cause: Throwable? = null) : Exception

Thrown when importing a org.multipaz.mpzpass.MpzPass into DocumentStore fails.

class NameSpacedData

Key/value pairs, organized by name space.

Functions

buildDocumentStore

inline fun buildDocumentStore(storage: Storage, secureAreaRepository: SecureAreaRepository, builderAction: DocumentStore.Builder.() -> Unit): DocumentStore

Builds a DocumentStore