wallet-sdk/com.youniqx.walletsdk.offer

Package-level declarations

Types

@Serializable

class ClaimDescription(val path: List<String>, val mandatory: Boolean, val display: Set<DisplayProperties>? = null)

An com.youniqx.walletsdk.attestation.Attestation Claim's display properties and metadata to help apps visualize the Attestation.

CredentialDownloadEvent

sealed interface CredentialDownloadEvent

Events returned by the CredentialOffer.continueWithAuthCodeUrl process.

CredentialOffer

interface CredentialOffer

The public interface for a CredentialOffer use case. Whenever credentials aka an com.youniqx.walletsdk.attestation.Attestation is available to a user, the offer is started by an URL provided via QR-Code or DeepLink. The content of this URL has to be passed to retrieveFromCredentialOffer to start the process of downloading and saving the credentials.

CredentialOfferEvent

sealed interface CredentialOfferEvent

Events returned by the CredentialOffer.retrieveFromCredentialOffer process.

CredentialOfferInfo

class CredentialOfferInfo(val issuerDisplayProperties: Set<DisplayProperties>? = null, val credentialFormatDisplay: Set<DisplayProperties>? = null)

CredentialOfferInfo contains information about a credential offered for download.

DisplayLogoProperties

@Serializable

class DisplayLogoProperties(val uri: String? = null, val altText: String? = null)

Object with information about the logo of an com.youniqx.walletsdk.attestation.Attestation or a com.youniqx.walletsdk.attestation.Claim

DisplayProperties

@Serializable

class DisplayProperties(val name: String? = null, val locale: String? = null, val logo: DisplayLogoProperties? = null, val description: String? = null, val backgroundColor: String? = null, val backgroundImage: DisplayLogoProperties? = null, val textColor: String? = null)

Set of information to help an app on how to display a Credential's com.youniqx.walletsdk.attestation.Claims and other data.