HubAccess

APIs for working with IModelHub

Classes

Name Description  
LockConflict Exception thrown if lock cannot be acquired.  

Enumerations

Name Description  
LockState The state of a lock. Deprecated

Interfaces

Name Description  
AcquireNewBriefcaseIdArg Argument for acquiring a new BriefcaseId  
BackendHubAccess Methods for accessing services of IModelHub from an iTwin.js backend.  
BriefcaseDbArg Argument for methods that must supply a briefcaseId and a changeset  
BriefcaseIdArg Argument for methods that must supply an IModelId and a BriefcaseId  
ChangesetArg Argument for methods that must supply an IModelId and a changeset  
ChangesetRangeArg Argument for methods that must supply an IModelId and a range of Changesets.  
CreateNewIModelProps Arguments to create a new iModel in iModelHub  
DownloadChangesetArg Argument for downloading a changeset.  
DownloadChangesetRangeArg Argument for downloading a changeset range.  
DownloadProgressArg Argument for cancelling and tracking download progress.  
IModelIdArg Argument for methods that must supply an IModelId  
IModelNameArg Argument for methods that must supply an IModel name and iTwinId  
ITwinIdArg Argument for methods that must supply an iTwinId  
LockProps The properties of a lock that may be obtained from a lock server.  
V2CheckpointAccessProps The properties to access a V2 checkpoint through a daemon.  

Type Aliases

Name Description  
LockMap Maps element Ids to their corresponding LockStates.  

Last Updated: 19 February, 2025