PeriodicTask

public class PeriodicTask extends Task

A periodic task is one that will recur at the specified interval, without needing to be rescheduled. Schedule a task that will recur until the user calls one of cancelAllTasks(Class), or cancelTask(String, Class) with an identifying tag.

Periodic tasks will not be scheduled if their period is below a certain minimum (currently 30 seconds).

Nested Class Summary

class PeriodicTask.Builder

Inherited Constant Summary

From class com.google.android.gms.gcm.Task

int	EXTRAS_LIMIT_BYTES	The maximum size allowed for extras bundle in bytes.
int	NETWORK_STATE_ANY	Specify using `setRequiredNetwork(int)` that your task will execute regardless of whether a network is available.
int	NETWORK_STATE_CONNECTED	Specify using `setRequiredNetwork(int)` that your task will only execute if some sort of data connection is available - either metered or unmetered.
int	NETWORK_STATE_UNMETERED	Specify using `setRequiredNetwork(int)` that your task will only execute if there is an unmetered network connection available.
long	UNINITIALIZED

From interface android.os.Parcelable

int	CONTENTS_FILE_DESCRIPTOR
int	PARCELABLE_WRITE_RETURN_VALUE

Field Summary

public static final Creator<PeriodicTask>	CREATOR
protected long	mFlexInSeconds
protected long	mIntervalInSeconds

Public Method Summary

long	getFlex()
long	getPeriod()
void	toBundle(Bundle bundle) Insert the task object into the provided bundle for IPC.
String	toString()
void	writeToParcel(Parcel parcel, int flags)

Inherited Method Summary

From class com.google.android.gms.gcm.Task

int	describeContents()
Bundle	getExtras()
int	getRequiredNetwork() If the specified network is unavailable, your task will not be run until it is.
boolean	getRequiresCharging() If the device is not charging and this is set to true, your task will not be run until it is.
String	getServiceName()
String	getTag()
boolean	isPersisted()
boolean	isUpdateCurrent()
void	writeToParcel(Parcel parcel, int i)

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface android.os.Parcelable

abstract int	describeContents()
abstract void	writeToParcel(Parcel arg0, int arg1)

Fields

public static final Creator<PeriodicTask> CREATOR

protected long mFlexInSeconds

protected long mIntervalInSeconds

Public Methods

public long getFlex ()

Returns

The number of seconds before the end of the period returned via getPeriod() that this periodic task can be executed early.

public long getPeriod ()

Returns

The period for this task. The number of seconds between subsequent executions.

public void toBundle (Bundle bundle)

Insert the task object into the provided bundle for IPC. Use #fromBundle to recreate the object on the other side.

public String toString ()

public void writeToParcel (Parcel parcel, int flags)

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated June 27, 2016.