API Reference › core-backend› Relationships › SynchronizationConfigSpecifiesRootSources

SynchronizationConfigSpecifiesRootSources Class @beta

Relates a SynchronizationConfigLink to root ExternalSource instances.

@note The associated ECClass was added to the BisCore schema in version 1.0.13

Extends

Methods

Name Description
constructor(props: RelationshipProps, iModel: IModelDb): SynchronizationConfigSpecifiesRootSources Protected    

Inherited methods

Name Inherited from Description
collectReferenceIds(referenceIds: EntityReferenceSet): void Protected Inherited SynchronizationConfigProcessesSources Collect the Ids of this entity's references at this level of the class hierarchy.
delete(): void Inherited SynchronizationConfigProcessesSources Delete this Relationship from the iModel.
forEach(func: PropertyHandler, includeCustom: boolean = true): void Inherited SynchronizationConfigProcessesSources Call a function for each property of this Entity.
forEachProperty(func: PropertyCallback, includeCustom: boolean = true): void Inherited SynchronizationConfigProcessesSources Call a function for each property of this Entity.
getMetaData(): Promise<RelationshipClass> Inherited SynchronizationConfigProcessesSources Query metadata for this relationship class from the iModel's schema.
getReferenceIds(): EntityReferenceSet Inherited SynchronizationConfigProcessesSources Get the set of this entity's entity references, EntityReferenceSet.
insert(): string Inherited SynchronizationConfigProcessesSources Insert this Relationship into the iModel.
toJSON(): RelationshipProps Inherited SynchronizationConfigProcessesSources Obtain the JSON representation of this Entity.
update(): void Inherited SynchronizationConfigProcessesSources Update this Relationship in the iModel.
create<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: string, targetId: string): T Static Inherited SynchronizationConfigProcessesSources Create an instance of the Relationship.
deserialize(props: DeserializeEntityArgs): EntityProps Static Inherited SynchronizationConfigProcessesSources Converts an ECSqlRow of an Entity to an EntityProps.
getInstance<T extends Relationship>(iModel: IModelDb, criteria: string | SourceAndTarget): T Static Inherited SynchronizationConfigProcessesSources  
insert<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: string, targetId: string): string Static Inherited SynchronizationConfigProcessesSources Insert a new instance of the Relationship.
is(otherClass: Entity): boolean Static Inherited SynchronizationConfigProcessesSources return whether this Entity class is a subclass of another Entity class
onDeletedDependency(_props: RelationshipProps, _iModel: IModelDb): void Static Inherited SynchronizationConfigProcessesSources Callback invoked by saveChanges on an ElementDrivesElement relationship when the relationship instance has been deleted.
onRootChanged(_props: RelationshipProps, _iModel: IModelDb): void Static Inherited SynchronizationConfigProcessesSources Callback invoked by saveChanges on an ElementDrivesElement relationship when its input has changed or is the output of some upstream relationship whose input has changed.
serialize(props: EntityProps, _iModel: IModelDb): ECSqlRow Static Inherited SynchronizationConfigProcessesSources Converts an EntityProps to an ECSqlRow.

Properties

Name Type Description
className Accessor Static ReadOnly string The name of the BIS class associated with this class.  

Inherited properties

Name Type Inherited from Description
_customHandledProps Protected Static Readonly Inherited CustomHandledProperty[] SynchronizationConfigProcessesSources List of properties that are need to be custom handled during deserialization and serialization.
_metadata Protected Inherited EntityClass | RelationshipClass SynchronizationConfigProcessesSources Cached Metadata for the ECClass
classFullName Accessor Inherited ReadOnly string SynchronizationConfigProcessesSources Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor Static Inherited ReadOnly string SynchronizationConfigProcessesSources Get the full BIS class name of this Entity in the form "schema:class"
className Accessor Inherited ReadOnly string SynchronizationConfigProcessesSources The name of the BIS class associated with this class.
id Inherited string SynchronizationConfigProcessesSources The Id of this Entity.
iModel Inherited IModelDb SynchronizationConfigProcessesSources The IModelDb that contains this Entity
isInstanceOfEntity Readonly Inherited "true" SynchronizationConfigProcessesSources An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
schema Static Inherited Schema SynchronizationConfigProcessesSources The Schema that defines this class.
schemaItemKey Accessor Inherited ReadOnly SchemaItemKey SynchronizationConfigProcessesSources Get the item key used by the ecschema-metadata package to identify this entity class
schemaItemKey Accessor Static Inherited ReadOnly SchemaItemKey SynchronizationConfigProcessesSources Serves as a unique identifier for this class. Typed variant of classFullName.
schemaName Accessor Inherited ReadOnly string SynchronizationConfigProcessesSources The name of the BIS Schema that defines this class
sourceId Readonly Inherited string SynchronizationConfigProcessesSources  
targetId Readonly Inherited string SynchronizationConfigProcessesSources  

Defined in

Last Updated: 28 October, 2025