When sync down fetches records from older to newer, the maxTimeStamp for the sync can be updated throughout the sync, and as a result running a paused (or killed) sync does not refetch all records.

modificationDateFieldName

val modificationDateFieldName: String

queryType

@JvmField

var queryType: SyncDownTarget.QueryType?

totalSize

@JvmField

var totalSize: Int

Functions

addSyncId

fun addSyncId(record: JSONObject, syncId: Long)

asJSON

open override fun asJSON(): JSONObject

cleanAndSaveInLocalStore

fun cleanAndSaveInLocalStore(syncManager: SyncManager, soupName: String, record: JSONObject)

Save cleaned record in local store

cleanAndSaveInSmartStore

fun cleanAndSaveInSmartStore(smartStore: SmartStore, soupName: String, record: JSONObject, idFieldName: String?, handleTx: Boolean)

cleanGhosts

open fun cleanGhosts(syncManager: SyncManager, soupName: String, syncId: Long): Int

Delete from local store records that a full sync down would no longer download

cleanRecord

fun cleanRecord(record: JSONObject)

continueFetch

abstract fun continueFetch(syncManager: SyncManager): JSONArray?

Continue fetching records conforming to target if any

deleteFromLocalStore

fun deleteFromLocalStore(syncManager: SyncManager, soupName: String, record: JSONObject)

Delete record from local store

getDirtyRecordIds

fun getDirtyRecordIds(syncManager: SyncManager, soupName: String, idField: String): SortedSet<String>

Return ids of "dirty" records (records locally created/upated or deleted)

getFromLocalStore

fun getFromLocalStore(syncManager: SyncManager, soupName: String, storeId: String): JSONObject

Get record from local store by storeId

fun getFromLocalStore(syncManager: SyncManager, soupName: String, storeIds: List<String>): List<JSONObject>

Get records from local store by storeId

getIdsToSkip

open fun getIdsToSkip(syncManager: SyncManager, soupName: String): Set<String>

Return ids of records that should not be written over during a sync down with merge mode leave-if-changed

getLatestModificationTimeStamp

open fun getLatestModificationTimeStamp(records: JSONArray): Long

Gets the latest modification timestamp from the array of records.

getNonDirtyRecordIds

fun getNonDirtyRecordIds(syncManager: SyncManager, soupName: String, idField: String, additionalPredicate: String): SortedSet<String>

Return ids of non-dirty records (records NOT locally created/updated or deleted)

isDirty

fun isDirty(record: JSONObject): Boolean

Given a record, return true if it was locally created/updated or deleted

isLocallyCreated

fun isLocallyCreated(record: JSONObject): Boolean

Given a record, return true if it was locally created

isLocallyDeleted

fun isLocallyDeleted(record: JSONObject): Boolean

Given a record, return true if it was locally deleted

isLocallyUpdated

fun isLocallyUpdated(record: JSONObject): Boolean

Given a record, return true if it was locally updated

saveRecordsToLocalStore

open fun saveRecordsToLocalStore(syncManager: SyncManager, soupName: String, records: JSONArray, syncId: Long)

Save records to local store

startFetch

abstract fun startFetch(syncManager: SyncManager, maxTimeStamp: Long): JSONArray?

Start fetching records conforming to target If a value for maxTimeStamp greater than 0 is passed in, only records created/modified after maxTimeStamp should be returned