Most visited

Recently visited

Results for

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

JobWorkItem

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.

Summary

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<JobWorkItem>`	`CREATOR`

Public constructors
`JobWorkItem(Intent intent)` Create a new piece of work, which can be submitted to `JobScheduler#enqueue`.
`JobWorkItem(Intent intent, long downloadBytes, long uploadBytes)` Create a new piece of work, which can be submitted to `JobScheduler#enqueue`.

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

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

public static final Creator<JobWorkItem> CREATOR

Public constructors

JobWorkItem

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.

JobWorkItem

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 methods

describeContents

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`

getDeliveryCount

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`

getEstimatedNetworkDownloadBytes

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.

getEstimatedNetworkUploadBytes

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.

getIntent

public Intent getIntent ()

Return the Intent associated with this work.

Returns
`Intent`

toString

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.

writeToParcel

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