WorkInfo.Builder

java.lang.Object
- ohos.workscheduler.WorkInfo.Builder

封闭类:

WorkInfo
```
public static final class WorkInfo.Builder
extends Object
```
Represents the builder class of WorkInfo objects that specify triggering conditions of a work.

从以下版本开始:

3

构造器概要

构造器
构造器说明

Builder()
Instantiates a new Builder.

构造器
构造器	说明
`Builder()`	Instantiates a new Builder.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`WorkInfo`	`build()`	Constructs the `WorkInfo` object based on the configured elements and triggering conditions.
`WorkInfo.Builder`	`requestBatteryStatus(int requestStatus)`	Creates a `WorkInfo` object that sets the battery state for triggering a work.
`WorkInfo.Builder`	`requestChargingType(boolean requestCharging, int requestchargerType)`	Creates a `WorkInfo` object that sets the charger type for triggering a work.
`WorkInfo.Builder`	`requestDeviceIdleType(boolean needDeepIdle, int idleWaitTime)`	Creates a `WorkInfo` object that sets the device deep idle status for triggering a work.
`WorkInfo.Builder`	`requestNetworkType(int networkType)`	Creates a `WorkInfo` object that sets the network type for triggering a work.
`WorkInfo.Builder`	`requestPersisted(boolean requestPersisted)`	Creates a `WorkInfo` object that sets whether the current work will be saved.
`WorkInfo.Builder`	`requestRepeatCycle(long cycleTime)`	Creates a `WorkInfo` object that sets the interval for repeating a work for unlimited times.
`WorkInfo.Builder`	`requestRepeatCycle(long cycleTime, int requestRepeatTimes)`	Creates a `WorkInfo` object that sets the interval for repeating a work with limited times.
`WorkInfo.Builder`	`requestStorageStatus(int requestStatus)`	Creates a `WorkInfo` object that sets the storage state for triggering a work.
`WorkInfo.Builder`	`setAbilityInfo(int id, String bundleName, String className)`	Creates a `WorkInfo` object that sets the Particle Ability to start when a work is triggered.
`WorkInfo.Builder`	`setPacMaps(PacMap maps)`	Sets extra parameters for this piece of work.

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

- 构造器详细资料
  - Builder
```
public Builder()
```
    Instantiates a new Builder.
- 方法详细资料
  - build
```
public WorkInfo build()
```
    Constructs the WorkInfo object based on the configured elements and triggering conditions.
    After setting the related elements and triggering conditions, you must call this method to create the WorkInfo object.
    
    返回:
    
    Returns WorkInfo object created based on the configured elements and triggering conditions.
    
    从以下版本开始:
    
    3
  - setAbilityInfo
```
public WorkInfo.Builder setAbilityInfo(int id,
                                       String bundleName,
                                       String className)
```
    Creates a WorkInfo object that sets the Particle Ability to start when a work is triggered.
    This method must be called to add ElementNam of the Particle Ability to (@code WorkInfo}. Otherwise, a failure occurs when calling methods such as WorkScheduler#startWork.
    
    参数:
    
    id - Specifies the work ID. If a work with the same ID already exists, it will be replaced by the new work.
    
    bundleName - Specifies the bundlename.
    
    className - Specifies the class to start when the work is triggered.
    
    返回:
    
    Returns the WorkInfo object that sets the Particle Ability to start when a work is triggered.
    
    从以下版本开始:
    
    3
  - requestNetworkType
```
public WorkInfo.Builder requestNetworkType(int networkType)
```
    Creates a WorkInfo object that sets the network type for triggering a work.
    Call this method only when a work needs to be triggered based on the network type. If there are multiple types of networks, call this method to set one network type at a time.
    
    参数:
    
    networkType - Specifies the network type, which can be WorkInfo.NETWORK_TYPE_MOBILE or WorkInfo.NETWORK_TYPE_WIFI.
    
    返回:
    
    Returns the WorkInfo object that sets the network type for triggering a work.
    
    从以下版本开始:
    
    3
  - requestDeviceIdleType
```
public WorkInfo.Builder requestDeviceIdleType(boolean needDeepIdle,
                                              int idleWaitTime)
```
    Creates a WorkInfo object that sets the device deep idle status for triggering a work.
    You can call this method to set or cancel the device deep idle status. A device is considered deep idle if all the following conditions are true: The device screen is off, the device is not in the sleep state, and no user-aware work is running. By default, the device deep idle status is set as the triggering condition of a work. If any other triggering condition except requestPersisted(boolean) is set, the work will not be triggered when the device enters the deep idle state.
    
    参数:
    
    needDeepIdle - Specifies whether a work is triggered when the device enters the deep idle state.
    
    idleWaitTime - Specifies the wait time before a work is triggered when the device enters the deep idle state. The time range is specified by WorkInfo.MIN_IDLE_WAIT_TIME_MS and WorkInfo.MAX_IDLE_WAIT_TIME_MS.
    
    返回:
    
    Returns the WorkInfo object that sets the device deep idle status for triggering a work.
    
    从以下版本开始:
    
    3
  - requestChargingType
