Android APIs
public class

PeriodicSync

extends Object
implements Parcelable
java.lang.Object
   ↳ android.content.PeriodicSync

Class Overview

Value type that contains information about a periodic sync.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<PeriodicSync> CREATOR
public final Account account The account to be synced.
public final String authority The authority of the sync.
public final Bundle extras Any extras that parameters that are to be passed to the sync adapter.
public final long period How frequently the sync should be scheduled, in seconds.
Public Constructors
PeriodicSync(Account account, String authority, Bundle extras, long periodInSeconds)
Creates a new PeriodicSync, copying the Bundle.
Public Methods
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
boolean equals(Object o)
Compares this instance with the specified object and indicates if they are equal.
String toString()
Returns a string containing a concise, human-readable description of this object.
void writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<PeriodicSync> CREATOR

Added in API level 8

public final Account account

Added in API level 8

The account to be synced. Can be null.

public final String authority

Added in API level 8

The authority of the sync. Can be null.

public final Bundle extras

Added in API level 8

Any extras that parameters that are to be passed to the sync adapter.

public final long period

Added in API level 8

How frequently the sync should be scheduled, in seconds. Kept around for API purposes.

Public Constructors

public PeriodicSync (Account account, String authority, Bundle extras, long periodInSeconds)

Added in API level 8

Creates a new PeriodicSync, copying the Bundle. This constructor is no longer used.

Parameters
account Account
authority String
extras Bundle
periodInSeconds long

Public Methods

public int describeContents ()

Added in API level 8

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns
int a bitmask indicating the set of special object types marshalled by the Parcelable.

public boolean equals (Object o)

Added in API level 8

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
o Object: the object to compare this instance with.
Returns
boolean true if the specified object is equal to this Object; false otherwise.

public String toString ()

Added in API level 8

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.

Returns
String a printable representation of this object.

public void writeToParcel (Parcel dest, int flags)

Added in API level 8

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.