Skip to main content

@idpass/data-collect-core / SyncAdapter

Interface: SyncAdapter

Defined in: interfaces/types.ts:667

Sync adapter interface for external system synchronization.

Provides integration with external systems for bi-directional data sync. Implementations include OpenSppSyncAdapter and MockRegistrySyncAdapter.

Extended by​

Methods​

pushEvents()​

pushEvents(events): Promise<void>

Defined in: interfaces/types.ts:669

Push events to external system

Parameters​

events​

FormSubmission[]

Returns​

Promise<void>


pullEntities()​

pullEntities(): Promise<void>

Defined in: interfaces/types.ts:671

Pull entities from external system

Returns​

Promise<void>


pushEntities()​

pushEntities(entities): Promise<void>

Defined in: interfaces/types.ts:673

Push entities to external system

Parameters​

entities​

EntityDoc[]

Returns​

Promise<void>


onSyncComplete()​

onSyncComplete(callback): void

Defined in: interfaces/types.ts:675

Register callback for sync completion

Parameters​

callback​

(status) => void

Returns​

void


startAutoSync()​

startAutoSync(interval): void

Defined in: interfaces/types.ts:677

Start automatic synchronization at specified interval

Parameters​

interval​

number

Returns​

void


stopAutoSync()​

stopAutoSync(): void

Defined in: interfaces/types.ts:679

Stop automatic synchronization

Returns​

void


getServerTimestamp()​

getServerTimestamp(): Promise<string>

Defined in: interfaces/types.ts:681

Get the server timestamp to prevent clock differences between clients and server

Returns​

Promise<string>