multipaz/org.multipaz.document

Package-level declarations

Types

AbstractDocumentMetadata

interface AbstractDocumentMetadata

Interface for application metadata for a Document.

Document

class Document

This class represents a document created in DocumentStore.

DocumentAdded

class DocumentAdded(documentId: String) : DocumentEvent

A document was added to the DocumentStore.

DocumentBadge

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.

DocumentEvent

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.

DocumentStore

class DocumentStore

Class for storing real-world identity documents.

DocumentUpdated

class DocumentUpdated(documentId: String) : DocumentEvent

A document in the DocumentStore was updated.

DocumentUtil

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.

NameSpacedData

class NameSpacedData

Key/value pairs, organized by name space.

Properties

androidCredmanBitmap

val Document.androidCredmanBitmap: ByteString?

The bitmap for a document in Android Credential Manager or null if not configured.

androidCredmanExchangeProtocols

val Document.androidCredmanExchangeProtocols: List<String>?

The exchange protocols for a document in Android Credential Manager or null if not configured.

androidCredmanSubtitle

val Document.androidCredmanSubtitle: String?

The subtitle for a document in Android Credential Manager or null if not configured.

androidCredmanTitle

val Document.androidCredmanTitle: String?

The title for a document in Android Credential Manager or null if not configured.

Functions

buildDocumentStore

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

Builds a DocumentStore

setAndroidCredmanBitmap

suspend fun Document.setAndroidCredmanBitmap(value: ByteString?)

Sets bitmap for a document in Android Credential Manager.

setAndroidCredmanExchangeProtocols

suspend fun Document.setAndroidCredmanExchangeProtocols(value: List<String>?)

Sets exchange protocols for a document in Android Credential Manager.

setAndroidCredmanSubtitle

suspend fun Document.setAndroidCredmanSubtitle(value: String?)

Sets the subtitle for a document in Android Credential Manager.

setAndroidCredmanTitle

suspend fun Document.setAndroidCredmanTitle(value: String?)

Sets the title for a document in Android Credential Manager.