Package-level declarations

Types

Link copied to clipboard

Interface for application metadata for a Document.

Link copied to clipboard
@ObjCName(name = "MultipazDocument")
class Document

This class represents a document created in DocumentStore.

Link copied to clipboard
class DocumentAdded(documentId: String) : DocumentEvent

A document was added to the DocumentStore.

Link copied to clipboard
data class DocumentBadge(val text: String, val color: DocumentBadgeColor)

A badge to display on a document.

Link copied to clipboard
data class DocumentBadgeColor(val red: Int, val green: Int, val blue: Int)

Data type for the color of a badge.

Link copied to clipboard
class DocumentCredentialUsageUpdated(documentId: String, val credentialId: String) : DocumentEvent

Emitted when a org.multipaz.credential.Credential's usage count is incremented without modifying document metadata, claims, or certified credential availability.

Link copied to clipboard
class DocumentDeleted(documentId: String) : DocumentEvent

A document was deleted from the DocumentStore.

Link copied to clipboard
sealed class DocumentEvent(val documentId: String)

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

Link copied to clipboard
class DocumentRequest(val requestedDataElements: List<DocumentRequest.DataElement>)

Document request.

Link copied to clipboard

Class for storing real-world identity documents.

Link copied to clipboard
class DocumentUpdated(documentId: String) : DocumentEvent

A document in the DocumentStore was updated.

Link copied to clipboard

A set of utilities and helpers for working with documents.

Link copied to clipboard
class ImportMpzPassException(message: String? = null, cause: Throwable? = null) : Exception

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

Link copied to clipboard

Key/value pairs, organized by name space.

Functions

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

Builds a DocumentStore

Link copied to clipboard

Gets the list of ISO mdoc document types that the application has registered for in its iOS manifest.

Link copied to clipboard

Gets the list of IETF SD-JWT VC verifiable credential types (vct) that the application has registered for in its iOS manifest.

Link copied to clipboard

Sets the list of ISO mdoc document types that the application has registered for in its iOS manifest.

Link copied to clipboard

Sets the list of IETF SD-JWT VC verifiable credential types (vct) that the application has registered for in its iOS manifest.