iModelHubClient

Classes for communicating directly with iModelHub.

Classes

Name Description  
BaseEventSAS Base class for event shared access signatures.  
BriefcaseEvent Base type for iModelHub events that have BriefcaseId. Beta
ChangeSet ChangeSet represents a file containing changes to the iModel. Beta
ChangeSetCreatedEvent Sent when a ChangeSet is pushed. Beta
ChangeSetHandler Handler for managing ChangeSets. Beta
ChangeSetPostPushEvent Sent when a ChangeSet is successfully pushed. Beta
ChangeSetPrePushEvent Sent when a ChangeSet push has started. Beta
ChangeSetQuery Query object for getting ChangeSets. Beta
EventHandler Handler for receiving IModelHubEvents. Beta
EventSAS Shared access signature token for getting IModelHubEvents. Beta
EventSubscription Subscription to receive IModelHubEvents. Beta
EventSubscriptionHandler Handler for managing EventSubscriptions. Beta
GlobalEventHandler Handler for receiving IModelHubGlobalEvents. Beta
GlobalEventSAS Shared access signature token for getting IModelHubGlobalEvents. Beta
GlobalEventSubscription Subscription to receive IModelHubGlobalEvents. Beta
GlobalEventSubscriptionHandler Handler for managing GlobalEventSubscriptions. Beta
HardiModelDeleteEvent Sent when an archived iModel is completely deleted from the storage. Beta
HubIModel HubIModel represents an iModel on iModelHub. Beta
IModelAccessContext  
IModelBankHandler This class acts as the WsgClient for other iModelBank Handlers. Beta
IModelBaseHandler This class acts as the WsgClient for other iModelHub Handlers. Beta
IModelClient Base class that allows access to different iModel related Class handlers. Beta
IModelCreatedEvent Sent when an iModel is created. Beta
IModelDeletedEvent Sent when an iModel is deleted. Beta
IModelHandler Handler for managing HubIModel instance. Beta
IModelHubBaseEvent Base type for all iModelHub global events Beta
IModelHubClient Class that allows access to different iModelHub class handlers. Beta
IModelHubClientError Errors for incorrect iModelHub requests. Beta
IModelHubError Error returned from iModelHub service. Beta
IModelHubEvent Base type for all iModelHub events. Beta
IModelHubGlobalEvent Base type for all iModelHub global events. Beta
IModelQuery Query object for getting HubIModel instances. Beta
IModelsHandler Handler for managing HubIModel instances. Beta
InstanceIdQuery Query for instances with Guid based instance ids. Beta
NamedVersionCreatedEvent Sent when a named Version is created. Beta
SoftiModelDeleteEvent Sent when an iModel is put into the archive. Beta
StringIdQuery Query for instances with string based instance ids. Beta
Version Named Version is a specific ChangeSet given a name to differentiate it from others. Beta
VersionEvent Sent when a new named Version is created. Beta
VersionHandler Handler for managing Versions. Beta
VersionQuery Query object for getting Versions. Beta
WsgQuery Base class for Query objects. Beta

Enumerations

Name Description  
ChangesType Specifies types of changes in a ChangeSet. Beta
GetEventOperationType Type of GlobalEventHandler.getEvent operations. Beta
InitializationState Initialization state of seed file. Beta

Interfaces

Name Description  
CloneIModelTemplate Create an iModel by cloning another. Beta
IModelCreateOptions Options used when creating an HubIModel with IModelHandler.create or IModelsHandler.create. Beta

Type Aliases

Name Description  
EmptyIModelTemplate Create an iModel from an empty file. Beta
EventType Type of IModelHubEvent. Beta
GlobalEventType Type of IModelHubGlobalEvent. Beta
ThumbnailSize Thumbnail size. Beta

Last Updated: 05 December, 2019