OpenParams Class
Parameters to open an IModelDb
Methods
Name | Description | |
---|---|---|
constructor(openMode: OpenMode, syncMode?: SyncMode, timeout?: number): OpenParams | ||
equals(other: OpenParams): boolean | Returns true if equal and false otherwise | |
fixedVersion(): OpenParams Static | Create parameters to open the Db as of a fixed version in a readonly mode | |
pullAndPush(): OpenParams Static | Create parameters to open the Db to make edits and push changes to the Hub | |
standalone(openMode: OpenMode): OpenParams Static | Create parameters to open a standalone Db | Deprecated |
Properties
Name | Type | Description | |
---|---|---|---|
isBriefcase Accessor ReadOnly | boolean | Returns true if the OpenParams open a briefcase iModel | |
isSnapshot Accessor ReadOnly | boolean | Returns true if the OpenParams open a snapshot iModel | |
isStandalone Accessor ReadOnly | boolean | Returns true if the OpenParams open a standalone iModel | Deprecated |
openMode ConstructorProperty | OpenMode | Mode to Open the IModelDb | |
syncMode ConstructorProperty | undefined | SyncMode | Operations allowed when synchronizing changes between the IModelDb and IModelHub | |
timeout ConstructorProperty | undefined | number | Timeout (in milliseconds) before the open operations throws a RpcPendingResponse exception after queuing up the open. |
Defined in
Last Updated: 08 January, 2020