```
public WorkInfo.Builder requestChargingType(boolean requestCharging,
                                            int requestchargerType)
```
    Creates a WorkInfo object that sets the charger type for triggering a work.
    Call this method only when a work needs to be triggered based on the charger type. If there are multiple types of chargers, call this method to set one charger at a time.
    
    参数:
    
    requestCharging - Specifies whether a work is triggered when the device starts charging.
    
    requestchargerType - Specifies the charger type.
    
    返回:
    
    Returns the WorkInfo object that sets the charger type for triggering a work.
    
    从以下版本开始:
    
    3
  - requestBatteryStatus
```
public WorkInfo.Builder requestBatteryStatus(int requestStatus)
```
    Creates a WorkInfo object that sets the battery state for triggering a work.
    Call this method only when a work needs to be triggered based on the battery state. Note that only one battery state can be specified.
    
    参数:
    
    requestStatus - Specifies the battery state, which can be WorkInfo.BATTERY_LEVEL_LOW, WorkInfo.BATTERY_LEVEL_OKAY, or WorkInfo.BATTERY_LEVEL_LOW_OR_OKAY.
    
    返回:
    
    Returns the WorkInfo object that sets the charger type for triggering a work.
    
    从以下版本开始:
    
    3
  - requestStorageStatus
```
public WorkInfo.Builder requestStorageStatus(int requestStatus)
```
    Creates a WorkInfo object that sets the storage state for triggering a work.
    Call this method only when a work needs to be triggered based on the storage state. Note that only one storage state can be specified.
    
    参数:
    
    requestStatus - Specifies the storage state, which can be WorkInfo.STORAGE_LEVEL_LOW, WorkInfo.STORAGE_LEVEL_OKAY, or WorkInfo.STORAGE_LEVEL_LOW_OR_OKAY.
    
    返回:
    
    Returns the WorkInfo object that sets the storage state for triggering a work.
    
    从以下版本开始:
    
    3
  - requestRepeatCycle
```
public WorkInfo.Builder requestRepeatCycle(long cycleTime)
```
    Creates a WorkInfo object that sets the interval for repeating a work for unlimited times.
    Call this method only when a work needs to repeat at the specified interval. Note the following: 1. After the device enters the sleep state, the work does not take effect. 2. When the device is not in sleep state, for example, the device screen is on and the application which is not the father who set the work in the foreground, the work is not triggered even if the specified interval is reached. If the device enters the light idle state, the work will be triggered immediately. If the device does not enter the idle state when the time specified by WorkInfo.MAX_REPEAT_DELAY_TIME_MS is reached, then the work will be forcibly triggered. 3. If another triggering condition, for example, charger, is also set, the work will be triggered only once even if the triggering condition is met multiple times during each interval.
    
    参数:
    
    cycleTime - Indicates the interval for triggering a work, in ms. The minimum value is WorkInfo.MIN_REPEAT_CYCLE_TIME_MS.
    
    返回:
    
    Returns WorkInfo object that sets the interval for repeating a work without limited times.
    
    从以下版本开始:
    
    3
  - requestRepeatCycle
```
public WorkInfo.Builder requestRepeatCycle(long cycleTime,
                                           int requestRepeatTimes)
```
    Creates a WorkInfo object that sets the interval for repeating a work with limited times.
    Call this method only when a work needs to repeat at the specified interval. For details, see requestRepeatCycle(long).
    
    参数:
    
    cycleTime - Indicates the interval for triggering a work, in ms. The minimum value is WorkInfo.MIN_REPEAT_CYCLE_TIME_MS.
    
    requestRepeatTimes - Specifies the number of times for repeating a work.
    
    返回:
    
    Returns the WorkInfo object that sets the interval for repeating a work with limited times.
    
    从以下版本开始:
    
    3
  - requestPersisted
```
public WorkInfo.Builder requestPersisted(boolean requestPersisted)
```
    Creates a WorkInfo object that sets whether the current work will be saved.
    Call this method only when a work needs to be saved. By default, the save function is disabled when a work is created; that is, the work will become invalid after the device is restarted. If you enable the save function, the WorkScheduler will restore the work from the saved data when the device is restarted.
    
    参数:
    
    requestPersisted - Specifies whether a work will be saved. Set the parameter to true if you want to save the work; set the parameter to false otherwise.
    
    返回:
    
    Returns WorkInfo object that sets the Particle Ability to start when a work is triggered.
    
    从以下版本开始:
    
    3
  - setPacMaps
```
public WorkInfo.Builder setPacMaps(PacMap maps)
```
    Sets extra parameters for this piece of work.
    
    参数:
    
    maps - Indicates the PacMap object containing the extra parameters to set.
    
    返回:
    
    Returns this Builder instance with the specified PacMap object.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    WorkInfo.getPacMaps()

类 WorkInfo.Builder

构造器概要

方法概要

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

构造器详细资料

Builder

方法详细资料

build

setAbilityInfo

requestNetworkType

requestDeviceIdleType

requestChargingType

requestBatteryStatus

requestStorageStatus

requestRepeatCycle

requestRepeatCycle

requestPersisted

setPacMaps