Relationships Class

Manages 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<T>>(relClassSqlName: string, criteria: string | SourceAndTarget): T Get a Relationship instance  
getInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: string | SourceAndTarget): T Get the props of a Relationship instance  
insertInstance(props: RelationshipProps): string Insert a new relationship instance into the iModel.  
tryGetInstance<T extends Relationship<T>>(relClassFullName: string, criteria: string | SourceAndTarget): undefined | T Get a Relationship instance  
tryGetInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: string | SourceAndTarget): undefined | T 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: 29 March, 2024