Skip to content

Most visited

Recently visited

navigation

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

From interface android.os.Parcelable

Fields

public static final Creator<SyncStats> CREATOR

public long numAuthExceptions

The SyncAdapter was unable to authenticate the Account that was specified in the request.

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

From class java.lang.Object
From interface android.os.Parcelable

Fields

CREATOR

Added in API level 5
Creator<SyncStats> CREATOR

numAuthExceptions

Added in API level 5
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

Added in API level 5
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 frmo scratch. This is considered a hard error.

numDeletes

Added in API level 5
long numDeletes

Counter for tracking how many deletes were performed by the sync operation, as defined by the SyncAdapter.

numEntries

Added in API level 5
long numEntries

Counter for tracking how many entries were affected by the sync operation, as defined by the SyncAdapter.

numInserts

Added in API level 5
long numInserts

Counter for tracking how many inserts were performed by the sync operation, as defined by the SyncAdapter.

numIoExceptions

Added in API level 5
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

Added in API level 5
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

Added in API level 5
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

Added in API level 5
long numUpdates

Counter for tracking how many updates were performed by the sync operation, as defined by the SyncAdapter.

Public constructors

SyncStats

Added in API level 5
SyncStats ()

SyncStats

Added in API level 5
SyncStats (Parcel in)

Parameters
in Parcel

Public methods

clear

Added in API level 5
void clear ()

Reset all the counters to 0.

describeContents

Added in API level 5
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(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.

toString

Added in API level 5
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

writeToParcel

Added in API level 5
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.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.