SyncResult

SyncResult

SyncResult()

Create a "clean" SyncResult. If this is returned without any changes then the SyncManager will consider the sync to have completed successfully. The various fields can be set by the SyncAdapter in order to give the SyncManager more information as to the disposition of the sync.

The errors are classified into two broad categories: hard errors and soft errors. Soft errors are retried with exponential backoff. Hard errors are not retried (except when the hard error is for a ContentResolver#SYNC_EXTRAS_UPLOAD request, in which the request is retryed without the ContentResolver#SYNC_EXTRAS_UPLOAD extra set). The SyncManager checks the type of error by calling SyncResult#hasHardError() and SyncResult#hasSoftError(). If both are true then the SyncManager treats it as a hard error, not a soft error.

clear

fun clear(): Unit

Clears the SyncResult to a clean state. Throws an UnsupportedOperationException if this is called when syncAlreadyInProgress is set.

describeContents

fun describeContents(): Int

hasError

fun hasError(): Boolean

A convenience method for determining of the SyncResult indicates that an error occurred.

hasHardError

fun hasHardError(): Boolean

Convenience method for determining if the SyncResult indicates that a hard error occurred. See SyncResult() for an explanation of what the SyncManager does when it sees a hard error.

A hard error is indicated when any of the following is true:

• SyncStats#numParseExceptions > 0
• SyncStats#numConflictDetectedExceptions > 0
• SyncStats#numAuthExceptions > 0
• tooManyDeletions
• tooManyRetries
• databaseError

hasSoftError

fun hasSoftError(): Boolean

Convenience method for determining if the SyncResult indicates that a soft error occurred. See SyncResult() for an explanation of what the SyncManager does when it sees a soft error.

A soft error is indicated when any of the following is true:

• SyncStats#numIoExceptions > 0
• syncAlreadyInProgress

madeSomeProgress

fun madeSomeProgress(): Boolean

Convenience method for determining if the Sync should be rescheduled after failing for some reason.

toDebugString

fun toDebugString(): String!

Generates a debugging string indicating the status. The string consist of a sequence of code letter followed by the count. Code letters are f - fullSyncRequested, r - partialSyncUnavailable, X - hardError, e - numParseExceptions, c - numConflictDetectedExceptions, a - numAuthExceptions, D - tooManyDeletions, R - tooManyRetries, b - databaseError, x - softError, l - syncAlreadyInProgress, I - numIoExceptions

toString

fun toString(): String

writeToParcel

fun writeToParcel(
    parcel: Parcel, 
    flags: Int
): Unit

ALREADY_IN_PROGRESS

static val ALREADY_IN_PROGRESS: SyncResult!

This instance of a SyncResult is returned by the SyncAdapter in response to a sync request when a sync is already underway. The SyncManager will reschedule the sync request to try again later.

CREATOR

static val CREATOR: Parcelable.Creator<SyncResult!>

databaseError

var databaseError: Boolean

Used to indicate that the SyncAdapter experienced a hard error due to an error it received from interacting with the storage layer. The SyncManager will record that the sync request failed and it will not reschedule the request.

delayUntil

var delayUntil: Long

Used to indicate to the SyncManager that future sync requests that match the request's Account and authority should be delayed until a time in seconds since Java epoch.

For example, if you want to delay the next sync for at least 5 minutes, then:

result.delayUntil = (System.currentTimeMillis() / 1000) + 5 * 60;
  

By default, when a sync fails, the system retries later with an exponential back-off with the system default initial delay time, which always wins over delayUntil -- i.e. if the system back-off time is larger than delayUntil, delayUntil will essentially be ignored.

fullSyncRequested

var fullSyncRequested: Boolean

If set the SyncManager will request an immediate sync with the same Account and authority (but empty extras Bundle) as was used in the sync request.

moreRecordsToGet

var moreRecordsToGet: Boolean

This field is ignored by the SyncManager.

partialSyncUnavailable

var partialSyncUnavailable: Boolean

This field is ignored by the SyncManager.

stats

val stats: SyncStats!

Used to hold extras statistics about the sync operation. Some of these indicate that the sync request resulted in a hard or soft error, others are for purely informational purposes.

syncAlreadyInProgress

val syncAlreadyInProgress: Boolean

Used to indicate that the SyncAdapter is already performing a sync operation, though not necessarily for the requested account and authority and that it wasn't able to process this request. The SyncManager will reschedule the request to run later.

tooManyDeletions

var tooManyDeletions: Boolean

Used to indicate that the SyncAdapter determined that it would need to issue too many delete operations to the server in order to satisfy the request (as defined by the SyncAdapter). The SyncManager will record that the sync request failed and will cause a System Notification to be created asking the user what they want to do about this. It will give the user a chance to choose between (1) go ahead even with those deletes, (2) revert the deletes, or (3) take no action. If the user decides (1) or (2) the SyncManager will issue another sync request with either ContentResolver#SYNC_EXTRAS_OVERRIDE_TOO_MANY_DELETIONS or ContentResolver#SYNC_EXTRAS_DISCARD_LOCAL_DELETIONS set in the extras. It is then up to the SyncAdapter to decide how to honor that request.

tooManyRetries

var tooManyRetries: Boolean

Used to indicate that the SyncAdapter experienced a hard error due to trying the same operation too many times (as defined by the SyncAdapter). The SyncManager will record that the sync request failed and it will not reschedule the request.