Home > @i2analyze/i2connect > services > IResult > getLink
services.IResult.getLink() method
Gets a previously added link record from the result, whose identifier is a string that you provided or a source identifier that you created.
Signature:
getLink<TLinkType extends schema.ILinkType, TFromEnd extends records.ISeededResultEntityRecord | records.IResultEntityRecord, TToEnd extends records.ISeededResultEntityRecord | records.IResultEntityRecord, TIdType extends records.ResultRecordIdType>(type: TLinkType, id: TIdType): records.IResultLinkRecord<TLinkType, TFromEnd, TToEnd, TIdType> | undefined;
Introduced: API version 2.0
Type Parameters
| Parameter | Type | Description |
|---|---|---|
| TLinkType | extends schema.ILinkType | The type of the link record. |
| TFromEnd | extends records.ISeededResultEntityRecord | records.IResultEntityRecord | The type of the entity record at the "from" end of the link. |
| TToEnd | extends records.ISeededResultEntityRecord | records.IResultEntityRecord | The type of the entity record at the "to" end of the link. |
| TIdType | extends records.ResultRecordIdType | The type of identifier of the link record. |
Parameters
| Parameter | Type | Description |
|---|---|---|
| type | TLinkType | The link type of the record. |
| id | TIdType | The identifier or source identifier of the record. |
Returns:
records.IResultLinkRecord<TLinkType, TFromEnd, TToEnd, TIdType> | undefined
The link record that was previously added to the result, or undefined if it was not previously added.