API Reference › core-backend› Models › DictionaryModel

DictionaryModel Class

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 DefinitionModel Collect the Ids of this entity's references at this level of the class hierarchy.
delete(): void DefinitionModel Delete this Model from the iModel.
forEachProperty(func: PropertyCallback, includeCustom: booleantrue): void DefinitionModel Call a function for each property of this Entity.
getJsonProperty(name: string): any DefinitionModel  
getReferenceIds(): EntityReferenceSet DefinitionModel Get the set of this entity's entity references, EntityReferenceSet.
getUserProperties(namespace: string): any DefinitionModel Get a set of JSON user properties by namespace
insert(): string DefinitionModel Insert this Model in the iModel
removeUserProperties(nameSpace: string): void DefinitionModel Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(name: string, value: any): void DefinitionModel  
setUserProperties(nameSpace: string, value: any): void DefinitionModel Change a set of user JSON properties of this Element by namespace.
toJSON(): ModelProps DefinitionModel Obtain the JSON representation of this Entity.
update(): void DefinitionModel Update this Model in the iModel.
insert(iModelDb: IModelDb, parentSubjectId: string, name: string): string Static DefinitionModel Insert a DefinitionPartition and a DefinitionModel that sub-models it.
is(otherClass: ): boolean Static DefinitionModel return whether this Entity class is a subclass of another Entity class
onDelete(arg: OnModelIdArg): void Protected Static DefinitionModel Called before a Model is deleted.
onDeleteElement(_arg: OnElementInModelIdArg): void Protected Static DefinitionModel Called when an Element in an instance of a Model of this class is about to be deleted.
onDeleted(_arg: OnModelIdArg): void Protected Static DefinitionModel Called after a Model was deleted.
onDeletedElement(_arg: OnElementInModelIdArg): void Protected Static DefinitionModel Called after an Element in an instance of a Model of this class has been deleted.
onInsert(arg: OnModelPropsArg): void Protected Static DefinitionModel Called before a new Model is inserted.
onInsertElement(_arg: OnElementInModelPropsArg): void Protected Static DefinitionModel Called before a prospective Element is to be inserted into an instance of a Model of this class.
onInserted(_arg: OnModelIdArg): void Protected Static DefinitionModel Called after a new Model is inserted.
onInsertedElement(_arg: OnElementInModelIdArg): void Protected Static DefinitionModel Called after an Element has been inserted into an instance of a Model of this class.
onUpdate(arg: OnModelPropsArg): void Protected Static DefinitionModel Called before a Model is updated.
onUpdateElement(_arg: OnElementInModelPropsArg): void Protected Static DefinitionModel Called when an Element in an instance of a Model of this class is about to be updated.
onUpdated(_arg: OnModelIdArg): void Protected Static DefinitionModel Called after a Model is updated.
onUpdatedElement(_arg: OnElementInModelIdArg): void Protected Static DefinitionModel Called after an Element in an instance of a Model of this class has been updated.

Inherited properties

Name Type Inherited from Description
classFullName Accessor ReadOnly string DefinitionModel Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor Static ReadOnly string DefinitionModel Get the full BIS class name of this Entity in the form "schema:class"
className Accessor ReadOnly string DefinitionModel The name of the BIS class associated with this class.
id string DefinitionModel The Id of this Entity.
iModel IModelDb DefinitionModel The IModelDb that contains this Entity
isInstanceOfEntity Readonly "true" DefinitionModel An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
isPrivate boolean DefinitionModel  
isTemplate boolean DefinitionModel  
jsonProperties Readonly [key: string]: any DefinitionModel  
modeledElement Readonly RelatedElement DefinitionModel  
name Readonly string DefinitionModel  
parentModel Readonly string DefinitionModel  
schema Static DefinitionModel The Schema that defines this class.
schemaName Accessor ReadOnly string DefinitionModel The name of the BIS Schema that defines this class

Defined in

Last Updated: 13 May, 2024