connector-framework
Version: 2.4.0
Release Notes | Change Log
The connector-framework package contains classes for authoring iTwin Connectors.
Topics
| Name | Description |
|---|---|
| Args | Classes for storing the command line arguments for an iTwin Connector. |
| BaseConnector | The base class for all iTwin Connectors. |
| ConnectorIssueReporter | Class for reporting an iTwin Connector's status and/or errors back to orchestrators or othe callers/launchers of Connectors. |
| ConnectorRunner | Class responsible for loading the connector from a JavaScript source file and running it. |
| Framework | Class describing the overall package as an aggregation of the various component classes: ConnectorRunner, BaseConnector, Synchronizer, etc. |
| Logging | Module for providing messages to connector developers, testers and users of a range of severity levels from informational to error level. |
| SqliteIssueReporter | A Subclass of a ConnectorIssueReporter for SQLite related issues. |
| ConnectorAuthenticationManager | A class for encapsulating and initializing auth clients and the retrieving and caching of tokens. |
| ChangeSetGroup | A class with methods for creating, getting and closing ChangeSetGroups which is used by the ConnectorRunner. |
| iModelConnectorErrors | An automtically generated file containing enums and keys for looking up structured errors. |
| SyncErrors | A class used to serialize structured errors to a JSON file, syncerrs.json to be used outside of the connector (e.g. |
| All | Displays the contents of all topics in this package. |
Last Updated: 10 June, 2025
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.