@idpass/data-collect-core / ExternalSyncAdapter

Interface: ExternalSyncAdapter

Defined in: interfaces/types.ts:673

External sync adapter interface for third-party system integration.

Implementations handle the specifics of syncing with different external systems.

Methods

authenticate()?

optional authenticate(credentials?): Promise<boolean>

Defined in: interfaces/types.ts:675

Optional hook to authenticate with the external system before data transfer

Parameters

credentials?

ExternalSyncCredentials

Returns

Promise<boolean>

---

pushData()

pushData(credentials?): Promise<void>

Defined in: interfaces/types.ts:677

Push local changes to the external system

Parameters

credentials?

ExternalSyncCredentials

Returns

Promise<void>

---

pullData()

pullData(credentials?): Promise<void>

Defined in: interfaces/types.ts:679

Pull remote changes from the external system

Parameters

credentials?

ExternalSyncCredentials

Returns

Promise<void>

---

sync()?

optional sync(credentials?): Promise<void>

Defined in: interfaces/types.ts:684

Backwards compatibility helper for adapters that implement a combined sync routine. ExternalSyncManager will fall back to this when push/pull are not available.

Parameters

credentials?

ExternalSyncCredentials

Returns

Promise<void>