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