@bloock/sdk / AttributeDescriptor
Class: AttributeDescriptor
Represents a descriptor for an attribute.
Hierarchy
-
AttributeDescriptor↳
StringEnumAttributeDescriptor
Table of contents
Constructors
Properties
Constructors
constructor
• new AttributeDescriptor(displayName, technicalName, description, required): AttributeDescriptor
Constructs an AttributeDescriptor object with the specified parameters.
Parameters
| Name | Type |
|---|---|
displayName | string |
technicalName | string |
description | string |
required | boolean |
Returns
Defined in
entity/identity/attribute_descriptor.ts:29
Properties
description
• Optional description: string
Is a description providing additional information about the attribute.
Defined in
entity/identity/attribute_descriptor.ts:16
displayName
• displayName: string
Is the human-readable display name of the attribute.
Defined in
entity/identity/attribute_descriptor.ts:8
required
• required: boolean
Specifies whether the attribute is required.
Defined in
entity/identity/attribute_descriptor.ts:20
technicalName
• technicalName: string
Is the identifier for the attribute.