EdgeAgentSDK/org.hyperledger.identus.walletsdk.domain.buildingblocks/Pluto

Pluto

interface Pluto(source)

The Pluto interface defines the contract for storing and retrieving various data related to Atala PRISM architecture.

Inheritors

Functions

Link copied to clipboard
abstract fun getAllCredentials(): Flow<List<CredentialRecovery>>

Retrieves all credentials for credential recovery.

Link copied to clipboard
abstract fun getAllDidPairs(): Flow<List<DIDPair>>

Retrieves all the pairs of DIDs stored in the system.

Link copied to clipboard
abstract fun getAllDIDs(): Flow<List<DID>>

Retrieves all DIDs.

Link copied to clipboard
Link copied to clipboard
abstract fun getAllMediators(): Flow<List<Mediator>>

Returns a Flow of lists of Mediator objects representing all the available mediators.

Link copied to clipboard
abstract fun getAllMessages(): Flow<List<Message>>

Retrieves all the messages.

abstract fun getAllMessages(did: DID): Flow<List<Message>>

Retrieves all messages based on the provided DID.

abstract fun getAllMessages(from: DID, to: DID): Flow<List<Message>>

Retrieves all messages exchanged between the specified 'from' and 'to' DIDs.

Link copied to clipboard
abstract fun getAllMessagesByType(type: String): Flow<List<Message>>
Link copied to clipboard
abstract fun getAllMessagesOfType(type: String, relatedWithDID: DID?): Flow<List<Message>>

Retrieves all messages of a specific type that are related to a given DID.

Link copied to clipboard
abstract fun getAllMessagesReceived(): Flow<List<Message>>

Retrieves all messages received by the user.

Link copied to clipboard
abstract fun getAllMessagesReceivedFrom(did: DID): Flow<List<Message>>

Returns a Flow of lists of all messages received from the specified DID.

Link copied to clipboard
abstract fun getAllMessagesSent(): Flow<List<Message>>

Retrieves all the messages that have been sent.

Link copied to clipboard
abstract fun getAllMessagesSentTo(did: DID): Flow<List<Message>>

Retrieves all messages sent to the specified DID.

Link copied to clipboard
abstract fun getAllPeerDIDs(): Flow<List<PeerDID>>

Retrieves all PeerDIDs.

Link copied to clipboard
abstract fun getAllPrismDIDs(): Flow<List<PrismDIDInfo>>

Retrieves all PrismDIDs and their associated information.

Link copied to clipboard
abstract fun getAllPrivateKeys(): Flow<List<StorablePrivateKey?>>

Retrieves a list of all private keys.

Link copied to clipboard
abstract fun getAvailableClaimsByClaim(claim: String): Flow<Array<AvailableClaims>>

Retrieves the available claims for a given claim.

Link copied to clipboard
abstract fun getAvailableClaimsByCredentialId(credentialId: String): Flow<Array<AvailableClaims>>

Retrieves the available claims for a given credential ID.

Link copied to clipboard
abstract fun getCredentialMetadata(linkSecretName: String): Flow<CredentialRequestMeta?>

Retrieves the metadata associated with a credential request.

Link copied to clipboard
abstract fun getDIDInfoByAlias(alias: String): Flow<List<PrismDIDInfo>>

Retrieves the PrismDIDInfo objects associated with a given alias.

Link copied to clipboard
abstract fun getDIDInfoByDID(did: DID): Flow<PrismDIDInfo?>

Retrieves the PrismDIDInfo associated with a given DID.

Link copied to clipboard
abstract fun getDIDPrivateKeyByID(id: String): Flow<StorablePrivateKey?>

Retrieves the private key associated with a given ID.

Link copied to clipboard
abstract fun getDIDPrivateKeysByDID(did: DID): Flow<List<StorablePrivateKey?>>

Retrieves a list of private keys associated with a given DID.

Link copied to clipboard
abstract fun getLinkSecret(): Flow<String?>

Retrieves the secret link associated with the current instance.

Link copied to clipboard
abstract fun getMessage(id: String): Flow<Message?>

Retrieves the message with the specified ID.

Link copied to clipboard
abstract fun getMessageByThidAndPiuri(thid: String, piuri: String): Flow<Message?>

Retrieves the message with the specified thid.

Link copied to clipboard
abstract fun getPairByDID(did: DID): Flow<DIDPair?>

Retrieves a DIDPair object using the provided DID.

Link copied to clipboard
abstract fun getPairByName(name: String): Flow<DIDPair?>

Retrieve a DIDPair from a flow by its name.

Link copied to clipboard
abstract fun getPrismDIDKeyPathIndex(did: DID): Flow<Int?>

Retrieves the key path index associated with a given Prism DID.

Link copied to clipboard
abstract fun getPrismLastKeyPathIndex(): Flow<Int>

Retrieves the last key path index associated with the Prism DID.

Link copied to clipboard
abstract fun insertAvailableClaim(credentialId: String, claim: String)

Inserts an available claim for a specific credential.

Link copied to clipboard
abstract fun insertAvailableClaims(credentialId: String, claims: Array<String>)

Inserts the available claims for a given credential ID.

Link copied to clipboard
abstract fun observeRevokedCredentials(): Flow<List<CredentialRecovery>>

Provides a flow to listen for revoked credentials.

Link copied to clipboard
abstract fun revokeCredential(credentialId: String)

Revokes an existing credential using the credential ID.

Link copied to clipboard
abstract suspend fun start(context: Any? = null)
Link copied to clipboard
abstract fun storeCredential(storableCredential: StorableCredential)

Stores a credential in the system.

Link copied to clipboard
abstract fun storeCredentialMetadata(name: String, metadata: CredentialRequestMeta)
abstract fun storeCredentialMetadata(name: String, linkSecretName: String, json: String)

Stores the metadata associated with a credential request.

Link copied to clipboard
abstract fun storeDIDPair(host: DID, receiver: DID, name: String)

Stores a pair of Distributed Identifier (DID) and a receiver DID with a given name.

Link copied to clipboard
abstract fun storeLinkSecret(linkSecret: String)

Stores a link secret in the system.

Link copied to clipboard
abstract fun storeMediator(mediator: DID, host: DID, routing: DID)

Stores a mediator in the system.

Link copied to clipboard
abstract fun storeMessage(message: Message)

Stores a message in the system.

Link copied to clipboard
abstract fun storeMessages(messages: List<Message>)

Stores a list of messages in the system.

Link copied to clipboard
abstract fun storePeerDID(did: DID)

Stores the PeerDID in the system.

Link copied to clipboard
abstract fun storePrismDIDAndPrivateKeys(did: DID, keyPathIndex: Int?, alias: String?, privateKeys: List<StorableKey>)

Stores the Prism DID, key path index, alias, and private keys.

Link copied to clipboard
abstract fun storePrivate(sorableKey: StorableKey, recoveryId: String)

Stores a private key with its recovery ID.

Link copied to clipboard
abstract fun storePrivateKeys(storableKey: StorableKey, did: DID, keyPathIndex: Int? = null, metaId: String? = null)

Stores the private key along with additional information.