API Reference › core-backend› Elements › ExternalSource

ExternalSource Class

An ExternalSource refers to an 'information container' found in a repository. In some cases, the container is the entire repository.

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

Extends

Extended by

Methods

Name Description
constructor(props: ExternalSourceProps, iModel: IModelDb): ExternalSource Protected    
collectReferenceIds(referenceIds: EntityReferenceSet): void Protected Collect the Ids of this entity's references at this level of the class hierarchy.  
toJSON(): ExternalSourceProps Obtain the JSON representation of this Entity.  
createCode(iModelDb: IModelDb, codeValue: string): Code Static Create a Code for an ExternalSource element given a name that is meant to be unique within the scope of the iModel.  
ensureCodeSpec(iModelDb: IModelDb): string Static The CodeSpec for ExternalSource elements is not automatically created, so this method ensures that it exists.  

Inherited methods

Name Inherited from Description
collectPredecessorIds(predecessorIds: EntityReferenceSet): void Protected InformationReferenceElement Collect the Ids of this element's references at this level of the class hierarchy.
delete(): void InformationReferenceElement Delete this Element from the iModel.
forEachProperty(func: PropertyCallback, includeCustom: booleantrue): void InformationReferenceElement Call a function for each property of this Entity.
getClassMetaData(): undefined | EntityMetaData InformationReferenceElement Get the class metadata for this element.
getDisplayLabel(): string InformationReferenceElement Get a display label for this Element.
getJsonProperty(nameSpace: string): any InformationReferenceElement Get a JSON property of this element, by namespace
getPredecessorIds(): Id64Set InformationReferenceElement Get the Ids of this element's references.
getReferenceIds(): EntityReferenceSet InformationReferenceElement Get the set of this entity's entity references, EntityReferenceSet.
getToolTipMessage(): string[] InformationReferenceElement Get a list of HTML strings that describe this Element for the tooltip.
getUserProperties(namespace: string): any InformationReferenceElement Get a set of JSON user properties by namespace
insert(): string InformationReferenceElement Insert this Element into the iModel.
removeUserProperties(nameSpace: string): void InformationReferenceElement Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(nameSpace: string, value: any): void InformationReferenceElement  
setUserProperties(nameSpace: string, value: any): void InformationReferenceElement Change a set of user JSON properties of this Element by namespace.
update(): void InformationReferenceElement Update this Element in the iModel.
is(otherClass: ): boolean Static InformationReferenceElement return whether this Entity class is a subclass of another Entity class
onAllInputsHandled(_id: string, _iModel: IModelDb): void Protected Static InformationReferenceElement Called on an element in a graph after all of its inputs have been processed and before its outputs are processed.
onBeforeOutputsHandled(_id: string, _iModel: IModelDb): void Protected Static InformationReferenceElement Called when a root element in a subgraph is changed and before its outputs are processed.
onChildAdd(_arg: OnChildElementPropsArg): void Protected Static InformationReferenceElement Called when an existing element is about to be updated so that an instance of this class will become its new parent.
onChildAdded(_arg: OnChildElementIdArg): void Protected Static InformationReferenceElement Called after an existing element has been updated so that an instance of this class is its new parent.
onChildDelete(_arg: OnChildElementIdArg): void Protected Static InformationReferenceElement Called when an element with an instance of this class as its parent is about to be deleted.
onChildDeleted(_arg: OnChildElementIdArg): void Protected Static InformationReferenceElement Called after an element with an instance of this class as its parent was successfully deleted.
onChildDrop(_arg: OnChildElementIdArg): void Protected Static InformationReferenceElement Called when an element with an instance of this class as its parent is about to be updated change to a different parent.
onChildDropped(_arg: OnChildElementIdArg): void Protected Static InformationReferenceElement Called after an element with an instance of this class as its previous parent was updated to have a new parent.
onChildInsert(_arg: OnChildElementPropsArg): void Protected Static InformationReferenceElement Called when a new element with an instance of this class as its parent is about to be inserted.
onChildInserted(_arg: OnChildElementIdArg): void Protected Static InformationReferenceElement Called after a new element with an instance of this class as its parent was inserted.
onChildUpdate(_arg: OnChildElementPropsArg): void Protected Static InformationReferenceElement Called when an element with an instance of this class as its parent is about to be updated.
onChildUpdated(_arg: OnChildElementIdArg): void Protected Static InformationReferenceElement Called after an element with an instance of this the class as its parent was updated.
onCloned(_context: IModelElementCloneContext, _sourceProps: ElementProps, _targetProps: ElementProps): void Protected Static InformationReferenceElement Called during the iModel transformation process after an Element from the source iModel was cloned for the target iModel.
onDelete(arg: OnElementIdArg): void Protected Static InformationReferenceElement Called before an Element is deleted.
onDeleted(_arg: OnElementIdArg): void Protected Static InformationReferenceElement Called after an Element was deleted.
onInsert(arg: OnElementPropsArg): void Protected Static InformationReferenceElement Called before a new Element is inserted.
onInserted(arg: OnElementIdArg): void Protected Static InformationReferenceElement Called after a new Element was inserted.
onSubModelDelete(_arg: OnSubModelIdArg): void Protected Static InformationReferenceElement Called when a sub-model of an instance of this class is being deleted.
onSubModelDeleted(_arg: OnSubModelIdArg): void Protected Static InformationReferenceElement Called after a sub-model of an instance of this class was deleted.
onSubModelInsert(_arg: OnSubModelPropsArg): void Protected Static InformationReferenceElement Called when an instance of this class is being sub-modeled by a new Model.
onSubModelInserted(_arg: OnSubModelIdArg): void Protected Static InformationReferenceElement Called after an instance of this class was sub-modeled by a new Model.
onUpdate(arg: OnElementPropsArg): void Protected Static InformationReferenceElement Called before an Element is updated.
onUpdated(_arg: OnElementIdArg): void Protected Static InformationReferenceElement Called after an Element was updated.

Properties

Name Type Description
connectorName string | undefined The name of the iModel Connecter that processed this ExternalSource.  
connectorVersion string | undefined The version of the iModel Connecter that processed this ExternalSource.  
repository ExternalSourceIsInRepository | undefined The repository that contains this ExternalSource.  

Inherited properties

Name Type Inherited from Description
classFullName Accessor ReadOnly string InformationReferenceElement Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor Static ReadOnly string InformationReferenceElement Get the full BIS class name of this Entity in the form "schema:class"
className Accessor ReadOnly string InformationReferenceElement The name of the BIS class associated with this class.
code Code InformationReferenceElement The Code for this element
federationGuid string | undefined InformationReferenceElement A FederationGuid assigned to this element by some other federated database
id string InformationReferenceElement The Id of this Entity.
iModel IModelDb InformationReferenceElement The IModelDb that contains this Entity
isInstanceOfEntity Readonly "true" InformationReferenceElement An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
jsonProperties Readonly [key: string]: any InformationReferenceElement Optional json properties of this element.
model Readonly string InformationReferenceElement The ModelId of the Model containing this element
parent RelatedElement | undefined InformationReferenceElement The parent element, if present, of this element.
requiredReferenceKeys Static Readonly ReadonlyArray InformationReferenceElement A required reference is an element that had to be inserted before this element could have been inserted.
schema Static InformationReferenceElement The Schema that defines this class.
schemaName Accessor ReadOnly string InformationReferenceElement The name of the BIS Schema that defines this class
userLabel string | undefined InformationReferenceElement A user-assigned label for this element.

Defined in

Last Updated: 13 November, 2024