public class JobInfo
extends Object
implements Parcelable
java.lang.Object | |
↳ | android.app.job.JobInfo |
传递给JobScheduler
的数据容器完全封装了针对调用应用程序调度工作所需的参数。 这些是使用JobInfo.Builder
构建的。 您必须在正在创建的JobInfo对象上指定至少一种约束。 这里的目标是为调度程序提供关于您想要完成的工作的高级语义。 否则会在应用程序中抛出异常。
Nested classes |
|
---|---|
class |
JobInfo.Builder 用于构建 |
class |
JobInfo.TriggerContentUri 有关作业想要触发的内容URI修改的信息。 |
Constants |
|
---|---|
int |
BACKOFF_POLICY_EXPONENTIAL 指数式地回退失败的工作。 |
int |
BACKOFF_POLICY_LINEAR 线性回退失败的作业。 |
long |
DEFAULT_INITIAL_BACKOFF_MILLIS 默认情况下,作业最初的退避量(以毫秒为单位)。 |
long |
MAX_BACKOFF_DELAY_MILLIS 我们允许工作的最大回退,以毫秒为单位。 |
int |
NETWORK_TYPE_ANY 这项工作需要网络连接。 |
int |
NETWORK_TYPE_NONE 默认。 |
int |
NETWORK_TYPE_NOT_ROAMING 此作业需要不漫游的网络连接。 |
int |
NETWORK_TYPE_UNMETERED 这项工作需要不受限制的网络连接。 |
Inherited constants |
---|
From interface android.os.Parcelable
|
Fields |
|
---|---|
public static final Creator<JobInfo> |
CREATOR |
Public methods |
|
---|---|
int |
describeContents() 描述此Parcelable实例的封送表示中包含的特殊对象的种类。 |
int |
getBackoffPolicy() 取决于创建此作业时设置的标准,其中一个是 |
PersistableBundle |
getExtras() 在执行时返回给您的应用程序的附加组件。 |
long |
getFlexMillis() 灵活的时间为这份工作。 |
int |
getId() 与此应用程序(uid)关联的唯一作业ID。 |
long |
getInitialBackoffMillis() JobScheduler在重新计划失败的作业之前等待的时间量。 |
long |
getIntervalMillis() 设置为该作业发生的时间间隔。 |
long |
getMaxExecutionDelayMillis() |
static final long |
getMinFlexMillis() 查询定期计划作业允许的最短弹性时间。 |
long |
getMinLatencyMillis() 设置一个不会定期重复的作业,以指定延迟后作业将有资格执行。 |
static final long |
getMinPeriodMillis() 查询定期作业的最小时间间隔。 |
int |
getNetworkType() 一个 |
ComponentName |
getService() 将由JobScheduler调用的服务端点的名称。 |
long |
getTriggerContentMaxDelay() 当触发内容URI更改时,这是调度作业之前我们将使用的最大延迟时间。 |
long |
getTriggerContentUpdateDelay() 当触发内容URI更改时,这是从检测到更改到安排作业的延迟。 |
TriggerContentUri[] |
getTriggerContentUris() 哪些内容:必须更改要安排的作业的URI。 |
boolean |
isPeriodic() 跟踪这项工作是否会在特定时期重复。 |
boolean |
isPersisted() |
boolean |
isRequireCharging() 这项工作是否需要插入设备。 |
boolean |
isRequireDeviceIdle() 此作业是否需要设备处于空闲维护时段。 |
String |
toString() 返回对象的字符串表示形式。 |
void |
writeToParcel(Parcel out, int flags) 将此对象平铺到一个包裹中。 |
Inherited methods |
|
---|---|
From class java.lang.Object
|
|
From interface android.os.Parcelable
|
int BACKOFF_POLICY_EXPONENTIAL
指数式地回退失败的工作。 请参阅setBackoffCriteria(long, int)
retry_time(current_time,num_failures)= current_time + initial_backoff_millis * 2 ^(num_failures - 1),num_failures> = 1
常数值:1(0x00000001)
int BACKOFF_POLICY_LINEAR
线性回退失败的作业。 请参阅setBackoffCriteria(long, int)
retry_time(current_time,num_failures)= current_time + initial_backoff_millis * num_failures,num_failures> = 1
常量值:0(0x00000000)
long DEFAULT_INITIAL_BACKOFF_MILLIS
默认情况下,作业最初的退避量(以毫秒为单位)。
常量值:30000(0x0000000000007530)
long MAX_BACKOFF_DELAY_MILLIS
我们允许工作的最大回退,以毫秒为单位。
常量值:18000000(0x000000000112a880)
int NETWORK_TYPE_NOT_ROAMING
此作业需要不漫游的网络连接。
常量值:3(0x00000003)
int NETWORK_TYPE_UNMETERED
这项工作需要不受限制的网络连接。
常量值:2(0x00000002)
int describeContents ()
描述此Parcelable实例的封送表示中包含的特殊对象的种类。 例如,如果对象将在writeToParcel(Parcel, int)
的输出中包含writeToParcel(Parcel, int)
,则此方法的返回值必须包含CONTENTS_FILE_DESCRIPTOR
位。
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. |
int getBackoffPolicy ()
取决于创建此作业时设置的标准,其中一个是 BACKOFF_POLICY_EXPONENTIAL
或 BACKOFF_POLICY_LINEAR
。
Returns | |
---|---|
int |
PersistableBundle getExtras ()
在执行时返回给您的应用程序的附加组件。
Returns | |
---|---|
PersistableBundle |
long getFlexMillis ()
灵活的时间为这份工作。 只有在这是定期工作时才有效。 该作业可以在任何时间在期末的弹性窗口中执行。
Returns | |
---|---|
long |
int getId ()
与此应用程序(uid)关联的唯一作业ID。 这与您在JobInfo.Builder
构造函数中提供的作业ID相同。
Returns | |
---|---|
int |
long getInitialBackoffMillis ()
JobScheduler在重新计划失败的作业之前等待的时间量。 取决于作业创建时指定的退避策略,该值将会增加。 默认为5秒。
Returns | |
---|---|
long |
long getIntervalMillis ()
设置为该作业发生的时间间隔。 如果作业不定期重复,则不会设置此值。
Returns | |
---|---|
long |
long getMaxExecutionDelayMillis ()
见setOverrideDeadline(long)
。 如果作业定期复现,则不会设置此值。
Returns | |
---|---|
long |
long getMinFlexMillis ()
查询定期计划作业允许的最短弹性时间。 尝试声明比此更短的弹性时间时,安排这样的工作将导致此数量作为工作的有效弹性时间。
Returns | |
---|---|
long |
The minimum available flex time for scheduling periodic jobs, in milliseconds. |
long getMinLatencyMillis ()
设置一个不会定期重复的作业,以指定延迟后作业将有资格执行。 如果作业定期复现,则不会设置此值。
Returns | |
---|---|
long |
long getMinPeriodMillis ()
查询定期作业的最小时间间隔。 试图声明一个较小的时间段,这在安排工作时会导致一个仍然是周期性的工作,但会在这个有效时间段内运行。
Returns | |
---|---|
long |
The minimum available interval for scheduling periodic jobs, in milliseconds. |
int getNetworkType ()
一个 NETWORK_TYPE_ANY
, NETWORK_TYPE_NONE
, NETWORK_TYPE_UNMETERED
,或 NETWORK_TYPE_NOT_ROAMING
。
Returns | |
---|---|
int |
ComponentName getService ()
将由JobScheduler调用的服务端点的名称。
Returns | |
---|---|
ComponentName |
long getTriggerContentMaxDelay ()
当触发内容URI更改时,这是调度作业之前我们将使用的最大延迟时间。
Returns | |
---|---|
long |
long getTriggerContentUpdateDelay ()
当触发内容URI更改时,这是从检测到更改到安排作业的延迟。
Returns | |
---|---|
long |
TriggerContentUri[] getTriggerContentUris ()
哪些内容:必须更改要安排的作业的URI。 如果没有要求,则返回null。
Returns | |
---|---|
TriggerContentUri[] |
boolean isPersisted ()
Returns | |
---|---|
boolean |
Whether or not this job should be persisted across device reboots. |
boolean isRequireDeviceIdle ()
此作业是否需要设备处于空闲维护时段。
Returns | |
---|---|
boolean |
String toString ()
返回对象的字符串表示形式。 通常, toString
方法会返回一个“文本表示”该对象的字符串。 结果应该是一个简洁但内容丰富的表述,对于一个人来说很容易阅读。 建议所有子类重写此方法。
类toString
方法Object
返回一个字符串,其中包含对象为实例的类的名称,符号字符“ @
”以及对象的哈希码的无符号十六进制表示形式。 换句话说,这个方法返回一个字符串,其值等于:
getClass().getName() + '@' + Integer.toHexString(hashCode())
Returns | |
---|---|
String |
a string representation of the object. |
void writeToParcel (Parcel out, int flags)
将此对象平铺到一个包裹中。
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_WRITE_RETURN_VALUE . |