DocumentAttributeGroup

data class DocumentAttributeGroup(val identifier: String, val displayName: String, val description: String = "", val icon: Icon? = null, val sensitivity: DocumentAttributeSensitivity = DocumentAttributeSensitivity.PII, val minClaimsToGroup: Int = 2)

Metadata for a logical group of DocumentAttributes that can be collapsed into a single pseudo-claim in the consent prompt when at least minClaimsToGroup attributes from the group are requested together.

Constructors

Link copied to clipboard
constructor(identifier: String, displayName: String, description: String = "", icon: Icon? = null, sensitivity: DocumentAttributeSensitivity = DocumentAttributeSensitivity.PII, minClaimsToGroup: Int = 2)

Properties

Link copied to clipboard

localized description of the group.

Link copied to clipboard

localized name suitable for display in the UI (e.g. "Name").

Link copied to clipboard
val icon: Icon?

icon to display for the grouped pseudo-claim, if available.

Link copied to clipboard

unique identifier for the group within a document type (e.g. "name").

Link copied to clipboard

minimum number of requested claims in this group required before collapsing into the pseudo-claim (e.g. 2 for composite fields like "Name", 1 for "Passport data").

Link copied to clipboard

sensitivity of the grouped pseudo-claim, defaults to DocumentAttributeSensitivity.PII.