Android Guides | Samples

Android.Content.SyncResult Class

This class is used to communicate the results of a sync operation to the SyncManager.

See Also: SyncResult

Syntax

[Android.Runtime.Register("android/content/SyncResult", DoNotGenerateAcw=true)]
public sealed class SyncResult : Object, IParcelable, IDisposable

Remarks

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.

[Android Documentation]

Requirements

Namespace: Android.Content
Assembly: Mono.Android (in Mono.Android.dll)
Assembly Versions: 0.0.0.0
Since: Added in API level 5

The members of Android.Content.SyncResult are listed below.

See Also: Object

Public Constructors

Create a "clean" SyncResult.

Public Properties

[read-only]
static
AlreadyInProgressSyncResult. This instance of a SyncResult is returned by the SyncAdapter in response to a sync request when a sync is already underway.
[read-only]
static
CreatorIParcelableCreator.
DatabaseErrorBoolean. Used to indicate that the SyncAdapter experienced a hard error due to an error it received from interacting with the storage layer.
DelayUntilInt64. 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.
FullSyncRequestedBoolean. 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.
[read-only]
HasErrorBoolean. A convenience method for determining of the SyncResult indicates that an error occurred.
[read-only]
HasHardErrorBoolean. Convenience method for determining if the SyncResult indicates that a hard error occurred.
[read-only]
HasSoftErrorBoolean. Convenience method for determining if the SyncResult indicates that a soft error occurred.
MoreRecordsToGetBoolean. This field is ignored by the SyncManager.
PartialSyncUnavailableBoolean. This field is ignored by the SyncManager.
StatsSyncStats. Used to hold extras statistics about the sync operation.
SyncAlreadyInProgressBoolean. 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.
TooManyDeletionsBoolean. 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).
TooManyRetriesBoolean. Used to indicate that the SyncAdapter experienced a hard error due to trying the same operation too many times (as defined by the SyncAdapter).

Protected Properties

[read-only]
override
ThresholdClassIntPtr. This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
[read-only]
override
ThresholdTypeType. This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Public Methods

Clear()
Clears the SyncResult to a clean state.
DescribeContents() : Int32
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
MadeSomeProgress() : Boolean
Convenience method for determining if the Sync should be rescheduled after failing for some reason.
ToDebugString() : String
Generates a debugging string indicating the status.
WriteToParcel(Parcel, ParcelableWriteFlags)
Flatten this object in to a Parcel.