HubIModel Class

HubIModel represents an iModel on iModelHub. Getting a valid HubIModel instance from iModelHub is required for majority of iModelHub method calls, as wsgId of this object needs to be passed as iModelId argument to those methods.

For iModel representation in iModel.js, see IModel. For the file that is used for that iModel, see BriefcaseDb.

Extends

Methods

Name Description
constructor(): HubIModel    

Properties

Name Type Description
createdDate undefined | string Date when iModel was created.  
dataLocationId undefined | string Data center location id where iModel is stored.  
description undefined | string Description of the iModel.  
extent undefined | number[] Extent of iModel.  
id undefined | string Id of the iModel.  
iModelType undefined | IModelType Type of the iModel  
initialized undefined | boolean Set to true, when iModel is ready to be used.  
name undefined | string Name of the iModel.  
secured undefined | boolean Set to true, when iModel has custom access control.  
userCreated undefined | string Id of the user that created the iModel.  

Inherited properties

Name Type Inherited from Description
changeState undefined | ChangeState WsgInstance  
ecId string WsgInstance  
eTag undefined | string WsgInstance  
wsgId string WsgInstance  

Defined in

Last Updated: 12 June, 2024