Home > @i2analyze/i2connect > records > ISeedRecordBase > getProperty
records.ISeedRecordBase.getProperty() method
Gets the value of the specified property of the seed record.
Signature:
getProperty<TItemType extends schema.IItemType, TPropertyName extends PropertyTypeDisplayNames<TItemType>>(itemType: TItemType, displayName: TPropertyName): data.PropertyValueType<PropertyTypeFromDisplayName<TItemType, TPropertyName>> | undefined;
Introduced: API version 1.0
Type Parameters
Parameter | Type | Description |
---|---|---|
TItemType | extends schema.IItemType | The item type of the seed record, which is inferred from the itemType parameter. |
TPropertyName | extends PropertyTypeDisplayNames<TItemType> | The display name of the property type, which is inferred from the 'displayName' parameter. |
Parameters
Parameter | Type | Description |
---|---|---|
itemType | TItemType | The item type of the seed record. |
displayName | TPropertyName | The display name of the property type. |
Returns:
data.PropertyValueType<PropertyTypeFromDisplayName<TItemType, TPropertyName>> | undefined
The property value.
Remarks
This method retrieves the value of the property whose type has the specified display name, provided that the seed record is of the specified item type.