Relationships Class
Manages Relationships.Relationships.
Methods
| Name | Description | |
|---|---|---|
| createInstance(props: RelationshipProps): Relationship | Create a new instance of a Relationship. | |
| deleteInstance(props: RelationshipProps): void | Delete an Relationship instance from this iModel. | |
| getInstance<T extends Relationship>(relClassSqlName: string, criteria: Id64String | SourceAndTarget): T extends Relationship | Get a Relationship instance | |
| getInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T extends RelationshipProps | Get the props of a Relationship instance | |
| insertInstance(props: RelationshipProps): Id64String | Insert a new relationship instance into the iModel. | |
| tryGetInstance<T extends Relationship>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T extends Relationship | undefined | Get a Relationship instance | |
| tryGetInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T extends RelationshipProps | undefined | Get the props of a Relationship instance | |
| updateInstance(props: RelationshipProps): void | Update the properties of an existing relationship instance in the iModel. |
Defined in
Last Updated: 08 January, 2020