API Reference › core-backend› Models › DictionaryModel

DictionaryModel Class @preview

The singleton container for repository-specific definition elements.

Extends

Methods

Name Description
constructor(props: ModelProps, iModel: IModelDb): DictionaryModel Protected    

Inherited methods

Name Inherited from Description
collectReferenceIds(referenceIds: EntityReferenceSet): void Protected Inherited DefinitionModel Collect the Ids of this entity's references at this level of the class hierarchy.
delete(): void Inherited DefinitionModel Delete this Model from the iModel.
forEach(func: PropertyHandler, includeCustom: booleantrue): void Inherited DefinitionModel Call a function for each property of this Entity.
forEachProperty(func: PropertyCallback, includeCustom: booleantrue): void Inherited DefinitionModel Call a function for each property of this Entity.
getJsonProperty(name: string): any Inherited DefinitionModel  
getMetaData(): Promise<EntityClass | RelationshipClass> Inherited DefinitionModel Query metadata for this entity class from the iModel's schema.
getReferenceIds(): EntityReferenceSet Inherited DefinitionModel Get the set of this entity's entity references, EntityReferenceSet.
getUserProperties(namespace: string): any Inherited DefinitionModel Get a set of JSON user properties by namespace
insert(): string Inherited DefinitionModel Insert this Model in the iModel
removeUserProperties(nameSpace: string): void Inherited DefinitionModel Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(name: string, value: any): void Inherited DefinitionModel  
setUserProperties(nameSpace: string, value: any): void Inherited DefinitionModel Change a set of user JSON properties of this Element by namespace.
toJSON(): ModelProps Inherited DefinitionModel Obtain the JSON representation of this Entity.
update(): void Inherited DefinitionModel Update this Model in the iModel.
deserialize(props: DeserializeEntityArgs): ModelProps Static Inherited DefinitionModel Converts an ECSqlRow of an Entity to an EntityProps.
insert(iModelDb: IModelDb, parentSubjectId: string, name: string): string Static Inherited DefinitionModel Insert a DefinitionPartition and a DefinitionModel that sub-models it.
is(otherClass: Entity): boolean Static Inherited DefinitionModel return whether this Entity class is a subclass of another Entity class
onDelete(arg: OnModelIdArg): void Protected Static Inherited DefinitionModel Called before a Model is deleted.
onDeleted(arg: OnModelIdArg): void Protected Static Inherited DefinitionModel Called after a Model was deleted.
onDeletedElement(arg: OnElementInModelIdArg): void Protected Static Inherited DefinitionModel Called after an Element in an instance of a Model of this class has been deleted.
onDeleteElement(_arg: OnElementInModelIdArg): void Protected Static Inherited DefinitionModel Called when an Element in an instance of a Model of this class is about to be deleted.
onInsert(arg: OnModelPropsArg): void Protected Static Inherited DefinitionModel Called before a new Model is inserted.
onInserted(_arg: OnModelIdArg): void Protected Static Inherited DefinitionModel Called after a new Model is inserted.
onInsertedElement(arg: OnElementInModelIdArg): void Protected Static Inherited DefinitionModel Called after an Element has been inserted into an instance of a Model of this class.
onInsertElement(_arg: OnElementInModelPropsArg): void Protected Static Inherited DefinitionModel Called before a prospective Element is to be inserted into an instance of a Model of this class.
onUpdate(arg: OnModelPropsArg): void Protected Static Inherited DefinitionModel Called before a Model is updated.
onUpdated(arg: OnModelIdArg): void Protected Static Inherited DefinitionModel Called after a Model is updated.
onUpdatedElement(arg: OnElementInModelIdArg): void Protected Static Inherited DefinitionModel Called after an Element in an instance of a Model of this class has been updated.
onUpdateElement(_arg: OnElementInModelPropsArg): void Protected Static Inherited DefinitionModel Called when an Element in an instance of a Model of this class is about to be updated.
serialize(props: ModelProps, _iModel: IModelDb): ECSqlRow Static Inherited DefinitionModel 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[] DefinitionModel List of properties that are need to be custom handled during deserialization and serialization.
_metadata Protected Inherited EntityClass | RelationshipClass DefinitionModel Cached Metadata for the ECClass
classFullName Accessor Inherited ReadOnly string DefinitionModel Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor Static Inherited ReadOnly string DefinitionModel Get the full BIS class name of this Entity in the form "schema:class"
className Accessor Inherited ReadOnly string DefinitionModel The name of the BIS class associated with this class.
id Inherited string DefinitionModel The Id of this Entity.
iModel Inherited IModelDb DefinitionModel The IModelDb that contains this Entity
isInstanceOfEntity Readonly Inherited "true" DefinitionModel An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
isPrivate Inherited boolean DefinitionModel  
isTemplate Inherited boolean DefinitionModel  
jsonProperties Readonly Inherited [key: string]: any DefinitionModel  
modeledElement Readonly Inherited RelatedElement DefinitionModel  
name Readonly Inherited string DefinitionModel  
parentModel Readonly Inherited string | undefined DefinitionModel  
schema Static Inherited Schema DefinitionModel The Schema that defines this class.
schemaItemKey Accessor Inherited ReadOnly SchemaItemKey DefinitionModel Get the item key used by the ecschema-metadata package to identify this entity class
schemaItemKey Accessor Static Inherited ReadOnly SchemaItemKey DefinitionModel Serves as a unique identifier for this class. Typed variant of classFullName.
schemaName Accessor Inherited ReadOnly string DefinitionModel The name of the BIS Schema that defines this class

Defined in

Last Updated: 22 October, 2025