imodelhub-client

Classes

Name Description
AggregateResponseError Class for aggregating errors from multiple requests.
BaseEventSAS Base class for event shared access signatures.
BriefcaseEvent Base type for iModelHub events that have BriefcaseId.
ChangeSet ChangeSet represents a file containing changes to the iModel.
ChangeSetHandler Handler for managing ChangeSets.
ChangeSetPostPushEvent Sent when a ChangeSet is successfully pushed.
ChangeSetPrePushEvent Sent when a ChangeSet push has started.
ChangeSetQuery Query object for getting ChangeSets.
EventHandler Handler for receiving IModelHubEvents.
EventSAS Shared access signature token for getting IModelHubEvents.
EventSubscription Subscription to receive IModelHubEvents.
EventSubscriptionHandler Handler for managing EventSubscriptions.
HubIModel HubIModel represents an iModel on iModelHub.
HubUserInfo Information about the user, allowing to identify them based on their id.
IModelAccessContext
IModelBaseHandler This class acts as the WsgClient for other iModelHub Handlers.
IModelClient Base class that allows access to different iModel related Class handlers.
IModelDeletedEvent Sent when an iModel is deleted.
IModelHandler Handler for managing HubIModel instance. Beta
IModelHubBaseEvent Base type for all iModelHub global events
IModelHubClient Class that allows access to different iModelHub class handlers.
IModelHubClientError Errors for incorrect iModelHub requests.
IModelHubError Error returned from iModelHub service.
IModelHubEvent Base type for all iModelHub events.
IModelQuery Query object for getting HubIModel instances.
IModelsHandler Handler for managing HubIModel instances.
InstanceIdQuery Query for instances with Guid based instance ids.
LargeThumbnail Large Thumbnail class.
SmallThumbnail Small Thumbnail class.
StringIdQuery Query for instances with string based instance ids.
Thumbnail Base class for Thumbnails.
ThumbnailHandler Handler for retrieving Thumbnails.
ThumbnailQuery Query object for getting Thumbnails.
UserInfoHandler Handler for querying HubUserInfo.
UserInfoQuery Query object for getting HubUserInfo.
UserStatistics Statistics of user created and owned instances on the iModel.
UserStatisticsHandler Handler for querying UserStatistics.
UserStatisticsQuery Query object for getting User Statistics.
Version Named Version is a specific ChangeSet given a name to differentiate it from others.
VersionEvent Sent when a new named Version is created.
VersionHandler Handler for managing Versions.
VersionQuery Query object for getting Versions.

Enumerations

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

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
IModelCreateOptions Options used when creating an HubIModel with IModelHandler.create or IModelsHandler.create.
TipThumbnail Tip Thumbnail download parameters.

Type Aliases

Name Description
HttpRequestOptionsTransformer This type allows modifying HttpRequestOptions that are sent for every request. Beta
ThumbnailSize Thumbnail size.

Last Updated: 27 January, 2021