WorkInfo

java.lang.Object
- ohos.workscheduler.WorkInfo

所有已实现的接口:

Sequenceable
```
public final class WorkInfo
extends Object
implements Sequenceable
```
Defines the conditions for triggering a work.
WorkInfo is set by Particle Ability and used in WorkScheduler and WorkSchedulerService. You can use the methods provided by WorkInfo to query the configured triggering conditions.

从以下版本开始:

3

SystemCapability

SystemCapability.ResourceSchedule#WORK_SCHEDULER

嵌套类概要

嵌套类
限定符和类型类说明

static class WorkInfo.Builder
Represents the builder class of WorkInfo objects that specify triggering conditions of a work.
- 从接口继承的嵌套类/接口 ohos.utils.Sequenceable
  Sequenceable.Producer<T>

嵌套类
限定符和类型	类	说明
`static class`	`WorkInfo.Builder`	Represents the builder class of `WorkInfo` objects that specify triggering conditions of a work.

字段概要

字段
限定符和类型	字段	说明
`static int`	`BATTERY_LEVEL_LOW`	Indicates the work is triggered when a low battery level alarm is reported.
`static int`	`BATTERY_LEVEL_LOW_OR_OKAY`	Indicates the work is triggered when a low battery level alarm is reported or when the battery is restored from a low battery level.
`static int`	`BATTERY_LEVEL_OKAY`	Indicates the work is triggered when the battery is restored from a low battery level.
`static int`	`CHARGING_PLUGGED_AC`	Indicates the work is triggered when a DC charger is connected.
`static int`	`CHARGING_PLUGGED_ANY`	Indicates the work is triggered when any charger is connected.
`static int`	`CHARGING_PLUGGED_USB`	Indicates the work is triggered when a USB charger is connected.
`static int`	`CHARGING_PLUGGED_WIRELESS`	Indicates the work is triggered when a wireless charger is connected.
`static int`	`MAX_BATTERY_LEVEL`	Indicates the maximum battery level for triggering the work when no charger is connected.
`static int`	`MAX_IDLE_WAIT_TIME_MS`	Indicates the maximum wait time for triggering the work after the device enters the idle state.
`static int`	`MAX_REPEAT_DELAY_TIME_MS`	Indicates the maximum delay for triggering the work that is supposed to repeat at the specified interval.
`static int`	`MIN_BATTERY_LEVEL`	Indicates the minimum battery level for triggering the work when no charger is connected.
`static int`	`MIN_IDLE_WAIT_TIME_MS`	Indicates the minimum wait time for triggering the work after the device enters the idle state.
`static int`	`MIN_REPEAT_COUNTER`	Indicates the minimum number of times the work is triggered.
`static int`	`MIN_REPEAT_CYCLE_TIME_MS`	Indicates the minimum interval at which the work is triggered.
`static int`	`NETWORK_TYPE_ANY`	Indicates the work is triggered when any network connection is available.
`static int`	`NETWORK_TYPE_BLUETOOTH`	Indicates the work is triggered when a Bluetooth connection is available.
`static int`	`NETWORK_TYPE_ETHERNET`	Indicates the work is triggered when a wire network connection is available.
`static int`	`NETWORK_TYPE_MOBILE`	Indicates the work is triggered when a mobile network connection is available.
`static int`	`NETWORK_TYPE_WIFI`	Indicates the work is triggered when a WiFi network connection is available.
`static int`	`NETWORK_TYPE_WIFI_P2P`	Indicates the work is triggered when a WiFi P2P connection is available.
`static int`	`STORAGE_LEVEL_LOW`	Indicates the work is triggered when the remaining storage space is insufficient.
`static int`	`STORAGE_LEVEL_LOW_OR_OKAY`	Indicates the work is triggered when the remaining storage is insufficient or when the remaining storage is restored from insufficient space.
`static int`	`STORAGE_LEVEL_OKAY`	Indicates the work is triggered when the remaining storage is restored from insufficient space.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`String`	`getAbilityName()`	Obtains the ability name of the work.
`String`	`getBundleName()`	Obtains the bundle name of the work.
`int`	`getCurrentWorkID()`	Obtains the `workID` in the current `WorkInfo` object.
`ElementName`	`getElementInfo()`	Obtains the `ElementName` in the current `WorkInfo` object.
`PacMap`	`getPacMaps()`	Obtains the extra parameters associated with this piece of work.
`int`	`getRepeatCounter()`	Obtains the number of times set for repeating the work.
`long`	`getRepeatCycleTime()`	Obtains the interval at which the work is repeated.
`int`	`getRequestBatteryLevel()`	Obtains the battery level based on which the work is triggered.
`int`	`getRequestBatteryStatus()`	Obtains the battery state based on which the work is triggered.
`int`	`getRequestChargeType()`	Obtains the charger type based on which the work is triggered.
`int`	`getRequestIdleWaitTime()`	Obtains the idle wait time based on which the work is triggered.
`int`	`getRequestNetworkType()`	Obtains the network type based on which the work is triggered.
`int`	`getRequestStorageType()`	Obtains the storage state based on which the work is triggered.
`boolean`	`isRequestBattery()`	Checks whether a battery state has been set for triggering the work.
`boolean`	`isRequestCharging()`	Checks whether a charging state has been set for triggering the work.
`boolean`	`isRequestDeepIdle()`	Checks whether the device deep idle state has been set for triggering the work.
`boolean`	`isRequestDelay()`	Checks whether a delay duration has been set for triggering the work.
`boolean`	`isRequestNetwork()`	Checks whether a network type has been set for triggering the work.
`boolean`	`isRequestPersisted()`	Checks whether the save function has been enabled for the current work.
`boolean`	`isRequestRepeat()`	Checks whether the work has been set to repeat at the specified interval.
`boolean`	`isRequestStorage()`	Checks whether a storage state has been set for triggering the work.
`boolean`	`isWorkInfoValid()`	Checks whether a `WorkInfo` object is valid.
`boolean`	`marshalling(Parcel out)`	marshalling the WorkInfo
`boolean`	`unmarshalling(Parcel in)`	unmarshalling the WorkInfo

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 ohos.utils.Sequenceable
hasFileDescriptor

