JobInfo

BACKOFF_POLICY_EXPONENTIAL

static val BACKOFF_POLICY_EXPONENTIAL: Int

Exponentially back-off a failed job. See android.app.job.JobInfo.Builder#setBackoffCriteria(long, int) retry_time(current_time, num_failures) = current_time + initial_backoff_millis * 2 ^ (num_failures - 1), num_failures >= 1

Value: 1

BACKOFF_POLICY_LINEAR

static val BACKOFF_POLICY_LINEAR: Int

Linearly back-off a failed job. See android.app.job.JobInfo.Builder#setBackoffCriteria(long, int) retry_time(current_time, num_failures) = current_time + initial_backoff_millis * num_failures, num_failures >= 1

Value: 0

DEFAULT_INITIAL_BACKOFF_MILLIS

static val DEFAULT_INITIAL_BACKOFF_MILLIS: Long

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

Value: 30000L

MAX_BACKOFF_DELAY_MILLIS

static val MAX_BACKOFF_DELAY_MILLIS: Long

Maximum backoff we allow for a job, in milliseconds.

Value: 18000000L

NETWORK_BYTES_UNKNOWN

static val NETWORK_BYTES_UNKNOWN: Int

Sentinel value indicating that bytes are unknown.

Value: -1

NETWORK_TYPE_ANY

static val NETWORK_TYPE_ANY: Int

This job requires network connectivity.

Value: 1

NETWORK_TYPE_CELLULAR

static val NETWORK_TYPE_CELLULAR: Int

This job requires network connectivity that is a cellular network.

Value: 4

NETWORK_TYPE_METERED

static val NETWORK_TYPE_METERED: Int

Deprecated: Cellular networks may be unmetered, or Wi-Fi networks may be metered, so this isn't a good way of selecting a specific transport. Instead, use NETWORK_TYPE_CELLULAR or android.net.NetworkRequest.Builder#addTransportType(int) if your job requires a specific network transport.

This job requires metered connectivity such as most cellular data networks.

Value: 4

NETWORK_TYPE_NONE

static val NETWORK_TYPE_NONE: Int

Default.

Value: 0

NETWORK_TYPE_NOT_ROAMING

static val NETWORK_TYPE_NOT_ROAMING: Int

This job requires network connectivity that is not roaming.

Value: 3

NETWORK_TYPE_UNMETERED

static val NETWORK_TYPE_UNMETERED: Int

This job requires network connectivity that is unmetered.

Value: 2

PRIORITY_DEFAULT

static val PRIORITY_DEFAULT: Int

Default value for all regular jobs. As noted in JobScheduler, these jobs have a general execution time of 10 minutes. Receives the standard job management policy.

Value: 300

PRIORITY_HIGH

static val PRIORITY_HIGH: Int

This task should be ordered ahead of most other tasks. It may be deferred a little, but if it doesn't run at some point, the user may think something is wrong. Assuming all constraints remain satisfied (including ideal system load conditions), these jobs can have an execution time of at least 4 minutes. Setting all of your jobs to high priority will not be beneficial to your app and in fact may hurt its performance in the long run.

Value: 400

PRIORITY_LOW

static val PRIORITY_LOW: Int

Low priority. The task provides some benefit to users, but is not critical and is more of a nice-to-have. This is more important than minimum priority jobs and will be prioritized ahead of them, but may still be deferred in lieu of higher priority jobs. JobScheduler may decide to defer these tasks while there are higher priority tasks in order to ensure there is sufficient quota available for the higher priority tasks. A sample task of low priority: prefetching data the user hasn't requested

Value: 200

PRIORITY_MAX

static val PRIORITY_MAX: Int

This task is critical to user experience or functionality and should be run ahead of all other tasks. Only expedited jobs and user-initiated jobs can have this priority.

Example tasks of max priority:

• Receiving a text message and processing it to show a notification
• Downloading or uploading some content the user requested to transfer immediately

Value: 500

PRIORITY_MIN

static val PRIORITY_MIN: Int

Job has minimal value to the user. The user has absolutely no expectation or knowledge of this task and it has no bearing on the user's perception of the app whatsoever. JobScheduler may decide to defer these tasks while there are higher priority tasks in order to ensure there is sufficient quota available for the higher priority tasks. A sample task of min priority: uploading analytics

Value: 100

describeContents

open fun describeContents(): Int

equals

open fun equals(other: Any?): Boolean

getBackoffPolicy

open fun getBackoffPolicy(): Int

