Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 49d6f66b 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!2061 修改文档 

Merge pull request !2061 from nobbo/master
上级 1404d042 dd373356
隐藏空白更改
内联 并排
Showing with 340 addition and 374 deletion
zh-cn/application-dev/reference/apis/js-apis-workScheduler.md
浏览文件 @ 49d6f66b
# 延迟任务调度 # 延迟任务调度
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
``` ```
import workScheduler from '@ohos.workScheduler' import workScheduler from '@ohos.workScheduler'
``` ```
## workScheduler.startWork ## workScheduler.startWork
- **系统能力**： startWork(work: WorkInfo): boolean
SystemCapability.ResourceSchedule.WorkScheduler
通知WorkSchedulerService将工作添加到执行队列。
- **接口**：
workScheduler.startWork(work: WorkInfo): boolean **系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
- **说明**： **参数**：
通知WorkSchedulerService将工作添加到执行队列。
| 参数名 | 类型 | 必填 | 说明 |
- **参数**： | -------- | -------- | -------- | -------- |
| work | [WorkInfo](#workinfo) | 是 | 指示要添加到执行队列的工作。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | **返回值**：
| work | WorkInfo | 是 | 指示要添加到执行队列的工作。 |
| 类型 | 说明 |
- **返回值**： | -------- | -------- |
| boolean | 如果工作成功添加到执行队列，则返回true，否则返回false。 |
| 类型 | 说明 |
| -------- | -------- | **示例**：
| boolean | 如果工作成功添加到执行队列，则返回true，否则返回false。 |
```
- **示例**： let workInfo = {
workId: 1,
``` batteryLevel:50,
let workInfo = { batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW,
workId: 1, isRepeat: false,
batteryLevel:50, isPersisted: true,
batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW, bundleName: "com.example.myapplication",
isRepeat: false, abilityName: "MyExtension"
isPersisted: true, }
bundleName: "com.example.myapplication", var res = workScheduler.startWork(workInfo);
abilityName: "MyExtension" console.info("workschedulerLog res:" + res);
} ```
var res = workScheduler.startWork(workInfo);
console.info("workschedulerLog res:" + res); ## workScheduler.stopWork
``` stopWork(work: WorkInfo, needCancel?: boolean): boolean
## workScheduler.stopWork 通知WorkSchedulerService停止指定工作。
- **系统能力**：
SystemCapability.ResourceSchedule.WorkScheduler **系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
- **接口**： **参数**：
stopWork(work: WorkInfo, needCancel?: boolean): boolean
| 参数名 | 类型 | 必填 | 说明 |
- **说明**： | -------- | -------- | -------- | -------- |
通知WorkSchedulerService停止指定工作。 | work | [WorkInfo](#workinfo) | 是 | 指示要停止的工作。 |
|needCancel|boolean| 是| 是否需要取消的工作。|
- **参数**：
**返回值**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | 类型 | 说明 |
| work | WorkInfo | 是 | 指示要停止的工作。 | | -------- | -------- |
|needCancel|boolean| 是| 是否需要取消的工作。| | boolean | 如果成功，则返回true，否则返回false。 |
- **返回值**： **示例**：
| 类型 | 说明 | ```
| -------- | -------- | let workInfo = {
| boolean | 如果成功，则返回true，否则返回false。 | workId: 1,
batteryLevel:50,
- **示例**： batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW,
isRepeat: false,
``` isPersisted: true,
let workInfo = { bundleName: "com.example.myapplication",
workId: 1, abilityName: "MyExtension"
batteryLevel:50, }
batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW, var res = workScheduler.stopWork(workInfo, false);
isRepeat: false, console.info("workschedulerLog res:" + res);
isPersisted: true, ```
bundleName: "com.example.myapplication",
abilityName: "MyExtension" ## workScheduler.getWorkStatus
} getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void
var res = workScheduler.stopWork(workInfo, false);
console.info("workschedulerLog res:" + res); 获取工作的最新状态，使用Callback形式返回。
```
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
## workScheduler.getWorkStatus
- **系统能力**： **参数**：
SystemCapability.ResourceSchedule.WorkScheduler
| 参数名 | 类型 | 必填 | 说明 |
- **接口**： | -------- | -------- | -------- | -------- |
getWorkStatus(workId: number, callback : AsyncCallback<WorkInfo>): void | workId | number | 是 | work的id。 |
|callback|AsyncCallback\<[WorkInfo](#workinfo)>| 是| 指定的callback回调方法。如果指定的工作Id有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。|
- **说明**：
获取工作的最新状态，使用Callback形式返回。 **示例**：
- **参数**： ```
workScheduler.getWorkStatus(50, (err, res) => {
| 参数名 | 类型 | 必填 | 说明 | if (err) {
| -------- | -------- | -------- | -------- | console.info('workschedulerLog getWorkStatus failed, because:' + err.data);
| workId | number | 是 | work的id。 | } else {
|callback|AsyncCallback<WorkInfo>| 是| 指定的callback回调方法。如果指定的工作Id有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。| for (let item in res) {
console.info('workschedulerLog getWorkStatus success,' + item + ' is:' + res[item]);
}
- **示例**： }
});
``` ```
workScheduler.getWorkStatus(50, (err, res) => {
if (err) { ## workScheduler.getWorkStatus
console.info('workschedulerLog getWorkStatus failed, because:' + err.data); getWorkStatus(workID: number): Promise\<WorkInfo>
} else {
for (let item in res) { 获取工作的最新状态，使用Promise形式返回。
console.info('workschedulerLog getWorkStatus success,' + item + ' is:' + res[item]);
} **系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
}
}); **参数**：
```
| 参数名 | 类型 | 必填 | 说明 |
## workScheduler.getWorkStatus | -------- | -------- | -------- | -------- |
- **系统能力**： | workId | number | 是 | work的id。 |
SystemCapability.ResourceSchedule.WorkScheduler
**返回值**：
- **接口**：
getWorkStatus(workID: number): Promise<WorkInfo> | 类型 | 说明 |
| -------- | -------- |
- **说明**： | Promise\<[WorkInfo](#workinfo)> | 指定的Promise回调方法。如果指定的工作ID有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。 |
获取工作的最新状态，使用Promise形式返回。
**示例**：
- **参数**：
```
| 参数名 | 类型 | 必填 | 说明 | workScheduler.getWorkStatus(50).then((res) => {
| -------- | -------- | -------- | -------- | for (let item in res) {
| workId | number | 是 | work的id。 | console.info('workschedulerLog getWorkStatus success,' + item + ' is:' + res[item]);
}
- **返回值**： }).catch((err) => {
console.info('workschedulerLog getWorkStatus failed, because:' + err.data);
| 类型 | 说明 | })
| -------- | -------- | ```
| Promise<WorkInfo> | 指定的Promise回调方法。如果指定的工作ID有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。 |
## workScheduler.obtainAllWorks
- **示例**： obtainAllWorks(callback : AsyncCallback\<void>): Array\<WorkInfo>
``` 获取与当前应用程序关联的所有工作，使用Callback形式返回。
workScheduler.getWorkStatus(50).then((res) => {
for (let item in res) { **系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
console.info('workschedulerLog getWorkStatus success,' + item + ' is:' + res[item]);
} **参数**：
}).catch((err) => {
console.info('workschedulerLog getWorkStatus failed, because:' + err.data); | 参数名 | 类型 | 必填 | 说明 |
}) | -------- | -------- | -------- | -------- |
``` |callback|AsyncCallback\<void>| 是| 指定的callback回调方法。返回与应用程序关联的所有工作。|
## workScheduler.obtainAllWorks **返回值**：
- **系统能力**：
SystemCapability.ResourceSchedule.WorkScheduler | 类型 | 说明 |
| -------- | -------- |
- **接口**： | Array\<[WorkInfo](#workinfo)> | 返回与应用程序关联的所有工作。 |
obtainAllWorks(callback : AsyncCallback<void>): Array<WorkInfo>
**示例**：
- **说明**：
获取与当前应用程序关联的所有工作，使用Callback形式返回。 ```
workScheduler.obtainAllWorks((err, res) =>{
- **参数**： if (err) {
console.info('workschedulerLog obtainAllWorks failed, because:' + err.data);
| 参数名 | 类型 | 必填 | 说明 | } else {
| -------- | -------- | -------- | -------- | console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res));
|callback|AsyncCallback<WorkInfo>| 是| 指定的callback回调方法。返回与应用程序关联的所有工作。| }
});
```
- **返回值**：
## workScheduler.obtainAllWorks
| 类型 | 说明 | obtainAllWorks(): Promise<Array\<WorkInfo>>
| -------- | -------- |
| Array<WorkInfo> | 返回与应用程序关联的所有工作。 | 获取与当前应用程序关联的所有工作，使用Promise形式返回。
- **示例**： **系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
``` **返回值**：
workScheduler.obtainAllWorks((err, res) =>{
if (err) { | 类型 | 说明 |
console.info('workschedulerLog obtainAllWorks failed, because:' + err.data); | -------- | -------- |
} else { | Promise<Array\<[WorkInfo](#workinfo)>> | 指定的Promise回调方法。返回与应用程序关联的所有工作。|
console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res));
} **示例**：
});
``` ```
workScheduler.obtainAllWorks().then((res) => {
## workScheduler.obtainAllWorks console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res));
- **系统能力**： }).catch((err) => {
SystemCapability.ResourceSchedule.WorkScheduler console.info('workschedulerLog obtainAllWorks failed, because:' + err.data);
})
- **接口**： ```
obtainAllWorks(): Promise<Array<WorkInfo>>
## workScheduler.stopAndClearWorks
- **说明**： stopAndClearWorks(): boolean
获取与当前应用程序关联的所有工作，使用Promise形式返回。
停止和取消与当前应用程序关联的所有工作。
- **返回值**：
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
| 类型 | 说明 |
| -------- | -------- | **示例**：
| Promise<Array<WorkInfo>> | 指定的Promise回调方法。返回与应用程序关联的所有工作。|
```
- **示例**： let res = workScheduler.stopAndClearWorks();
console.info("workschedulerLog res:" + res);
``` ```
workScheduler.obtainAllWorks().then((res) => {
console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res)); ## workScheduler.isLastWorkTimeOut
}).catch((err) => { isLastWorkTimeOut(workId: number, callback : AsyncCallback\<void>): boolean
console.info('workschedulerLog obtainAllWorks failed, because:' + err.data);
}) 检查指定工作的最后一次执行是否为超时操作，使用Callback形式返回。
```
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
## workScheduler.stopAndClearWorks
- **系统能力**： **参数**：
SystemCapability.ResourceSchedule.WorkScheduler
| 参数名 | 类型 | 必填 | 说明 |
- **接口**： | -------- | -------- | -------- | -------- |
stopAndClearWorks(): boolean | workId | number | 是 | work的id。 |
|callback|AsyncCallback\<void>| 是| 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。|
- **说明**：
停止和取消与当前应用程序关联的所有工作。 **返回值**：
- **示例**： | 类型 | 说明 |
| -------- | -------- |
``` | boolean | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。 |
let res = workScheduler.stopAndClearWorks();
console.info("workschedulerLog res:" + res); **示例**：
```
```
## workScheduler.isLastWorkTimeOut workScheduler.isLastWorkTimeOut(500, (err, res) =>{
- **系统能力**： if (err) {
SystemCapability.ResourceSchedule.WorkScheduler console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.data);
} else {
- **接口**： console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res);
isLastWorkTimeOut(workId: number, callback : AsyncCallback<void>): boolean }
});
- **说明**： ```
检查指定工作的最后一次执行是否为超时操作，使用Callback形式返回。
## workScheduler.isLastWorkTimeOut
- **参数**： isLastWorkTimeOut(workId: number): Promise\<boolean>
| 参数名 | 类型 | 必填 | 说明 | 检查指定工作的最后一次执行是否为超时操作，使用Promise形式返回。
| -------- | -------- | -------- | -------- |
| workId | number | 是 | work的id。 | **系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
|callback|AsyncCallback<WorkInfo>| 是| 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。|
**参数**：
- **返回值**：
| 参数名 | 类型 | 必填 | 说明 |
| 类型 | 说明 | | -------- | -------- | -------- | -------- |
| -------- | -------- | | workId | number | 是 | work的id。 |
| boolean | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。 |
**返回值**：
- **示例**：
| 类型 | 说明 |
``` | -------- | -------- |
workScheduler.isLastWorkTimeOut(500, (err, res) =>{ | Promise\<boolean> | 指定的Promise回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。|
if (err) {
console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.data); **示例**：
} else {
console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res); ```
} workScheduler.isLastWorkTimeOut(500)
}); .then(res => {
``` console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res);
})
## workScheduler.isLastWorkTimeOut .catch(err => {
- **系统能力**： console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.data);
SystemCapability.ResourceSchedule.WorkScheduler });
})
- **接口**： ```
isLastWorkTimeOut(workId: number): Promise<boolean>
## WorkInfo
- **说明**： 提供工作的具体信息。
检查指定工作的最后一次执行是否为超时操作，使用Promise形式返回。
**系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
- **参数**：
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | |workId |number |是 |当前工作的ID。|
| workId | number | 是 | work的id。 | |bundleName |string |是| 延迟任务包名。|
|abilityName | string| 是| 延迟任务回调通知的组件名（必填）|
- **返回值**： |networkType | [NetworkType](#networktype) | 否| 网络条件 |
|isCharging | bool| 否|是否充电 |
| 类型 | 说明 | |chargerType | [ChargingType](#chargingtype) | 否|充电类型 |
| -------- | -------- | |batteryLevel | number| 否|电量|
| Promise<boolean> | 指定的Promise回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。| |batteryStatus| [BatteryStatus](#batterystatus) | 否|电池状态|
|storageRequest|[StorageRequest](#storagerequest)| 否|存储状态|
- **示例**： |isRepeat|boolean|否|是否循环任务|
|repeatCycleTime |number|否|循环间隔|
``` |repeatCount |number|否|循环次数|
workScheduler.isLastWorkTimeOut(500)
.then(res => { ## NetworkType
console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res); 触发工作的网络类型。
})
.catch(err => { **系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.data);
}); |名称 |默认值 |说明|
}) | -------- | -------- | -------- |
``` |NETWORK_TYPE_ANY |0 |表示这个触发条件是任何类型的网络连接。|
|NETWORK_TYPE_MOBILE |1| 表示这个触发条件是Mobile网络连接。|
## workScheduler.WorkInfo |NETWORK_TYPE_WIFI |2 |表示这个触发条件是Wifi类型的网络连接。|
- **系统能力**： |NETWORK_TYPE_BLUETOOTH |3 |表示这个触发条件是Bluetooth网络连接。|
SystemCapability.ResourceSchedule.WorkScheduler |NETWORK_TYPE_WIFI_P2P |4 |表示这个触发条件是Wifi P2P网络连接。|
|NETWORK_TYPE_ETHERNET |5 |表示这个触发条件是有线网络连接。|
提供工作的具体信息。
## ChargingType
| 参数名 | 类型 | 必填 | 说明 | 触发工作的充电类型。
| -------- | -------- | -------- | -------- |
|workId |number |是 |当前工作的ID。| **系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
|bundleName |string |是| 延迟任务包名。|
|abilityName | string| 是| 延迟任务回调通知的组件名（必填）| |名称 |默认值 |说明|
|networkType | NetworkType| 否| 网络条件 | | -------- | -------- | -------- |
|isCharging | bool| 否|是否充电 | |CHARGING_PLUGGED_ANY |0| 表示这个触发条件是任何类型的充电器连接。|
|chargerType | ChargingType| 否|充电类型 | |CHARGING_PLUGGED_AC |1 |表示这个触发条件是直流充电器连接。|
|batteryLevel | number| 否|电量| |CHARGING_PLUGGED_USB |2 |表示这个触发条件是USB充连接。|
|batteryStatus| BatteryStatus| 否|电池状态| |CHARGING_PLUGGED_WIRELESS |3| 表示这个触发条件是无线充电器连接。|
|storageRequest|StorageRequest| 否|存储状态|
|isRepeat|boolean|否|是否循环任务| ## BatteryStatus
|repeatCycleTime |number|否|循环间隔| 触发工作的电池状态。
|repeatCount |number|否|循环次数|
**系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
## workScheduler.NetworkType
- **系统能力**： |名称 |默认值 |说明|
SystemCapability.ResourceSchedule.WorkScheduler | -------- | -------- | -------- |
|BATTERY_STATUS_LOW |0 |表示这个触发条件是低电告警。|
触发工作的网络类型。 |BATTERY_STATUS_OKAY |1| 表示这个触发条件是从低电恢复到正常电量。|
|BATTERY_STATUS_LOW_OR_OKAY |2 |表示这个触发条件是从低电恢复到正常电量或者低电告警。|
|名称 |默认值 |说明|
| -------- | -------- | -------- | ## StorageRequest
|NETWORK_TYPE_ANY |0 |表示这个触发条件是任何类型的网络连接。| 触发工作的存储状态。
|NETWORK_TYPE_MOBILE |1| 表示这个触发条件是Mobile网络连接。|
|NETWORK_TYPE_WIFI |2 |表示这个触发条件是Wifi类型的网络连接。| **系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
|NETWORK_TYPE_BLUETOOTH |3 |表示这个触发条件是Bluetooth网络连接。|
|NETWORK_TYPE_WIFI_P2P |4 |表示这个触发条件是Wifi P2P网络连接。| |名称 |默认值 |说明|
|NETWORK_TYPE_ETHERNET |5 |表示这个触发条件是有线网络连接。| | -------- | -------- | -------- |
|STORAGE_LEVEL_LOW |0 |表示这个触发条件是存储空间不足。
## workScheduler.ChargingType |STORAGE_LEVEL_OKAY |1 |表示这个触发条件是从存储空间不足恢复到正常。
- **系统能力**：
SystemCapability.ResourceSchedule.WorkScheduler
触发工作的充电类型。
|名称 |默认值 |说明|
| -------- | -------- | -------- |
|CHARGING_PLUGGED_ANY |0| 表示这个触发条件是任何类型的充电器连接。|
|CHARGING_PLUGGED_AC |1 |表示这个触发条件是直流充电器连接。|
|CHARGING_PLUGGED_USB |2 |表示这个触发条件是USB充连接。|
|CHARGING_PLUGGED_WIRELESS |3| 表示这个触发条件是无线充电器连接。|
## workScheduler.BatteryStatus
- **系统能力**：
SystemCapability.ResourceSchedule.WorkScheduler
触发工作的电池状态。
|名称 |默认值 |说明|
| -------- | -------- | -------- |
|BATTERY_STATUS_LOW |0 |表示这个触发条件是低电告警。|
|BATTERY_STATUS_OKAY |1| 表示这个触发条件是从低电恢复到正常电量。|
|BATTERY_STATUS_LOW_OR_OKAY |2 |表示这个触发条件是从低电恢复到正常电量或者低电告警。|
## workScheduler.StorageRequest
- **系统能力**：
SystemCapability.ResourceSchedule.WorkScheduler
触发工作的存储状态。
|名称 |默认值 |说明|
| -------- | -------- | -------- |
|STORAGE_LEVEL_LOW |0 |表示这个触发条件是存储空间不足。
|STORAGE_LEVEL_OKAY |1 |表示这个触发条件是从存储空间不足恢复到正常。
|STORAGE_LEVEL_LOW_OR_OKAY |2 |表示这个触发条件是从存储空间不足恢复到正常或者存储空间不足。 |STORAGE_LEVEL_LOW_OR_OKAY |2 |表示这个触发条件是从存储空间不足恢复到正常或者存储空间不足。
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或