JobInfo Class

Definition

Container of data passed to the android.app.job.JobScheduler fully encapsulating the parameters required to schedule work against the calling application.

[Android.Runtime.Register("android/app/job/JobInfo", DoNotGenerateAcw=true)]
public class JobInfo : Java.Lang.Object, Android.OS.IParcelable, IDisposable, Java.Interop.IJavaPeerable
[<Android.Runtime.Register("android/app/job/JobInfo", DoNotGenerateAcw=true)>]
type JobInfo = class
    inherit Object
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
Inheritance
JobInfo
Attributes
Implements

Remarks

Container of data passed to the android.app.job.JobScheduler fully encapsulating the parameters required to schedule work against the calling application. These are constructed using the JobInfo.Builder. The goal here is to provide the scheduler with high-level semantics about the work you want to accomplish.

Prior to Android version Build.VERSION_CODES#Q, you had to specify at least one constraint on the JobInfo object that you are creating. Otherwise, the builder would throw an exception when building. From Android version Build.VERSION_CODES#Q and onwards, it is valid to schedule jobs with no constraints.

Java documentation for android.app.job.JobInfo.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

JobInfo(IntPtr, JniHandleOwnership)

A constructor used when creating managed representations of JNI objects; called by the runtime.

Fields

DefaultInitialBackoffMillis

Amount of backoff a job has initially by default, in milliseconds.

MaxBackoffDelayMillis

Maximum backoff we allow for a job, in milliseconds.

NetworkBytesUnknown

Sentinel value indicating that bytes are unknown.

PriorityDefault
Obsolete.

Default value for all regular jobs.

PriorityHigh
Obsolete.

This task should be ordered ahead of most other tasks.

PriorityLow
Obsolete.

Low priority.

PriorityMax
Obsolete.

This task should be run ahead of all other tasks.

PriorityMin
Obsolete.

Job has minimal value to the user.

Properties

BackoffPolicyValue

Return the backoff policy of this job.

Class

Returns the runtime class of this Object.

(Inherited from Object)
ClipData
ClipGrantFlags
Creator
EstimatedNetworkDownloadBytes

Return the estimated size of download traffic that will be performed by this job, in bytes.

EstimatedNetworkUploadBytes

Return the estimated size of upload traffic that will be performed by this job, in bytes.

Extras

Bundle of extras which are returned to your application at execution time.

FlexMillis

Flex time for this job.

Handle

The handle to the underlying Android instance.

(Inherited from Object)
Id

Unique job id associated with this application (uid).

InitialBackoffMillis

The amount of time the JobScheduler will wait before rescheduling a failed job.

IntervalMillis

Set to the interval between occurrences of this job.

IsExpedited
IsImportantWhileForeground
IsPeriodic

Track whether this job will repeat with a given period.

IsPersisted
IsPrefetch
IsRequireBatteryNotLow
IsRequireCharging

Whether this job needs the device to be plugged in.

IsRequireDeviceIdle

Whether this job needs the device to be in an Idle maintenance window.

IsRequireStorageNotLow
IsUserInitiated
JniIdentityHashCode (Inherited from Object)
JniPeerMembers
MaxExecutionDelayMillis

See JobInfo Builder setOverrideDeadline(long).

MinFlexMillis

Query the minimum flex time allowed for periodic scheduled jobs.

MinimumNetworkChunkBytes

Return the smallest piece of data that cannot be easily paused and resumed, in bytes.

MinLatencyMillis

Set for a job that does not recur periodically, to specify a delay after which the job will be eligible for execution.

MinPeriodMillis

Query the minimum interval allowed for periodic scheduled jobs.

NetworkType

Return the basic description of the kind of network this job requires.

PeerReference (Inherited from Object)
Priority
RequiredNetwork

Return the detailed description of the kind of network this job requires, or null if no specific kind of network is required.

Service

Name of the service endpoint that will be called back into by the JobScheduler.

ThresholdClass

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

ThresholdType

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

TransientExtras
TriggerContentMaxDelay

When triggering on content URI changes, this is the maximum delay we will use before scheduling the job.

TriggerContentUpdateDelay

When triggering on content URI changes, this is the delay from when a change is detected until the job is scheduled.

Methods

Clone()

Creates and returns a copy of this object.

(Inherited from Object)
DescribeContents()

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

Dispose() (Inherited from Object)
Dispose(Boolean) (Inherited from Object)
Equals(Object)

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

(Inherited from Object)
GetHashCode()

Returns a hash code value for the object.

(Inherited from Object)
GetTriggerContentUris()

Which content: URIs must change for the job to be scheduled.

JavaFinalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

(Inherited from Object)
Notify()

Wakes up a single thread that is waiting on this object's monitor.

(Inherited from Object)
NotifyAll()

Wakes up all threads that are waiting on this object's monitor.

(Inherited from Object)
SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
ToArray<T>() (Inherited from Object)
ToString()

Returns a string representation of the object.

(Inherited from Object)
UnregisterFromRuntime() (Inherited from Object)
Wait()

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>.

(Inherited from Object)
Wait(Int64)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)
Wait(Int64, Int32)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)
WriteToParcel(Parcel, ParcelableWriteFlags)

Flatten this object in to a Parcel.

Explicit Interface Implementations

IJavaPeerable.Disposed() (Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced() (Inherited from Object)
IJavaPeerable.Finalized() (Inherited from Object)
IJavaPeerable.JniManagedPeerState (Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32) (Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) (Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference) (Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to