SyncStats
open class SyncStats : Parcelable
| kotlin.Any | |
| ↳ | android.content.SyncStats |
Used to record various statistics about the result of a sync operation. The SyncManager gets access to these via a SyncResult and uses some of them to determine the disposition of the sync. See SyncResult for further dicussion on how the SyncManager uses these values.
Summary
| Inherited constants | |
|---|---|
| Public constructors | |
|---|---|
| Public methods | |
|---|---|
| open Unit |
clear()Reset all the counters to 0. |
| open Int | |
| open String |
toString() |
| open Unit |
writeToParcel(dest: Parcel, flags: Int) |
| Properties | |
|---|---|
| static Parcelable.Creator<SyncStats!> | |
| Long |
The SyncAdapter was unable to authenticate the |
| Long |
The SyncAdapter detected that there was an unrecoverable version conflict when it attempted to update or delete a version of a resource on the server. |
| Long |
Counter for tracking how many deletes were performed by the sync operation, as defined by the SyncAdapter. |
| Long |
Counter for tracking how many entries were affected by the sync operation, as defined by the SyncAdapter. |
| Long |
Counter for tracking how many inserts were performed by the sync operation, as defined by the SyncAdapter. |
| Long |
The SyncAdapter had a problem, most likely with the network connectivity or a timeout while waiting for a network response. |
| Long |
The SyncAdapter had a problem with the data it received from the server or the storage later. |
| Long |
Counter for tracking how many entries, either from the server or the local store, were ignored during the sync operation. |
| Long |
Counter for tracking how many updates were performed by the sync operation, as defined by the SyncAdapter. |
Public constructors
Public methods
describeContents
open fun describeContents(): Int
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR |
toString
open fun toString(): String
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
open fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
| Parameters | |
|---|---|
dest |
Parcel: The Parcel in which the object should be written. This value cannot be null. |
flags |
Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |
Properties
numAuthExceptions
var numAuthExceptions: Long
The SyncAdapter was unable to authenticate the android.accounts.Account that was specified in the request. The user needs to take some action to resolve before a future request can expect to succeed. This is considered a hard error.
numConflictDetectedExceptions
var numConflictDetectedExceptions: Long
The SyncAdapter detected that there was an unrecoverable version conflict when it attempted to update or delete a version of a resource on the server. This is expected to clear itself automatically once the new state is retrieved from the server, though it may remain until the user intervenes manually, perhaps by clearing the local storage and starting over from scratch. This is considered a hard error.
numDeletes
var numDeletes: Long
Counter for tracking how many deletes were performed by the sync operation, as defined by the SyncAdapter.
numEntries
var numEntries: Long
Counter for tracking how many entries were affected by the sync operation, as defined by the SyncAdapter.
numInserts
var numInserts: Long
Counter for tracking how many inserts were performed by the sync operation, as defined by the SyncAdapter.
numIoExceptions
var numIoExceptions: Long
The SyncAdapter had a problem, most likely with the network connectivity or a timeout while waiting for a network response. The request may succeed if it is tried again later. This is considered a soft error.
numParseExceptions
var numParseExceptions: Long
The SyncAdapter had a problem with the data it received from the server or the storage later. This problem will likely repeat if the request is tried again. The problem will need to be cleared up by either the server or the storage layer (likely with help from the user). If the SyncAdapter cleans up the data itself then it typically won't increment this value although it may still do so in order to record that it had to perform some cleanup. E.g., if the SyncAdapter received a bad entry from the server when processing a feed of entries, it may choose to drop the entry and thus make progress and still increment this value just so the SyncAdapter can record that an error occurred. This is considered a hard error.
numSkippedEntries
var numSkippedEntries: Long
Counter for tracking how many entries, either from the server or the local store, were ignored during the sync operation. This could happen if the SyncAdapter detected some unparsable data but decided to skip it and move on rather than failing immediately.
numUpdates
var numUpdates: Long
Counter for tracking how many updates were performed by the sync operation, as defined by the SyncAdapter.