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

BatchSyncUpTarget

open class BatchSyncUpTarget : SyncUpTarget, AdvancedSyncUpTarget

Subclass of SyncUpTarget that batches create/update/delete operations by using composite api

Inheritors

CollectionSyncUpTarget

Constructors

BatchSyncUpTarget

constructor(createFieldlist: List<String>?, updateFieldlist: List<String>?, maxBatchSize: Int)

Construct SyncUpTarget with a different maxBatchSize (NB: cannot exceed MAX_SUB_REQUESTS_COMPOSITE_API)

@JvmOverloads

constructor(createFieldlist: List<String>? = null, updateFieldlist: List<String>? = null, idFieldName: String? = null, modificationDateFieldName: String? = null, externalIdFieldName: String? = null, maxBatchSize: Int = MAX_SUB_REQUESTS_COMPOSITE_API)

Construct BatchSyncUpTarget

constructor(target: JSONObject)

Construct SyncUpTarget from json

Types

Companion

object Companion

Properties

createFieldlist

@JvmField

var createFieldlist: List<String>?

externalIdFieldName

var externalIdFieldName: String?

idFieldName

val idFieldName: String

maxBatchSize

override var maxBatchSize: Int

modificationDateFieldName

val modificationDateFieldName: String

updateFieldlist

@JvmField

var updateFieldlist: List<String>?

Functions

addSyncId

fun addSyncId(record: JSONObject, syncId: Long)

areNewerThanServer

open fun areNewerThanServer(syncManager: SyncManager, records: List<JSONObject>): MutableMap<String, Boolean>

Same as isNewerThanServer but operating over a list of records (expected to be of the same sobject type) Return map from record store id to boolean

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)

cleanRecord

fun cleanRecord(record: JSONObject)

createOnServer

open fun createOnServer(syncManager: SyncManager, record: JSONObject, fieldlist: List<String>?): String?

Save locally created record back to server

deleteFromLocalStore

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

Delete record from local store

deleteOnServer

open fun deleteOnServer(syncManager: SyncManager, record: JSONObject): Int

Delete locally deleted record from server

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

getIdsOfRecordsToSyncUp

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

Return ids of records to sync up

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

isNewerThanServer

open fun isNewerThanServer(syncManager: SyncManager, record: JSONObject): Boolean

Return true if record is more recent than corresponding record on server NB: also return true if both were deleted or if local mod date is missing

saveRecordsToLocalStore

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

Save records to local store

saveRecordToLocalStoreWithLastError

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

Save record with last error if any

syncUpRecords

open override fun syncUpRecords(syncManager: SyncManager, records: List<JSONObject>, fieldlist: List<String>?, mergeMode: SyncState.MergeMode, syncSoupName: String)

Sync up a batch of records

updateOnServer

open fun updateOnServer(syncManager: SyncManager, record: JSONObject, fieldlist: List<String>?): Int

Save locally updated record back to server