Home > @i2analyze/i2connect > records > IResultLinkRecord
records.IResultLinkRecord interface
A new result link record.
Signature:
interface IResultLinkRecord<TLinkType extends schema.ILinkType, TFromEnd extends ISeededResultEntityRecord | IResultEntityRecord | IResultEntityRecord<schema.IEntityType, ISourceIdentifier>, TToEnd extends ISeededResultEntityRecord | IResultEntityRecord | IResultEntityRecord<schema.IEntityType, ISourceIdentifier>, TIdType extends ResultRecordIdType = ResultRecordId> extends IResultRecordBase<TLinkType, TIdType>
Extends: IResultRecordBase<TLinkType, TIdType>
Introduced: API version 1.0
Type Parameters
| Parameter | Type | Description |
|---|---|---|
| TLinkType | extends schema.ILinkType | The type of the result record. |
| TFromEnd | extends ISeededResultEntityRecord | IResultEntityRecord | IResultEntityRecord<schema.IEntityType, ISourceIdentifier> | The type of the entity record at the "from" end of the link. |
| TToEnd | extends ISeededResultEntityRecord | IResultEntityRecord | IResultEntityRecord<schema.IEntityType, ISourceIdentifier> | The type of the entity record at the "to" end of the link. |
| TIdType | extends ResultRecordIdType (default: ResultRecordId) | The type of the identifier for the result record.. |
Properties
| Property | Type | Description |
|---|---|---|
| fromEnd | TFromEnd | Gets the entity record at the "from" end of the link. |
| id | TIdType | Gets the identifier of the result record. (Inherited from IResultRecordBase) |
| linkDirection | data.LinkDirection | Gets the direction of the link. |
| toEnd | TToEnd | Gets the entity record at the "to" end of the link. |
Methods
| Method | Description |
|---|---|
| setProperties(properties) | Sets the values of several properties on the result record. (Inherited from IRecordProperties) |
| setProperty(displayName, value) | Sets the value of a property on the result record. (Inherited from IRecordProperties) |
| setSourceReference(sourceReference) | Adds a source reference to the result record. (Inherited from IRecordProperties) |