OpenParams Class

Parameters to open an IModelDb

Methods

Name Description
constructor(openMode: OpenMode, accessMode?: AccessMode, syncMode?: SyncMode, exclusiveAccessOption?: ExclusiveAccessOption): OpenParams    
equals(other: OpenParams): boolean Returns true if equal and false otherwise  
fixedVersion(accessMode: AccessMode = AccessMode.Shared, exclusiveAccessOption: ExclusiveAccessOption = ExclusiveAccessOption.TryReuseOpenBriefcase): OpenParams Static Create parameters to open the Db as of a fixed version in a readonly mode  
pullAndPush(exclusiveAccessOption: ExclusiveAccessOption = ExclusiveAccessOption.TryReuseOpenBriefcase): OpenParams Static Create parameters to open the Db to make edits and push changes to the Hub  
pullOnly(accessMode: AccessMode = AccessMode.Exclusive, exclusiveAccessOption: ExclusiveAccessOption = ExclusiveAccessOption.TryReuseOpenBriefcase): OpenParams Static Create parameters to open the Db to allow only pulls from the Hub  
standalone(openMode: OpenMode): OpenParams Static Create parameters to open a standalone Db Deprecated

Properties

Name Type Description
accessMode ConstructorProperty undefined | AccessMode Mode to access the IModelDb  
exclusiveAccessOption ConstructorProperty undefined | ExclusiveAccessOption Additional hint for exclusive access to either create a new briefcase or try and reuse a previously opened briefcase  
isStandalone Accessor ReadOnly boolean Returns true if the open params open a standalone Db  
openMode ConstructorProperty OpenMode Mode to Open the IModelDb  
syncMode ConstructorProperty undefined | SyncMode Operations allowed when synchronizing changes between the IModelDb and IModelHub  

Defined in

Last Updated: 13 May, 2019