Package-level declarations

Types

Link copied to clipboard
data class CredentialFormat(val attachId: String, val format: String)

know Format: https://github.com/hyperledger/aries-rfcs/tree/main/features/0453-issue-credential-v2#propose-attachment-registry

Link copied to clipboard
data class CredentialPreview constructor(val schemaId: String? = null, val body: CredentialPreview.Body)

https://github.com/hyperledger/aries-rfcs/tree/main/features/0453-issue-credential-v2#preview-credential

Link copied to clipboard
data class IssueCredential(val id: String = UUID.randomUUID().toString(), val body: IssueCredential.Body, val attachments: Array<AttachmentDescriptor>, val thid: String?, val from: DID, val to: DID)

The IssueCredential class represents a credential issuance in the context of DIDComm messaging.

Link copied to clipboard

A class that represents the issue credential protocol in the DIDCommv2 format.

Link copied to clipboard
data class OfferCredential constructor(val id: String = UUID.randomUUID().toString(), val body: OfferCredential.Body, val attachments: Array<AttachmentDescriptor>, val thid: String?, val from: DID, val to: DID)

ALL parameters are DIDCOMMV2 format and naming conventions and follows the protocol https://github.com/hyperledger/aries-rfcs/tree/main/features/0453-issue-credential-v2

Link copied to clipboard
data class ProposeCredential constructor(val id: String = UUID.randomUUID().toString(), val body: ProposeCredential.Body, val attachments: Array<AttachmentDescriptor>, val thid: String?, val from: DID, val to: DID)

ALL parameters are DIDCOMMV2 format and naming conventions and follows the protocol https://github.com/hyperledger/aries-rfcs/tree/main/features/0453-issue-credential-v2

Link copied to clipboard
data class RequestCredential constructor(val id: String = UUID.randomUUID().toString(), val body: RequestCredential.Body, val attachments: Array<AttachmentDescriptor>, val thid: String?, val from: DID, val to: DID)

ALL parameters are DIDCOMMV2 format and naming conventions and follows the protocol https://github.com/hyperledger/aries-rfcs/tree/main/features/0453-issue-credential-v2

Functions

Link copied to clipboard
inline fun <T : Serializable> IssueCredential.Companion.build(fromDID: DID, toDID: DID, thid: String?, credentials: Map<String, T> = mapOf()): IssueCredential

Builds an instance of IssueCredential with the provided parameters.

inline fun <T : Serializable> RequestCredential.Companion.build(fromDID: DID, toDID: DID, thid: String?, credentials: Map<String, T> = mapOf()): RequestCredential

Builds a RequestCredential object using the provided parameters.

inline fun <T : Serializable> OfferCredential.Companion.build(fromDID: DID, toDID: DID, thid: String?, credentialPreview: CredentialPreview, credentials: Map<String, T> = mapOf()): OfferCredential

Builds an OfferCredential object with the provided data.

inline fun <T : Serializable> ProposeCredential.Companion.build(fromDID: DID, toDID: DID, thid: String?, credentialPreview: CredentialPreview, credentials: Map<String, T> = mapOf()): ProposeCredential

This method builds a ProposeCredential object based on the provided parameters. The ProposeCredential represents a proposal to issue a credential in the Atala PRISM architecture . The method takes in the following parameters: