MobileSync/com.salesforce.androidsdk.mobilesync.target/BriefcaseSyncDownTarget

BriefcaseSyncDownTarget

open class BriefcaseSyncDownTarget : SyncDownTarget

Target for sync that downloads records using the briefcase (priming records) API

Constructors

Link copied to clipboard
constructor(target: JSONObject)

Construct BriefcaseSyncDownTarget from json

constructor(infos: List<BriefcaseObjectInfo>)

Construct BriefcaseSyncDownTarget

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard
open val isSyncDownSortedByLatestModification: Boolean = false

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.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
fun addSyncId(record: JSONObject, syncId: Long)
Link copied to clipboard
open override fun asJSON(): JSONObject
Link copied to clipboard
fun cleanAndSaveInLocalStore(syncManager: SyncManager, soupName: String, record: JSONObject)

Save cleaned record in local store

Link copied to clipboard
fun cleanAndSaveInSmartStore(smartStore: SmartStore, soupName: String, record: JSONObject, idFieldName: String?, handleTx: Boolean)
Link copied to clipboard
open override fun cleanGhosts(syncManager: SyncManager, soupName: String, syncId: Long): Int

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

Link copied to clipboard
fun cleanRecord(record: JSONObject)
Link copied to clipboard
open override fun continueFetch(syncManager: SyncManager): JSONArray?

Continue fetching records conforming to target if any

Link copied to clipboard
fun deleteFromLocalStore(syncManager: SyncManager, soupName: String, record: JSONObject)

Delete record from local store

Link copied to clipboard
fun getDirtyRecordIds(syncManager: SyncManager, soupName: String, idField: String): SortedSet<String>

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

Link copied to clipboard
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

Link copied to clipboard
open override 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

Link copied to clipboard
open fun getLatestModificationTimeStamp(records: JSONArray): Long

Gets the latest modification timestamp from the array of records.

Link copied to clipboard
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)

Link copied to clipboard
fun isDirty(record: JSONObject): Boolean

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

Link copied to clipboard
fun isLocallyCreated(record: JSONObject): Boolean

Given a record, return true if it was locally created

Link copied to clipboard
fun isLocallyDeleted(record: JSONObject): Boolean

Given a record, return true if it was locally deleted

Link copied to clipboard
fun isLocallyUpdated(record: JSONObject): Boolean

Given a record, return true if it was locally updated

Link copied to clipboard
open override fun saveRecordsToLocalStore(syncManager: SyncManager, soupName: String, records: JSONArray, syncId: Long)

Overriding saveRecordsToLocalStore since we might want records in different soups

Link copied to clipboard
open override 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