@bloock/sdk / StringAttributeDescriptor
Class: StringAttributeDescriptor
Represents a descriptor for an attribute with a string value.
Hierarchy
-
↳
StringAttributeDescriptor
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new StringAttributeDescriptor(displayName, technicalName, description, required): StringAttributeDescriptor
Parameters
| Name | Type |
|---|---|
displayName | string |
technicalName | string |
description | string |
required | boolean |
Returns
Overrides
AttributeDescriptor.constructor
Defined in
entity/identity/string_attribute_descriptor.ts:8
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
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(): StringAttributeDefinition
Returns
StringAttributeDefinition
Defined in
entity/identity/string_attribute_descriptor.ts:17
fromProto
▸ fromProto(r): StringAttributeDescriptor
Parameters
| Name | Type |
|---|---|
r | StringAttributeDefinition |