IModelToken Class

A token that identifies a specific instance of an iModel to be operated on

Implements

Methods

Name Description
constructor(key?: string, contextId?: string, iModelid?: string, changesetId?: string, openMode?: OpenMode): IModelToken Constructor  
toJSON(): IModelTokenProps Creates a props object for this IModelToken.  
fromJSON(props: IModelTokenProps): IModelToken Static Constructs an IModelToken from a props object.  

Properties

Name Type Description
changeSetId undefined | string Id of the last ChangeSet that was applied to the iModel - must be defined if the iModel exists in the Hub.  
contextId undefined | string Context (Project, Asset, or other infrastructure) in which the iModel exists - must be defined if the iModel exists in the Hub or in a non-Connect infrastructure.  
iModelId undefined | string Guid of the iModel - must be defined if the iModel exists in the Hub  
key undefined | string Key used for identifying the iModel on the backend  
openMode undefined | OpenMode Mode used to open the iModel  

Defined in

Last Updated: 03 June, 2019