SyncStats
public class SyncStats
extends Object implements Parcelable
| java.lang.Object | |
| ↳ | 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 |
|---|
Fields | |
|---|---|
public static final Creator<SyncStats> | CREATOR
|
public long | numAuthExceptions The SyncAdapter was unable to authenticate the |
public long | numConflictDetectedExceptions 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. |
public long | numDeletes Counter for tracking how many deletes were performed by the sync operation, as defined by the SyncAdapter. |
public long | numEntries Counter for tracking how many entries were affected by the sync operation, as defined by the SyncAdapter. |
public long | numInserts Counter for tracking how many inserts were performed by the sync operation, as defined by the SyncAdapter. |
public long | numIoExceptions The SyncAdapter had a problem, most likely with the network connectivity or a timeout while waiting for a network response. |
public long | numParseExceptions The SyncAdapter had a problem with the data it received from the server or the storage later. |
public long | numSkippedEntries Counter for tracking how many entries, either from the server or the local store, were ignored during the sync operation. |
public long | numUpdates Counter for tracking how many updates were performed by the sync operation, as defined by the SyncAdapter. |
Public constructors | |
|---|---|
SyncStats() | |
SyncStats(Parcel in) | |
Public methods | |
|---|---|
void | clear() Reset all the counters to 0. |
int | describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
String | toString() Returns a string representation of the object. |
void | writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
Fields
numAuthExceptions
public long numAuthExceptions
The SyncAdapter was unable to authenticate the 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
public long numConflictDetectedExceptions
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
public long numDeletes
Counter for tracking how many deletes were performed by the sync operation, as defined by the SyncAdapter.
numEntries
public long numEntries
Counter for tracking how many entries were affected by the sync operation, as defined by the SyncAdapter.
numInserts
public long numInserts
Counter for tracking how many inserts were performed by the sync operation, as defined by the SyncAdapter.
numIoExceptions
public long numIoExceptions
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
public long numParseExceptions
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
public long numSkippedEntries
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
public long numUpdates
Counter for tracking how many updates were performed by the sync operation, as defined by the SyncAdapter.
Public constructors
Public methods
describeContents
public int describeContents ()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.
| Returns | |
|---|---|
int | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
toString
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
String | a string representation of the object. |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
| 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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |