API Reference › core-backend › ElementAspects › ChannelRootAspect

ChannelRootAspect Class

Extends

Methods

Name Description
constructor(props: ElementAspectProps, iModel: IModelDb): ChannelRootAspect Construct an aspect from its JSON representation and its containing iModel.  
insert(iModel: IModelDb, ownerId: string, channelName: string): void Static Insert a ChannelRootAspect on the specified element. Deprecated  

Inherited methods

Name Inherited from Description
collectReferenceIds(_referenceIds: EntityReferenceSet): void Protected ElementUniqueAspect Collect the Ids of this entity's references at this level of the class hierarchy.
forEachProperty(func: PropertyCallback, includeCustom: boolean = true): void ElementUniqueAspect Call a function for each property of this Entity.
getReferenceIds(): EntityReferenceSet ElementUniqueAspect Get the set of this entity's entity references, EntityReferenceSet.
toJSON(): ElementAspectProps ElementUniqueAspect Obtain the JSON representation of this Entity.
is(otherClass: undefined): boolean Static ElementUniqueAspect return whether this Entity class is a subclass of another Entity class
onDelete(arg: OnAspectIdArg): void ProtectedStatic ElementUniqueAspect Called before an ElementAspect is deleted.
onDeleted(_arg: OnAspectIdArg): void ProtectedStatic ElementUniqueAspect Called after an ElementAspect was deleted.
onInsert(arg: OnAspectPropsArg): void ProtectedStatic ElementUniqueAspect Called before a new ElementAspect is inserted.
onInserted(_arg: OnAspectPropsArg): void ProtectedStatic ElementUniqueAspect Called after a new ElementAspect was inserted.
onUpdate(arg: OnAspectPropsArg): void ProtectedStatic ElementUniqueAspect Called before an ElementAspect is updated.
onUpdated(_arg: OnAspectPropsArg): void ProtectedStatic ElementUniqueAspect Called after an ElementAspect was updated.

Inherited properties

Name Type Inherited from Description
classFullName Accessor ReadOnly string ElementUniqueAspect Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor StaticReadOnly string ElementUniqueAspect Get the full BIS class name of this Entity in the form "schema:class"
className Accessor ReadOnly string ElementUniqueAspect The name of the BIS class associated with this class.
element RelatedElement ElementUniqueAspect  
id string ElementUniqueAspect The Id of this Entity.
iModel IModelDb ElementUniqueAspect The IModelDb that contains this Entity
isInstanceOfEntity Readonly "true" ElementUniqueAspect An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
schema Static undefined ElementUniqueAspect The Schema that defines this class.
schemaName Accessor ReadOnly string ElementUniqueAspect The name of the BIS Schema that defines this class

Defined in

Last Updated: 19 April, 2024