iModels

Classes for working with iModels. See the learning article.

Classes

Name Description  
ChangedInstanceIds Class for discovering modified elements between 2 versions of an iModel.  
ChangedInstanceOps Class for holding change information.  
DynamicSchemaUnionStrategy Processes ordinary schemas with newer-version selection and unions compatible  
IModelExporter Base class for exporting data from an iModel.  
IModelExportHandler Handles the events generated by IModelExporter.  
IModelImporter Base class for importing data into an iModel.  
IModelTransformer Base class used to transform a source iModel into a different target iModel.  
NewerVersionSchemaImportStrategy Selects source schemas that are absent from the target or have a newer version.  
TemplateModelCloner IModelTransformer that clones the contents of a template model.  

Interfaces

Name Description  
ElementBulkDeleteError Error thrown when native bulk deletion fails to delete one or more requested element trees.  
ExportSchemaResult The (optional) result of onExportSchema  
IModelImportOptions Options provided to the IModelImporter constructor.  
IModelTransformArgs Required arguments for the IModelTransformer constructor.  
IModelTransformContext The supported transformation context exposed by an IModelTransformer.  
IModelTransformOptions Options provided to the IModelTransformer constructor.  
InitOptions Arguments you can pass to initialize  
OptimizeGeometryOptions Options provided to optimizeGeometry specifying post-processing optimizations to be applied to the iModel's geometry.  
ProcessSchemasOptions Options for processSchemas.  
ReadonlySchemaAccessor Read-only access to schemas already present in the target iModel.  
RelationshipPropsForDelete  
SchemaProcessingContext Context supplied to a SchemaProcessingStrategy.  
SchemaProcessingStrategy Selects source schemas and produces definitions for import into a target iModel.  
TargetScopeProvenanceJsonProps Data type for persisting change version information within provenance Scope ExternalSourceAspect.  

Type Aliases

Name Description  
ChangedInstanceIdsInitOptions Arguments for initialize  
ExportChangesOptions Arguments for exportChanges  
ExporterInitOptions Arguments for initialize, usually in case you want to query changedata early  
ProcessChangesOptions Arguments used during process if provided in argsForProcessChanges.  
SchemaProcessingResult The result of processing one schema.  

Last Updated: 25 August, 2026