- 字段详细资料
  - BATTERY_LEVEL_LOW
```
public static final int BATTERY_LEVEL_LOW
```
    Indicates the work is triggered when a low battery level alarm is reported.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - BATTERY_LEVEL_LOW_OR_OKAY
```
public static final int BATTERY_LEVEL_LOW_OR_OKAY
```
    Indicates the work is triggered when a low battery level alarm is reported or when the battery is restored from a low battery level.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - BATTERY_LEVEL_OKAY
```
public static final int BATTERY_LEVEL_OKAY
```
    Indicates the work is triggered when the battery is restored from a low battery level.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - CHARGING_PLUGGED_AC
```
public static final int CHARGING_PLUGGED_AC
```
    Indicates the work is triggered when a DC charger is connected.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - CHARGING_PLUGGED_ANY
```
public static final int CHARGING_PLUGGED_ANY
```
    Indicates the work is triggered when any charger is connected.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - CHARGING_PLUGGED_USB
```
public static final int CHARGING_PLUGGED_USB
```
    Indicates the work is triggered when a USB charger is connected.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - CHARGING_PLUGGED_WIRELESS
```
public static final int CHARGING_PLUGGED_WIRELESS
```
    Indicates the work is triggered when a wireless charger is connected.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - MAX_BATTERY_LEVEL
```
public static final int MAX_BATTERY_LEVEL
```
    Indicates the maximum battery level for triggering the work when no charger is connected.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - MAX_IDLE_WAIT_TIME_MS
```
public static final int MAX_IDLE_WAIT_TIME_MS
```
    Indicates the maximum wait time for triggering the work after the device enters the idle state.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - MAX_REPEAT_DELAY_TIME_MS
```
public static final int MAX_REPEAT_DELAY_TIME_MS
```
    Indicates the maximum delay for triggering the work that is supposed to repeat at the specified interval.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - MIN_BATTERY_LEVEL
```
public static final int MIN_BATTERY_LEVEL
```
    Indicates the minimum battery level for triggering the work when no charger is connected.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - MIN_IDLE_WAIT_TIME_MS
```
public static final int MIN_IDLE_WAIT_TIME_MS
```
    Indicates the minimum wait time for triggering the work after the device enters the idle state.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - MIN_REPEAT_COUNTER
```
public static final int MIN_REPEAT_COUNTER
```
    Indicates the minimum number of times the work is triggered.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - MIN_REPEAT_CYCLE_TIME_MS
```
public static final int MIN_REPEAT_CYCLE_TIME_MS
```
    Indicates the minimum interval at which the work is triggered.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - NETWORK_TYPE_ANY
```
public static final int NETWORK_TYPE_ANY
```
    Indicates the work is triggered when any network connection is available.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - NETWORK_TYPE_BLUETOOTH
```
public static final int NETWORK_TYPE_BLUETOOTH
```
    Indicates the work is triggered when a Bluetooth connection is available.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - NETWORK_TYPE_ETHERNET
```
public static final int NETWORK_TYPE_ETHERNET
```
    Indicates the work is triggered when a wire network connection is available.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - NETWORK_TYPE_MOBILE
```
public static final int NETWORK_TYPE_MOBILE
```
    Indicates the work is triggered when a mobile network connection is available.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - NETWORK_TYPE_WIFI
