openid-data-classes/at.asitplus.openid.dcql/DCQLIsoMdocClaimsQuery

DCQLIsoMdocClaimsQuery

@Serializable

data class DCQLIsoMdocClaimsQuery(val id: DCQLClaimsQueryIdentifier? = null, val values: List<DCQLExpectedClaimValue>? = null, val path: DCQLClaimsPathPointer, val intentToRetain: Boolean? = null) : DCQLClaimsQuery(source)

Constructors

constructor(id: DCQLClaimsQueryIdentifier? = null, values: List<DCQLExpectedClaimValue>? = null, path: DCQLClaimsPathPointer, intentToRetain: Boolean? = null)

Types

SerialNames

object SerialNames

Properties

claimName

@Transient

val claimName: String

@SerialName(value = "id")

open override val id: DCQLClaimsQueryIdentifier?

OID4VP draft 23: id: REQUIRED if claim_sets is present in the Credential Query; OPTIONAL otherwise. A string identifying the particular claim. The value MUST be a non-empty string consisting of alphanumeric, underscore (_) or hyphen (-) characters. Within the particular claims array, the same id MUST NOT be present more than once.

intentToRetain

@SerialName(value = "intent_to_retain")

val intentToRetain: Boolean?

OID4VP draft 28: OPTIONAL. A boolean that is equivalent to IntentToRetain variable defined in Section 8.3.2.1.2.1 of ISO 18013-5.

namespace

@Transient

val namespace: String

path

@SerialName(value = "path")

open override val path: DCQLClaimsPathPointer

OID4VP 1.0: REQUIRED The value MUST be a non-empty array representing a claims path pointer that specifies the path to a claim within the Credential, as defined in Section 7.

values

@SerialName(value = "values")

open override val values: List<DCQLExpectedClaimValue>?

OID4VP draft 23: values: OPTIONAL. An array of strings, integers or boolean values that specifies the expected values of the claim. If the values property is present, the Wallet SHOULD return the claim only if the type and value of the claim both match for at least one of the elements in the array. Details of the processing rules are defined in Section 6.3.1.1.

Functions

executeClaimsQueryAgainstCredential

open fun executeClaimsQueryAgainstCredential(credentialStructure: DCQLCredentialClaimStructure): KmmResult<DCQLClaimsQueryResult>

6.3.1.1. Selecting Claims

fun executeClaimsQueryAgainstCredential(credentialStructure: DCQLCredentialClaimStructure.IsoMdocStructure): KmmResult<DCQLClaimsQueryResult.IsoMdocResult>

executeIsoMdocClaimsQueryAgainstCredential

fun ~~executeIsoMdocClaimsQueryAgainstCredential~~(credentialStructure: DCQLCredentialClaimStructure.IsoMdocStructure): KmmResult<DCQLClaimsQueryResult.IsoMdocResult>