iModels

Classes for working with iModels. See the learning article.

Classes

Name Description
AutoPush Use AutoPush to automatically push local changes to a specified IModel.
BackendActivityMonitor An implementation of AppActivityMonitor that should be suitable for most backends.
BriefcaseEntry Entry in the briefcase cache
BriefcaseId The Id assigned to a briefcase by iModelHub, or one of the special values that identify special kinds of iModels
BriefcaseManager Utility to manage briefcases
ChangeSetToken A token that represents a ChangeSet
ChangeSummaryManager Class to extract Change Summaries for a briefcase.
ConcurrencyControl ConcurrencyControl enables an app to coordinate local changes with changes that are being made by others to an iModel.
ConcurrencyControl.Codes Code manager
ConcurrencyControl.ConflictResolutionPolicy The options for how conflicts are to be handled during change-merging in an OptimisticConcurrencyControlPolicy.
ConcurrencyControl.OptimisticPolicy Specifies an optimistic concurrency policy.
ConcurrencyControl.PessimisticPolicy Specifies a pessimistic concurrency policy.
ConcurrencyControl.Request A request for locks and/or code reservations.
ConcurrencyControl.RequestError Thrown when iModelHub denies or cannot process a request.
IModelDb Represents a physical copy (a briefcase) of an iModel that can be accessed as a file on the local computer.
IModelDb.Elements The collection of elements in an IModelDb.
IModelDb.Models The collection of models in an IModelDb.
IModelDb.Views The collection of views in an IModelDb.
OpenParams Parameters to open an IModelDb
TxnManager Local Txns in an IModelDb.

Enumerations

Name Description
AccessMode Mode to access the IModelDb
AutoPushEventType Identifies an AutoPush event.
AutoPushState Identifies the current state of an AutoPush object.
ConcurrencyControl.OnConflict How to handle a conflict.
ExclusiveAccessOption Additional options for exclusive access to IModelDb
KeepBriefcase Option to keep briefcase when the imodel is closed
SyncMode Operations allowed when synchronizing changes between the IModelDb and the iModel Hub
TxnAction

Interfaces

Name Description
AppActivityMonitor Monitors backend activity.
AutoPushParams Configuration for AutoPush.
ChangeSummary Represents an instance of the ChangeSummary ECClass from the ECDbChange ECSchema
ChangeSummaryExtractOptions Options for ChangeSummaryManager.extractChangeSummaries.
InstanceChange Represents an instance of the InstanceChange ECClass from the ECDbChange ECSchema
ValidationError An error generated during dependency validation.

Type Aliases

Name Description
AutoPushEventHandler The signature of an AutoPush event handler.
ChangeSetDescriber The signature of a function that can supply a description of local Txns in the specified briefcase up to and including the specified endTxnId.

Last Updated: 17 December, 2018