```
public static final int NETWORK_TYPE_WIFI
```
    Indicates the work is triggered when a WiFi network connection is available.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - NETWORK_TYPE_WIFI_P2P
```
public static final int NETWORK_TYPE_WIFI_P2P
```
    Indicates the work is triggered when a WiFi P2P connection is available.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - STORAGE_LEVEL_LOW
```
public static final int STORAGE_LEVEL_LOW
```
    Indicates the work is triggered when the remaining storage space is insufficient.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - STORAGE_LEVEL_LOW_OR_OKAY
```
public static final int STORAGE_LEVEL_LOW_OR_OKAY
```
    Indicates the work is triggered when the remaining storage is insufficient or when the remaining storage is restored from insufficient space.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - STORAGE_LEVEL_OKAY
```
public static final int STORAGE_LEVEL_OKAY
```
    Indicates the work is triggered when the remaining storage is restored from insufficient space.
    When WorkScheduler detects that the triggering condition is met, it starts the Particle Ability for which the work is set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - marshalling
```
public boolean marshalling(Parcel out)
```
    marshalling the WorkInfo
    
    指定者:
    
    marshalling 在接口中 Sequenceable
    
    参数:
    
    out - writes a Sequenceable object into this
    
    返回:
    
    marshalling state
  - unmarshalling
```
public boolean unmarshalling(Parcel in)
```
    unmarshalling the WorkInfo
    
    指定者:
    
    unmarshalling 在接口中 Sequenceable
    
    参数:
    
    in - Restores a Sequenceable object from this.
    
    返回:
    
    unmarshalling state
  - isWorkInfoValid
```
public boolean isWorkInfoValid()
```
    Checks whether a WorkInfo object is valid.
    
    返回:
    
    Returns true if the WorkInfo object is valid; returns false otherwise. A WorkInfo object is valid only if ElementName is set to a valid value. A WorkInfo object is invalid if ElementName is not set. In this case, a failure occurs when calling methods such as WorkScheduler#startWork.
    
    从以下版本开始:
    
    3
  - getElementInfo
```
public ElementName getElementInfo()
```
    Obtains the ElementName in the current WorkInfo object.
    
    返回:
    
    Returns the ElementName. If no ElementName has been set, null may be returned.
    
    从以下版本开始:
    
    3
  - getCurrentWorkID
```
public int getCurrentWorkID()
```
    Obtains the workID in the current WorkInfo object.
    
    返回:
    
    Returns the workID in the current WorkInfo object.
    
    从以下版本开始:
    
    3
  - getBundleName
```
public String getBundleName()
```
    Obtains the bundle name of the work.
    
    返回:
    
    Returns the bundle name of the work.
    
    从以下版本开始:
    
    3
  - getAbilityName
```
public String getAbilityName()
```
    Obtains the ability name of the work.
    
    返回:
    
    Returns the ability name of the work.
    
    从以下版本开始:
    
    3
  - isRequestNetwork
```
public boolean isRequestNetwork()
```
    Checks whether a network type has been set for triggering the work.
    
    返回:
    
    Returns true if a network type has been set for triggering the work; returns false otherwise.
    
    从以下版本开始:
    
    3
  - getRequestNetworkType
```
public int getRequestNetworkType()
```
    Obtains the network type based on which the work is triggered.
    
    返回:
    
    Returns the network type based on which the work is triggered. Depending on your configuration, the return value may contain one or multiple network types.
    
    从以下版本开始:
    
    3
  - isRequestBattery
```
public boolean isRequestBattery()
```
    Checks whether a battery state has been set for triggering the work.
    
    返回:
    
    Returns true if a battery state has been set for triggering the work; returns false otherwise.
    
    从以下版本开始:
    
    3
  - getRequestBatteryStatus
```
public int getRequestBatteryStatus()
```
    Obtains the battery state based on which the work is triggered.
    
    返回:
    
    Returns the battery state based on which the work is triggered. Depending on your configuration, the return value may contain one or multiple battery states.
    
    从以下版本开始:
    
    3
  - getRequestBatteryLevel
```
public int getRequestBatteryLevel()
```
    Obtains the battery level based on which the work is triggered.
    
    返回:
    
    Returns the battery level based on which the work is triggered. If no battery level has been set, the return value will be 0.
    
    从以下版本开始:
    
    3
  - isRequestCharging
```
public boolean isRequestCharging()
```
    Checks whether a charging state has been set for triggering the work.
    
    返回:
    
    Returns true if a charging state has been set for triggering the work; returns false otherwise.
    
    从以下版本开始:
    
    3
  - getRequestChargeType