Return the backoff policy of this job.

getClipData

open fun getClipData(): ClipData?

getClipGrantFlags

open fun getClipGrantFlags(): Int

getDebugTags

open fun getDebugTags(): MutableSet<String!>

getEstimatedNetworkDownloadBytes

open fun getEstimatedNetworkDownloadBytes(): Long

Return the estimated size of download traffic that will be performed by this job, in bytes.
Value is a non-negative number of bytes.

getEstimatedNetworkUploadBytes

open fun getEstimatedNetworkUploadBytes(): Long

Return the estimated size of upload traffic that will be performed by this job, in bytes.
Value is a non-negative number of bytes.

getExtras

open fun getExtras(): PersistableBundle

getFlexMillis

open fun getFlexMillis(): Long

Flex time for this job. Only valid if this is a periodic job. The job can execute at any time in a window of flex length at the end of the period.

getId

open fun getId(): Int

Unique job id associated with this application (uid). This is the same job ID you supplied in the Builder constructor.

getInitialBackoffMillis

open fun getInitialBackoffMillis(): Long

The amount of time the JobScheduler will wait before rescheduling a failed job. This value will be increased depending on the backoff policy specified at job creation time. Defaults to 30 seconds, minimum is currently 10 seconds.

getIntervalMillis

open fun getIntervalMillis(): Long

Set to the interval between occurrences of this job. This value is not set if the job does not recur periodically.

getMaxExecutionDelayMillis

open fun getMaxExecutionDelayMillis(): Long

getMinFlexMillis

static fun getMinFlexMillis(): Long

Query the minimum flex time allowed for periodic scheduled jobs. Attempting to declare a shorter flex time than this when scheduling such a job will result in this amount as the effective flex time for the job.

getMinLatencyMillis

open fun getMinLatencyMillis(): Long

Set for a job that does not recur periodically, to specify a delay after which the job will be eligible for execution. This value is not set if the job recurs periodically.

getMinPeriodMillis

static fun getMinPeriodMillis(): Long

Query the minimum interval allowed for periodic scheduled jobs. Attempting to declare a smaller period than this when scheduling a job will result in a job that is still periodic, but will run with this effective period.

getMinimumNetworkChunkBytes

open fun getMinimumNetworkChunkBytes(): Long

Return the smallest piece of data that cannot be easily paused and resumed, in bytes.
Value is a non-negative number of bytes.

getNetworkType

open fun getNetworkType(): Int

Deprecated: This method attempts to map getRequiredNetwork() into the set of simple constants, which results in a loss of fidelity. Callers should move to using getRequiredNetwork() directly.

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

getPriority

open fun getPriority(): Int

getRequiredNetwork

open fun getRequiredNetwork(): NetworkRequest?

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

getService

open fun getService(): ComponentName

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

getTraceTag

open fun getTraceTag(): String?

getTransientExtras

open fun getTransientExtras(): Bundle

getTriggerContentMaxDelay

open fun getTriggerContentMaxDelay(): Long

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

getTriggerContentUpdateDelay

open fun getTriggerContentUpdateDelay(): Long

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

getTriggerContentUris

open fun getTriggerContentUris(): Array<JobInfo.TriggerContentUri!>?

Which content: URIs must change for the job to be scheduled. Returns null if there are none required.

hashCode

open fun hashCode(): Int

isExpedited

open fun isExpedited(): Boolean

isImportantWhileForeground

open fun isImportantWhileForeground(): Boolean

Deprecated: Use isExpedited() instead.

Note: Beginning with android.os.Build.VERSION_CODES#B, this flag will be ignored and no longer function effectively, regardless of the calling app's target SDK version. Calling this method will always return false.

isPeriodic

open fun isPeriodic(): Boolean

Track whether this job will repeat with a given period.

isPersisted

open fun isPersisted(): Boolean

isPrefetch

open fun isPrefetch(): Boolean

isRequireBatteryNotLow

open fun isRequireBatteryNotLow(): Boolean

isRequireCharging

open fun isRequireCharging(): Boolean

isRequireDeviceIdle

open fun isRequireDeviceIdle(): Boolean

isRequireStorageNotLow

open fun isRequireStorageNotLow(): Boolean

isUserInitiated

open fun isUserInitiated(): Boolean

toString

open fun toString(): String

writeToParcel

open fun writeToParcel(
    out: Parcel, 
    flags: Int
): Unit

CREATOR

static val CREATOR: Parcelable.Creator<JobInfo!>