connector-framework

Classes

Name Description
BaseConnector Abstract implementation of the iTwin Connector.
CallbackClient A special implematation of an AuthorizationClient whose constructor takes a single tokenCallback.
CallbackUrlClient A special implementation of a CachedTokenClient whose constructor takes a single callback URL.
ConnectorAuthenticationManager
ConnectorRunner
HubArgs Arguments specific to iModelHub used in a connector job
JobArgs Arguments specific to a connector job
SqliteIssueReporter SQLite issue reporter.
Synchronizer Helper class for interacting with the iModelDb during synchronization.

Enumerations

Name Description
ItemState The state of the given SourceItem against the iModelDb
LoggerCategories Logger categories used by this package

Interfaces

Name Description
AllArgsProps Defines the schema of the .json argument file used to initialize ConnectorRunner
ChangeResults
ConnectorIssueReporter Abstract implementation of the Issue Reporter
DeletionDetectionParams paramaters to control how deletions are detected.
DocumentProperties Properties that may be assigned to a document by its home document control system
HubArgsProps
JobArgsProps
RecordDocumentResults
SourceDocument Identifies an external document and its state.
SourceItem A SourceItem identifies an entity in an external source and the state of the content of the entity.
SynchronizationResults

Type Aliases

Name Description
AccessTokenCallbackUrl
AccessTokenGetter
ConnectRegion
PostPublishingProcessor

Last Updated: 28 May, 2024