```
public int getRequestChargeType()
```
    Obtains the charger type based on which the work is triggered.
    
    返回:
    
    Returns the charger type based on which the work is triggered. Depending on your configuration, the return value may contain one or multiple charger types.
    
    从以下版本开始:
    
    3
  - isRequestStorage
```
public boolean isRequestStorage()
```
    Checks whether a storage state has been set for triggering the work.
    
    返回:
    
    Returns true if a storage state has been set for triggering the work; returns false otherwise.
    
    从以下版本开始:
    
    3
  - getRequestStorageType
```
public int getRequestStorageType()
```
    Obtains the storage state based on which the work is triggered.
    
    返回:
    
    Returns the storage state based on which the work is triggered. Depending on your configuration, the return value may contain one or multiple storage states.
    
    从以下版本开始:
    
    3
  - isRequestDeepIdle
```
public boolean isRequestDeepIdle()
```
    Checks whether the device deep idle state has been set for triggering the work. For details, see WorkInfo.Builder#requestDeviceIdleType.
    
    返回:
    
    Returns true if the device deep idle state has been set for triggering the work; returns false otherwise.
    
    从以下版本开始:
    
    3
  - getRequestIdleWaitTime
```
public int getRequestIdleWaitTime()
```
    Obtains the idle wait time based on which the work is triggered.
    
    返回:
    
    Returns the idle wait time based on which the work is triggered. If no idle wait time has been set, the return value will be 0.
    
    从以下版本开始:
    
    3
  - isRequestPersisted
```
public boolean isRequestPersisted()
```
    Checks whether the save function has been enabled for the current work.
    
    返回:
    
    Returns true if the save function has been enabled for the current work; returns false otherwise.
    
    从以下版本开始:
    
    3
  - isRequestRepeat
```
public boolean isRequestRepeat()
```
    Checks whether the work has been set to repeat at the specified interval.
    
    返回:
    
    Returns true if the work has been set to repeat at the specified interval; returns false otherwise.
    
    从以下版本开始:
    
    3
  - getRepeatCounter
```
public int getRepeatCounter()
```
    Obtains the number of times set for repeating the work.
    
    返回:
    
    Returns the number of times set for repeating the work. Note that the return value is not the number of times that the work was triggered.
    
    从以下版本开始:
    
    3
  - getRepeatCycleTime
```
public long getRepeatCycleTime()
```
    Obtains the interval at which the work is repeated.
    
    返回:
    
    Returns the interval at which the work is repeated. If no interval has been set, the return value will be 0.
    
    从以下版本开始:
    
    3
  - isRequestDelay
```
public boolean isRequestDelay()
```
    Checks whether a delay duration has been set for triggering the work.
    
    返回:
    
    Returns true if a delay duration has been set for triggering the work; returns false otherwise.
    
    从以下版本开始:
    
    3
  - getPacMaps
```
public PacMap getPacMaps()
```
    Obtains the extra parameters associated with this piece of work.
    
    返回:
    
    Returns a PacMap object containing the extra parameters if any; returns null otherwise.
    
    从以下版本开始:
    
    5

类 WorkInfo

嵌套类概要

从接口继承的嵌套类/接口 ohos.utils.Sequenceable

字段概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 ohos.utils.Sequenceable

字段详细资料

BATTERY_LEVEL_LOW

BATTERY_LEVEL_LOW_OR_OKAY

BATTERY_LEVEL_OKAY

CHARGING_PLUGGED_AC

CHARGING_PLUGGED_ANY

CHARGING_PLUGGED_USB

CHARGING_PLUGGED_WIRELESS

MAX_BATTERY_LEVEL

MAX_IDLE_WAIT_TIME_MS

MAX_REPEAT_DELAY_TIME_MS

MIN_BATTERY_LEVEL

MIN_IDLE_WAIT_TIME_MS

MIN_REPEAT_COUNTER

MIN_REPEAT_CYCLE_TIME_MS

NETWORK_TYPE_ANY

NETWORK_TYPE_BLUETOOTH

NETWORK_TYPE_ETHERNET

NETWORK_TYPE_MOBILE

NETWORK_TYPE_WIFI

NETWORK_TYPE_WIFI_P2P

STORAGE_LEVEL_LOW

STORAGE_LEVEL_LOW_OR_OKAY

STORAGE_LEVEL_OKAY

方法详细资料

marshalling

unmarshalling

isWorkInfoValid

getElementInfo

getCurrentWorkID

getBundleName

getAbilityName

isRequestNetwork

getRequestNetworkType

isRequestBattery

getRequestBatteryStatus

getRequestBatteryLevel

isRequestCharging

getRequestChargeType

isRequestStorage

getRequestStorageType

isRequestDeepIdle

getRequestIdleWaitTime

isRequestPersisted

isRequestRepeat

getRepeatCounter

getRepeatCycleTime

isRequestDelay

getPacMaps