PowerSync Core/com.powersync.connectors/PowerSyncBackendConnector

PowerSyncBackendConnector

abstract class PowerSyncBackendConnector(source)

Implement this to connect an app backend.

The connector is responsible for:

  1. Creating credentials for connecting to the PowerSync service.

  2. Applying local changes against the backend application server.

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
abstract suspend fun fetchCredentials(): PowerSyncCredentials?

Get credentials for PowerSync.

Link copied to clipboard
open suspend fun getCredentialsCached(): PowerSyncCredentials?

Get credentials current cached, or fetch new credentials if none are available.

Link copied to clipboard
open fun invalidateCredentials()

Immediately invalidate credentials.

Link copied to clipboard
open fun prefetchCredentials(): Job

Fetch a new set of credentials and cache it.

Link copied to clipboard
suspend fun updateCredentials()

If no other task is currently fetching credentials, calls fetchCredentials again and caches the result internally.

Link copied to clipboard
abstract suspend fun uploadData(database: PowerSyncDatabase)

Upload local changes to the app backend.