BaseConnector Class
Abstract implementation of the iTwin Connector.
Methods
| Name | Description | |
|---|---|---|
| constructor(): BaseConnector | ||
| getApplicationVersion(): string Abstract | ||
| getChannelKey(): string | ||
| getConnectorName(): string Abstract | ||
| getDataChangesDescription(): string Optional | Returns the description for data changeset. | |
| getDeletionDetectionParams(): DeletionDetectionParams | A connector can operate in one of two ways with regards to source files and channels: | |
| getJobSubjectName(sourcePath: string): string | Returns the name to be used for the job subject. | |
| importDefinitions(): Promise<any> Abstract | Import any elements that belong in a DefinitionModel (Categories, LineStyles, Materials, etc). | |
| importDomainSchema(requestContext?: string): Promise<any> Abstract | Import schema(s) that are specific to this particular source, in addition to the previously imported domain schema(s). | |
| importDynamicSchema(requestContext?: string): Promise<any> Abstract | Import schema(s) that every iModel synchronized by this connector will use. | |
| initializeJob(): Promise<void> Abstract | This is only called the first time this source data is synchronized. | |
| onOpenIModel(): Promise<BentleyStatus> | If the connector needs to perform any steps once the iModel has been opened | |
| openSourceData(source: string): Promise<void> Abstract | The source data can be an actual source file on disk (json, csv, xml, etc), a data dump of a native source (IFC), a URL for a rest API, etc. | |
| reportError(dir: string, description: string, systemName?: string, systemPhase?: string, category?: string, canUserFix?: boolean, descriptionKey?: string, kbArticleLink?: string): void | Create error file with the supplied information for debugging reasons. | |
| shouldDeleteElements(): boolean | Returns boolean flag to toggle deletion. | |
| unmapSource(source: string): Promise<void> | Overridable function that must me implemented when the flag shouldUnmapSource is set to true. | |
| updateExistingData(): Promise<any> Abstract | Convert the source data to BIS and insert into the iModel. | |
| create(): Promise<BaseConnector> Static |
Properties
| Name | Type | Description | |
|---|---|---|---|
| connectorArgs Accessor | undefined | [otherArg: string]: any | ||
| issueReporter Accessor | ConnectorIssueReporter | ||
| jobSubject Accessor | Subject | ||
| onClosingIModel | () => void | undefined | ||
| synchronizer Accessor | Synchronizer |
Defined in
- BaseConnector.ts Line 17
Last Updated: 03 May, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.