JobParameters Class

Definition

Namespace:: Android.App.Job

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Contains the parameters used to configure/identify your job.

[Android.Runtime.Register("android/app/job/JobParameters", DoNotGenerateAcw=true)]
public class JobParameters : Java.Lang.Object, Android.OS.IParcelable, IDisposable

[<Android.Runtime.Register("android/app/job/JobParameters", DoNotGenerateAcw=true)>]
type JobParameters = class
    inherit Object
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Inheritance: Object

JavaObject

Object
JobParameters

Attributes: RegisterAttribute

Implements: IParcelable IJavaObject IJavaPeerable IDisposable

Remarks

Contains the parameters used to configure/identify your job. You do not create this object yourself, instead it is handed in to your application by the System.

Java documentation for android.app.job.JobParameters.

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

Name	Description
JobParameters(IntPtr, JniHandleOwnership)	A constructor used when creating managed representations of JNI objects; called by the runtime.

Fields

Name	Description
StopReasonAppStandby	Obsolete. The current standby bucket requires that the job stop now.
StopReasonBackgroundRestriction	Obsolete. The app is restricted from running in the background.
StopReasonCancelledByApp	Obsolete. The job was cancelled directly by the app, either by calling `JobScheduler#cancel(int)`, `JobScheduler#cancelAll()`, or by scheduling a new job with the same job ID.
StopReasonConstraintBatteryNotLow	Obsolete. The requested battery-not-low constraint is no longer satisfied.
StopReasonConstraintCharging	Obsolete. The requested charging constraint is no longer satisfied.
StopReasonConstraintConnectivity	Obsolete. The requested connectivity constraint is no longer satisfied.
StopReasonConstraintDeviceIdle	Obsolete. The requested idle constraint is no longer satisfied.
StopReasonConstraintStorageNotLow	Obsolete. The requested storage-not-low constraint is no longer satisfied.
StopReasonDeviceState	Obsolete. The device state (e.
StopReasonEstimatedAppLaunchTimeChanged	Obsolete. The system's estimate of when the app will be launched changed significantly enough to decide this job shouldn't be running right now.
StopReasonPreempt	Obsolete. The job was stopped to run a higher priority job of the app.
StopReasonQuota	Obsolete. The app has consumed all of its current quota.
StopReasonSystemProcessing	Obsolete. The system is doing some processing that requires stopping this job.
StopReasonTimeout	Obsolete. The job used up its maximum execution time and timed out.
StopReasonTimeoutAbandoned	Obsolete. The job used up its maximum execution time and timed out.
StopReasonUndefined	Obsolete. There is no reason the job is stopped.
StopReasonUser	Obsolete. The user stopped the job.

Properties

Name	Description
Class	Returns the runtime class of this `Object`. (Inherited from Object)
ClipData	Gets the clip supplied with the job's configuration, if one was set.
ClipGrantFlags	Gets the URI permission flags supplied with the job's clip.
Creator	Gets the parcel factory for JobParameters instances.
Extras	Gets the extras supplied through SetExtras(PersistableBundle).
Handle	The handle to the underlying Android instance. (Inherited from Object)
IsExpeditedJob	Gets whether this execution is running as an expedited job, rather than only having requested expedited execution.
IsOverrideDeadlineExpired	For jobs with `android.app.job.JobInfo.Builder#setOverrideDeadline(long)` set, this provides an easy way to tell whether the job is being executed due to the deadline expiring.
IsUserInitiatedJob	Gets whether this execution is running as a user-initiated job, rather than only having requested that status.
JniIdentityHashCode	Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object)
JniManagedPeerState	Gets the state flags last assigned by the runtime. (Inherited from JavaObject)
JniPeerMembers	Gets the JNI metadata used to access members of this Java binding.
JobId	Gets the identifier assigned to this job when it was configured.
JobNamespace	Get the namespace this job was placed in.
Network	Return the network that should be used to perform any network requests for this job.
PeerReference	Gets the JNI object reference for this Java peer. (Inherited from Object)
StopReason	Returns the reason `JobService#onStopJob(JobParameters)` was called on this job.
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	Gets the extras supplied for the job that are not persisted across device restarts.

Methods

Name	Description
Clone()	Creates and returns a copy of this object. (Inherited from Object)
CompleteWork(JobWorkItem)	Report the completion of executing a `JobWorkItem` previously returned by `#dequeueWork()`.
Construct(JniObjectReference, JniObjectReferenceOptions)	Delegates construction of this peer to the runtime's value manager. (Inherited from JavaObject)
DequeueWork()	Dequeue the next pending `JobWorkItem` from these JobParameters associated with their currently running job.
DescribeContents()	Describe the kinds of special objects contained in this Parcelable's marshalled representation.
Dispose()	Releases the resources held by this Java peer. (Inherited from Object)
Dispose(Boolean)	Releases the resources held by this Java peer. (Inherited from Object)
DisposeUnlessReferenced()	Asks the value manager to dispose this peer unless its mapping retains this same managed instance. (Inherited from JavaObject)
Equals(Object)	Tests whether another managed peer refers to the same Java object. (Inherited from JavaObject)
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)
GetTriggeredContentAuthorities()	For jobs with `android.app.job.JobInfo.Builder#addTriggerContentUri` set, this reports which content authorities have triggered the job.
GetTriggeredContentUris()	For jobs with `android.app.job.JobInfo.Builder#addTriggerContentUri` set, this reports which URIs have triggered the job.
JavaFinalize()	Obsolete. 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)
SetPeerReference(JniObjectReference, JniObjectReferenceOptions)	Stores a reference value in the control block without creating a JNI reference copy. (Inherited from JavaObject)
ToArray<T>()	Creates a managed array from this Java array wrapper. (Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	Unregisters this Java peer from the interop runtime. (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, 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)
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)
WriteToParcel(Parcel, ParcelableWriteFlags)	Flatten this object in to a Parcel.

Explicit Interface Implementations

Name	Description
IJavaPeerable.Disposed()	Marks this peer as disposed and calls `Dispose` with `disposing` set to `true`. (Inherited from JavaObject)
IJavaPeerable.Finalized()	Marks this peer as disposed and calls `Dispose` with `disposing` set to `false`. (Inherited from JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock	Gets the native control-block pointer used by this peer. (Inherited from JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32)	Stores the identity hash code supplied by the runtime. (Inherited from JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	Replaces the stored managed peer state flags. (Inherited from JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference)	Updates the peer reference and releases a disposed peer's control block when the reference is invalid. (Inherited from JavaObject)
IJavaPeerable.UnregisterFromRuntime()	Removes this instance from the runtime's Java object lookup.

Extension Methods

Name	Description
GetJniTypeName(IJavaPeerable)	Gets the JNI name of the type of the instance `self`.
JavaAs<TResult>(IJavaPeerable)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.
JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)	Reuses a compatible managed peer or obtains a wrapper of the requested type.
TryJavaCast<TResult>(IJavaPeerable, TResult)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.

Applies to