IT. Expert System.

Android Reference

SyncResult


android.content

Class SyncResult

  • All Implemented Interfaces:
    Parcelable


    public final class SyncResult
    extends Object
    implements Parcelable
    This class is used to communicate the results of a sync operation to the SyncManager. Based on the values here the SyncManager will determine the disposition of the sync and whether or not a new sync operation needs to be scheduled in the future.
    • Field Summary

      Fields
      Modifier and Type Field and Description
      static SyncResult ALREADY_IN_PROGRESS
      This instance of a SyncResult is returned by the SyncAdapter in response to a sync request when a sync is already underway.
      static Parcelable.Creator<SyncResult> CREATOR
      boolean databaseError
      Used to indicate that the SyncAdapter experienced a hard error due to an error it received from interacting with the storage later.
      long delayUntil
      Used to indicate to the SyncManager that future sync requests that match the request's Account and authority should be delayed at least this many seconds.
      boolean fullSyncRequested
      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.
      boolean moreRecordsToGet
      This field is ignored by the SyncManager.
      boolean partialSyncUnavailable
      This field is ignored by the SyncManager.
      SyncStats stats
      Used to hold extras statistics about the sync operation.
      boolean syncAlreadyInProgress
      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.
      boolean tooManyDeletions
      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).
      boolean tooManyRetries
      Used to indicate that the SyncAdapter experienced a hard error due to trying the same operation too many times (as defined by the SyncAdapter).
    • Constructor Summary

      Constructors
      Constructor and Description
      SyncResult()
      Create a "clean" SyncResult.
    • Method Summary

      Methods
      Modifier and Type Method and Description
      void clear()
      Clears the SyncResult to a clean state.
      int describeContents()
      Describe the kinds of special objects contained in this Parcelable's marshalled representation.
      boolean hasError()
      A convenience method for determining of the SyncResult indicates that an error occurred.
      boolean hasHardError()
      Convenience method for determining if the SyncResult indicates that a hard error occurred.
      boolean hasSoftError()
      Convenience method for determining if the SyncResult indicates that a soft error occurred.
      boolean madeSomeProgress()
      String toDebugString()
      Generates a debugging string indicating the status.
      String toString()
      Returns a string containing a concise, human-readable description of this object.
      void writeToParcel(Parcel parcel, int flags)
      Flatten this object in to a Parcel.
    • Field Detail

      • syncAlreadyInProgress

        public final boolean syncAlreadyInProgress
        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

        public boolean tooManyDeletions
        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

        public boolean tooManyRetries
        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.
      • databaseError

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

        public boolean fullSyncRequested
        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.
      • partialSyncUnavailable

        public boolean partialSyncUnavailable
        This field is ignored by the SyncManager.
      • moreRecordsToGet

        public boolean moreRecordsToGet
        This field is ignored by the SyncManager.
      • delayUntil

        public long delayUntil
        Used to indicate to the SyncManager that future sync requests that match the request's Account and authority should be delayed at least this many seconds.
      • stats

        public final SyncStats stats
        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.
      • ALREADY_IN_PROGRESS

        public static final SyncResult ALREADY_IN_PROGRESS
        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.
    • Constructor Detail

      • SyncResult

        public 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 hasHardError() and hasSoftError(). If both are true then the SyncManager treats it as a hard error, not a soft error.

    • Method Detail

      • hasSoftError

        public boolean hasSoftError()
        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:

        Returns:
        true if a hard error is indicated
      • hasError

        public boolean hasError()
        A convenience method for determining of the SyncResult indicates that an error occurred.
        Returns:
        true if either a soft or hard error occurred
      • madeSomeProgress

        public boolean madeSomeProgress()
      • describeContents

        public int describeContents()
        Description copied from interface: Parcelable
        Describe the kinds of special objects contained in this Parcelable's marshalled representation.
        Specified by:
        describeContents in interface Parcelable
        Returns:
        a bitmask indicating the set of special object types marshalled by the Parcelable.
      • toString

        public String toString()
        Description copied from class: Object
        Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:
           getClass().getName() + '@' + Integer.toHexString(hashCode())

        See Writing a useful toString method if you intend implementing your own toString method.

        Overrides:
        toString in class Object
        Returns:
        a printable representation of this object.
      • toDebugString

        public String toDebugString()
        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
        Returns:
        debugging string.


Content

Android Reference

Java basics

Java Enterprise Edition (EE)

Java Standard Edition (SE)

SQL

HTML

PHP

CSS

Java Script

MYSQL

JQUERY

VBS

REGEX

C

C++

C#

Design patterns

RFC (standard status)

RFC (proposed standard status)

RFC (draft standard status)

RFC (informational status)

RFC (experimental status)

RFC (best current practice status)

RFC (historic status)

RFC (unknown status)

IT dictionary

License.
All information of this service is derived from the free sources and is provided solely in the form of quotations. This service provides information and interfaces solely for the familiarization (not ownership) and under the "as is" condition.
Copyright 2016 © ELTASK.COM. All rights reserved.
Site is optimized for mobile devices.
Downloads: 3063 / . Delta: 0.02531 с