# Print output for @column tags ?>
public
final
class
JobWorkItem
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.app.job.JobWorkItem |
A unit of work that can be enqueued for a job using
JobScheduler.enqueue
. See
JobParameters.dequeueWork
for more details.
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<JobWorkItem> |
CREATOR
|
Public constructors | |
---|---|
JobWorkItem(Intent intent)
Create a new piece of work, which can be submitted to
|
|
JobWorkItem(Intent intent, long downloadBytes, long uploadBytes)
Create a new piece of work, which can be submitted to
|
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
int
|
getDeliveryCount()
Return the count of the number of times this work item has been delivered to the job. |
long
|
getEstimatedNetworkDownloadBytes()
Return the estimated size of download traffic that will be performed by this job, in bytes. |
long
|
getEstimatedNetworkUploadBytes()
Return the estimated size of upload traffic that will be performed by this job work item, in bytes. |
Intent
|
getIntent()
Return the Intent associated with this work. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel out, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
public JobWorkItem (Intent intent)
Create a new piece of work, which can be submitted to
JobScheduler.enqueue
.
Parameters | |
---|---|
intent |
Intent : The general Intent describing this work. |
public JobWorkItem (Intent intent, long downloadBytes, long uploadBytes)
Create a new piece of work, which can be submitted to
JobScheduler.enqueue
.
See JobInfo.Builder#setEstimatedNetworkBytes(long, long)
for
details about how to estimate network traffic.
Parameters | |
---|---|
intent |
Intent : The general Intent describing this work. |
downloadBytes |
long : The estimated size of network traffic that will be
downloaded by this job work item, in bytes.
Value is a non-negative number of bytes. |
uploadBytes |
long : The estimated size of network traffic that will be
uploaded by this job work item, in bytes.
Value is a non-negative number of bytes. |
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 |
public int getDeliveryCount ()
Return the count of the number of times this work item has been delivered
to the job. The value will be > 1 if it has been redelivered because the job
was stopped or crashed while it had previously been delivered but before the
job had called JobParameters.completeWork
for it.
Returns | |
---|---|
int |
public long getEstimatedNetworkDownloadBytes ()
Return the estimated size of download traffic that will be performed by
this job, in bytes.
Value is a non-negative number of bytes.
Returns | |
---|---|
long |
Estimated size of download traffic, or
JobInfo#NETWORK_BYTES_UNKNOWN when unknown.
Value is a non-negative number of bytes. |
public long getEstimatedNetworkUploadBytes ()
Return the estimated size of upload traffic that will be performed by
this job work item, in bytes.
Value is a non-negative number of bytes.
Returns | |
---|---|
long |
Estimated size of upload traffic, or
JobInfo#NETWORK_BYTES_UNKNOWN when unknown.
Value is a non-negative number of bytes. |
public String toString ()
Returns a string representation of the object. In general, the
toString
method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@
', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
Returns | |
---|---|
String |
a string representation of the object. |
public void writeToParcel (Parcel out, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
out |
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.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |