multipaz-provisioning-api/org.multipaz.provisioning/IssuingAuthority

IssuingAuthority

interface IssuingAuthority : RpcNotifiable<IssuingAuthorityNotification>

An interface representing an Issuing Authority.

An IssuingAuthority instance represents a particular document type from a particular issuer. If a single issuer has documents of different types, an IssuingAuthority instance is needed for each type.

Documents are identifier by an identifier - documentId - and each document may have multiple credentials associated with it.

Functions

Link copied to clipboard
open suspend fun collect(collector: FlowCollector<IssuingAuthorityNotification>)
Link copied to clipboard
abstract suspend fun completeProof(proofing: Proofing)
Link copied to clipboard
abstract suspend fun completeRegistration(registration: Registration)
Link copied to clipboard
abstract suspend fun completeRequestCredentials(requestCredentials: RequestCredentials)
Link copied to clipboard
abstract suspend fun developerModeRequestUpdate(documentId: String, requestRemoteDeletion: Boolean, notifyApplicationOfUpdate: Boolean)

Request update of the document data

Link copied to clipboard
open suspend fun dispose()
Link copied to clipboard
abstract suspend fun getConfiguration(): IssuingAuthorityConfiguration

Performs a network call to get configuration for the Issuing Authority.

Link copied to clipboard
abstract suspend fun getCredentials(documentId: String): List<CredentialData>

Calls the IA to get available credentials.

Link copied to clipboard
abstract suspend fun getDocumentConfiguration(documentId: String): DocumentConfiguration

Calls the issuer to get configuration for the configured document.

Link copied to clipboard
abstract suspend fun getState(documentId: String): DocumentState

Performs a network call to the Issuing Authority to get information about a document.

Link copied to clipboard
abstract suspend fun proof(documentId: String): Proofing

Calls the issuer to start proofing the applicant.

Link copied to clipboard
abstract suspend fun register(): Registration

Calls the issuer to start creating a document.

Link copied to clipboard
abstract suspend fun requestCredentials(documentId: String): RequestCredentials

Request issuance of credentials for a document.