IModelConnection
Classes for working with a connection to an iModel briefcase
Classes
| Name | Description | |
|---|---|---|
| BlankConnection | A connection that exists without an iModel. | Beta |
| BlankConnection.CodeSpecs | The collection of CodeSpec entities for an IModelConnection. | |
| BlankConnection.Elements | The collection of Elements for an IModelConnection. | |
| BlankConnection.Models | The collection of loaded ModelState objects for an IModelConnection. | |
| BlankConnection.Views | The collection of views for an IModelConnection. | |
| BriefcaseConnection | Base class for connections to a BriefcaseDb hosted on the backend. | |
| BriefcaseConnection.CodeSpecs | The collection of CodeSpec entities for an IModelConnection. | |
| BriefcaseConnection.Elements | The collection of Elements for an IModelConnection. | |
| BriefcaseConnection.Models | The collection of loaded ModelState objects for an IModelConnection. | |
| BriefcaseConnection.Views | The collection of views for an IModelConnection. | |
| EventSource | Provides access to push events emitted by the backend. | Beta |
| IModelConnection | A connection to a IModelDb hosted on the backend. | |
| IModelConnection.CodeSpecs | The collection of CodeSpec entities for an IModelConnection. | |
| IModelConnection.Elements | The collection of Elements for an IModelConnection. | |
| IModelConnection.Models | The collection of loaded ModelState objects for an IModelConnection. | |
| IModelConnection.Views | The collection of views for an IModelConnection. | |
| IModelRoutingContext | Controls the RPC routing for an iModel connection. | |
| RemoteBriefcaseConnection | A connection to a BriefcaseDb hosted on a remote backend, and is typically used in web applications. | |
| SnapshotConnection | A connection to a SnapshotDb hosted on the backend. | |
| SnapshotConnection.CodeSpecs | The collection of CodeSpec entities for an IModelConnection. | |
| SnapshotConnection.Elements | The collection of Elements for an IModelConnection. | |
| SnapshotConnection.Models | The collection of loaded ModelState objects for an IModelConnection. | |
| SnapshotConnection.Views | The collection of views for an IModelConnection. | |
| Tiles | Provides access to TileTrees associated with an IModelConnection. | Beta |
Interfaces
| Name | Description | |
|---|---|---|
| BlankConnection.ViewSpec | The id/name/class of a ViewDefinition. | |
| BlankConnectionProps | The properties for creating a Blank IModelConnection | Beta |
| BriefcaseConnection.ViewSpec | The id/name/class of a ViewDefinition. | |
| IModelConnection.ViewSpec | The id/name/class of a ViewDefinition. | |
| SnapshotConnection.ViewSpec | The id/name/class of a ViewDefinition. |
Type Aliases
| Name | Description | |
|---|---|---|
| EventListener | A function that can respond to events originating from an EventSource. | Beta |
| RemoveEventListener | A function returned from EventSource.on that can be invoked to remove the EventListener. | Beta |
Last Updated: 26 October, 2020