PeriodicSync

public class PeriodicSync
extends Object implements Parcelable

java.lang.Object
   ↳ android.content.PeriodicSync


Value type that contains information about a periodic sync.

Summary

Inherited constants

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 instance's marshaled representation.

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

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

CREATOR

Added in API level 8
public static final Creator<PeriodicSync> CREATOR

account

Added in API level 8
public final Account account

The account to be synced. Can be null.

authority

Added in API level 8
public final String authority

The authority of the sync. Can be null.

extras

Added in API level 8
public final Bundle extras

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

period

Added in API level 8
public final long period

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

Public constructors

PeriodicSync

Added in API level 8
public PeriodicSync (Account account, 
                String authority, 
                Bundle extras, 
                long periodInSeconds)

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

Parameters
account Account

authority String

extras Bundle

periodInSeconds long

Public methods

describeContents

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

equals

Added in API level 8
public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o Object: This value may be null.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

toString

Added in API level 8
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

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