imodelhub-client

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,
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,
CheckpointCreatedEvent Sent when a new Checkpoint is generated. 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,
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,
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,
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,
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,

Enumerations

Name Description
ChangesType Specifies types of changes in a ChangeSet. Beta,
IModelHubClientLoggerCategory Logger categories used by this package Beta,
IModelHubEventType Type of IModelHubEvent. Beta,
IModelType iModel type Beta,
InitializationState Initialization state of seed file. Beta,

Global Functions

Name Description
addApplicationVersion This function when used on IModelClient adds specified application version header to every request. Beta,
addCsrfHeader This function when used on IModelClient adds CSRF header to every request. Beta,
addHeader This function when used on IModelClient adds specified header to every request. 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 Beta,
HttpRequestOptionsTransformer This type allows modifying HttpRequestOptions that are sent for every request. Beta,
ThumbnailSize Thumbnail size. Beta,

Last Updated: 05 November, 2020