@idpass/data-collect-core / AuthenticatedSyncAdapter

Interface: AuthenticatedSyncAdapter

Defined in: interfaces/types.ts:687

Authenticated sync adapter for systems requiring authentication.

Extends

• SyncAdapter

Methods

pushEvents()

pushEvents(events): Promise<void>

Defined in: interfaces/types.ts:669

Push events to external system

Parameters

events

FormSubmission[]

Returns

Promise<void>

Inherited from

SyncAdapter.pushEvents

---

pullEntities()

pullEntities(): Promise<void>

Defined in: interfaces/types.ts:671

Pull entities from external system

Returns

Promise<void>

Inherited from

SyncAdapter.pullEntities

---

pushEntities()

pushEntities(entities): Promise<void>

Defined in: interfaces/types.ts:673

Push entities to external system

Parameters

entities

EntityDoc[]

Returns

Promise<void>

Inherited from

SyncAdapter.pushEntities

---

onSyncComplete()

onSyncComplete(callback): void

Defined in: interfaces/types.ts:675

Register callback for sync completion

Parameters

callback

(status) => void

Returns

void

Inherited from

SyncAdapter.onSyncComplete

---

startAutoSync()

startAutoSync(interval): void

Defined in: interfaces/types.ts:677

Start automatic synchronization at specified interval

Parameters

interval

number

Returns

void

Inherited from

SyncAdapter.startAutoSync

---

stopAutoSync()

stopAutoSync(): void

Defined in: interfaces/types.ts:679

Stop automatic synchronization

Returns

void

Inherited from

SyncAdapter.stopAutoSync

---

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>

Inherited from

SyncAdapter.getServerTimestamp

---

authenticate()

authenticate(): Promise<any>

Defined in: interfaces/types.ts:690

Authenticate with the external system

Returns

Promise<any>