未验证 提交 5b4dec72 编写于 作者: 朱天怡 提交者: Gitee

修改

Signed-off-by: N朱天怡 <zhutianyi2@huawei.com>
上级 57160383
# 接口
# 接口
- [开发说明](development-intro.md)
- Ability框架
- FA模型
......@@ -117,9 +117,9 @@
- [@ohos.intl (国际化-Intl)](js-apis-intl.md)
- [@ohos.resourceManager (资源管理)](js-apis-resource-manager.md)
- 资源调度
- [@ohos.backgroundTaskManager (后台任务管理)](js-apis-backgroundTaskManager.md)
- [@ohos.distributedMissionManager (分布式任务管理)](js-apis-distributedMissionManager.md)
- [@ohos.workScheduler (延迟任务调度)](js-apis-workScheduler.md)
- [@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](js-apis-resourceschedule-backgroundTaskManager.md)
- [@ohos.resourceschedule.workScheduler (延迟任务调度)](js-apis-resourceschedule-workScheduler.md)
- [@ohos.WorkSchedulerExtensionAbility (延迟任务调度回调)](js-apis-WorkSchedulerExtensionAbility.md)
- 定制管理
- [@ohos.configPolicy (配置策略)](js-apis-config-policy.md)
......@@ -267,9 +267,11 @@
- [@ohos.application.testRunner (TestRunner)](js-apis-testRunner.md)
- [@ohos.uitest (UiTest)](js-apis-uitest.md)
- 已停止维护的接口
- [@ohos.backgroundTaskManager (后台任务管理)](js-apis-backgroundTaskManager.md)
- [@ohos.bytrace (性能打点)](js-apis-bytrace.md)
- [@ohos.data.storage (轻量级存储)](js-apis-data-storage.md)
- [@ohos.prompt (弹窗)](js-apis-prompt.md)
- [@ohos.workScheduler (延迟任务调度)](js-apis-workScheduler.md)
- [@system.app (应用上下文)](js-apis-system-app.md)
- [@system.battery (电量信息)](js-apis-system-battery.md)
- [@system.bluetooth (蓝牙)](js-apis-system-bluetooth.md)
......
......@@ -11,6 +11,7 @@
对于系统特权应用,提供独立的能效资源申请接口。系统特权应用如果需要使用特定的系统资源,例如需要在被挂起期间仍然能够收到系统公共事件,可以使用能效资源申请接口。
> **说明:**
> - 从API Version 9 开始,该接口不再维护,推荐使用新接口[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](js-apis-resourceschedule-backgroundTaskManager.md)
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。从API version 9开始,导入模块由@ohos.backgroundTaskManager迁移至@ohos.resourceschedule.backgroundTaskManager
> - 后台任务管理错误码见[backgroundTaskManager错误码](../errorcodes/errorcode-backgroundTaskMgr.md)。
......
......@@ -12,7 +12,7 @@
> **说明:**
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。从API version 9开始,导入模块由@ohos.backgroundTaskManager迁移至@ohos.resourceschedule.backgroundTaskManager
> - 后台任务管理错误码见[backgroundTaskManager错误码](../errorcodes/errorcode-backgroundTaskMgr.md)。
## 导入模块
......@@ -45,15 +45,16 @@ requestSuspendDelay(reason: string, callback: Callback&lt;void&gt;): DelaySuspen
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 401 | Parameter error. | 参数检查错误 |
| 9800001 | Memory operation failed. | 内存操作失败 |
| 9800002 | Parcel operation failed. | Parcel读写操作失败 |
| 9800003 | Inner transact failed. | IPC通信失败 |
| 9800004 | System service operation failed. | 系统服务失败 |
| 9900001 | Caller information verification failed. | 短时任务调用方信息校验失败 |
| 9900002 | Background task verification failed. | 短时任务校验失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errcode-backgroundTaskMgr.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9800001 | Memory operation failed. |
| 9800002 | Parcel operation failed. |
| 9800003 | Inner transact failed. | |
| 9800004 | System service operation failed. |
| 9900001 | Caller information verification failed. |
| 9900002 | Background task verification failed. |
**示例**
......@@ -93,15 +94,16 @@ getRemainingDelayTime(requestId: number, callback: AsyncCallback&lt;number&gt;):
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 401 | Parameter error. | 参数检查错误 |
| 9800001 | Memory operation failed. | 内存操作失败 |
| 9800002 | Parcel operation failed. | Parcel读写操作失败 |
| 9800003 | Inner transact failed. | IPC通信失败 |
| 9800004 | System service operation failed. | 系统服务失败 |
| 9900001 | Caller information verification failed. | 短时任务调用方信息校验失败 |
| 9900002 | Background task verification failed. | 短时任务校验失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errcode-backgroundTaskMgr.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9800001 | Memory operation failed. |
| 9800002 | Parcel operation failed. |
| 9800003 | Inner transact failed. | |
| 9800004 | System service operation failed. |
| 9900001 | Caller information verification failed. |
| 9900002 | Background task verification failed. |
**示例**
......@@ -146,15 +148,16 @@ getRemainingDelayTime(requestId: number): Promise&lt;number&gt;
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 401 | Parameter error. | 参数检查错误 |
| 9800001 | Memory operation failed. | 内存操作失败 |
| 9800002 | Parcel operation failed. | Parcel读写操作失败 |
| 9800003 | Inner transact failed. | IPC通信失败 |
| 9800004 | System service operation failed. | 系统服务失败 |
| 9900001 | Caller information verification failed. | 短时任务调用方信息校验失败 |
| 9900002 | Background task verification failed. | 短时任务校验失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errcode-backgroundTaskMgr.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9800001 | Memory operation failed. |
| 9800002 | Parcel operation failed. |
| 9800003 | Inner transact failed. | |
| 9800004 | System service operation failed. |
| 9900001 | Caller information verification failed. |
| 9900002 | Background task verification failed. |
**示例**
```js
......@@ -190,15 +193,16 @@ cancelSuspendDelay(requestId: number): void
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 401 | Parameter error. | 参数检查错误 |
| 9800001 | Memory operation failed. | 内存操作失败 |
| 9800002 | Parcel operation failed. | Parcel读写操作失败 |
| 9800003 | Inner transact failed. | IPC通信失败 |
| 9800004 | System service operation failed. | 系统服务失败 |
| 9900001 | Caller information verification failed. | 短时任务调用方信息校验失败 |
| 9900002 | Background task verification failed. | 短时任务校验失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errcode-backgroundTaskMgr.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9800001 | Memory operation failed. |
| 9800002 | Parcel operation failed. |
| 9800003 | Inner transact failed. | |
| 9800004 | System service operation failed. |
| 9900001 | Caller information verification failed. |
| 9900002 | Background task verification failed. |
**示例**
```js
......@@ -235,17 +239,17 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 201 | Permission denied. | 权限校验失败 |
| 401 | Parameter error. | 参数检查错误 |
| 9800001 | Memory operation failed. | 内存操作失败 |
| 9800002 | Parcel operation failed. | Parcel读写操作失败 |
| 9800003 | Inner transact failed. | IPC通信失败 |
| 9800004 | System service operation failed. | 系统服务失败 |
| 9800005 | Background task verification failed. | 长时任务校验失败 |
| 9800006 | Notification verification failed. | 长时任务通知信息校验失败 |
| 9800007 | Task storage failed. | 长时任务信息存储失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errcode-backgroundTaskMgr.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9800001 | Memory operation failed. |
| 9800002 | Parcel operation failed. |
| 9800003 | Inner transact failed. | |
| 9800004 | System service operation failed. |
| 9800005 | Background task verification failed. |
| 9800006 | Notification verification failed. |
| 9800007 | Task storage failed. |
**示例**
```js
......@@ -312,17 +316,17 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 201 | Permission denied. | 权限校验失败 |
| 401 | Parameter error. | 参数检查错误 |
| 9800001 | Memory operation failed. | 内存操作失败 |
| 9800002 | Parcel operation failed. | Parcel读写操作失败 |
| 9800003 | Inner transact failed. | IPC通信失败 |
| 9800004 | System service operation failed. | 系统服务失败 |
| 9800005 | Background task verification failed. | 长时任务校验失败 |
| 9800006 | Notification verification failed. | 长时任务通知信息校验失败 |
| 9800007 | Task storage failed. | 长时任务信息存储失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errcode-backgroundTaskMgr.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9800001 | Memory operation failed. |
| 9800002 | Parcel operation failed. |
| 9800003 | Inner transact failed. | |
| 9800004 | System service operation failed. |
| 9800005 | Background task verification failed. |
| 9800006 | Notification verification failed. |
| 9800007 | Task storage failed. |
**示例**
```js
......@@ -376,17 +380,17 @@ stopBackgroundRunning(context: Context, callback: AsyncCallback&lt;void&gt;): vo
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 201 | Permission denied. | 权限校验失败 |
| 401 | Parameter error. | 参数检查错误 |
| 9800001 | Memory operation failed. | 内存操作失败 |
| 9800002 | Parcel operation failed. | Parcel读写操作失败 |
| 9800003 | Inner transact failed. | IPC通信失败 |
| 9800004 | System service operation failed. | 系统服务失败 |
| 9800005 | Background task verification failed. | 长时任务校验失败 |
| 9800006 | Notification verification failed. | 长时任务通知信息校验失败 |
| 9800007 | Task storage failed. | 长时任务信息存储失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errcode-backgroundTaskMgr.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9800001 | Memory operation failed. |
| 9800002 | Parcel operation failed. |
| 9800003 | Inner transact failed. | |
| 9800004 | System service operation failed. |
| 9800005 | Background task verification failed. |
| 9800006 | Notification verification failed. |
| 9800007 | Task storage failed. |
**示例**
```js
......@@ -432,17 +436,17 @@ stopBackgroundRunning(context: Context): Promise&lt;void&gt;
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 201 | Permission denied. | 权限校验失败 |
| 401 | Parameter error. | 参数检查错误 |
| 9800001 | Memory operation failed. | 内存操作失败 |
| 9800002 | Parcel operation failed. | Parcel读写操作失败 |
| 9800003 | Inner transact failed. | IPC通信失败 |
| 9800004 | System service operation failed. | 系统服务失败 |
| 9800005 | Background task verification failed. | 长时任务校验失败 |
| 9800006 | Notification verification failed. | 长时任务通知信息校验失败 |
| 9800007 | Task storage failed. | 长时任务信息存储失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errcode-backgroundTaskMgr.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9800001 | Memory operation failed. |
| 9800002 | Parcel operation failed. |
| 9800003 | Inner transact failed. | |
| 9800004 | System service operation failed. |
| 9800005 | Background task verification failed. |
| 9800006 | Notification verification failed. |
| 9800007 | Task storage failed. |
**示例**
```js
......@@ -483,15 +487,15 @@ applyEfficiencyResources(request: [EfficiencyResourcesRequest](#efficiencyresour
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 201 | Permission denied. | 权限校验失败 |
| 401 | Parameter error. | 参数检查错误 |
| 9800001 | Memory operation failed. | 内存操作失败 |
| 9800002 | Parcel operation failed. | Parcel读写操作失败 |
| 9800003 | Inner transact failed. | IPC通信失败 |
| 9800004 | System service operation failed. | 系统服务失败 |
| 18700001 | Caller information verification failed. | 资源申请接口信息校验失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errcode-backgroundTaskMgr.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9800001 | Memory operation failed. |
| 9800002 | Parcel operation failed. |
| 9800003 | Inner transact failed. | |
| 9800004 | System service operation failed. |
| 18700001 | Caller information verification failed. |
**示例**
......@@ -528,15 +532,15 @@ resetAllEfficiencyResources(): void
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 201 | Permission denied. | 权限校验失败 |
| 401 | Parameter error. | 参数检查错误 |
| 9800001 | Memory operation failed. | 内存操作失败 |
| 9800002 | Parcel operation failed. | Parcel读写操作失败 |
| 9800003 | Inner transact failed. | IPC通信失败 |
| 9800004 | System service operation failed. | 系统服务失败 |
| 18700001 | Caller information verification failed. | 资源申请接口信息校验失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errcode-backgroundTaskMgr.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9800001 | Memory operation failed. |
| 9800002 | Parcel operation failed. |
| 9800003 | Inner transact failed. | |
| 9800004 | System service operation failed. |
| 18700001 | Caller information verification failed. |
**示例**
......
......@@ -9,7 +9,6 @@
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块接口仅可在Stage模型下使用。
> - 延迟任务调度约束见[延迟任务调度概述](../../task-management/work-scheduler-overview.md)。
> - 延迟任务调度错误码见[workScheduler错误码](../errorcodes/errorcode-workScheduler.md)。
## 导入模块
......@@ -33,14 +32,15 @@ startWork(work: WorkInfo): void
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 401 | Parameter error. | 参数检查错误 |
| 9700001 | Memory operation failed. | 内存操作失败 |
| 9700002 | Parcel operation failed. | Parcel读写操作失败 |
| 9700003 | System service operation failed. | 系统服务失败 |
| 9700004 | Check workInfo failed. | workInfo校验失败 |
| 9700005 | StartWork failed. | StartWork失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.workScheduler (延迟任务调度)](../errorcodes/errcode-workScheduler.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9700001 | Memory operation failed. |
| 9700002 | Parcel operation failed. |
| 9700003 | System service operation failed. |
| 9700004 | Check workInfo failed. |
| 9700005 | StartWork failed. |
**示例**
......@@ -84,13 +84,14 @@ stopWork(work: WorkInfo, needCancel?: boolean): void
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 401 | Parameter error. | 参数检查错误 |
| 9700001 | Memory operation failed. | 内存操作失败 |
| 9700002 | Parcel operation failed. | Parcel读写操作失败 |
| 9700003 | System service operation failed. | 系统服务失败 |
| 9700004 | Check workInfo failed. | workInfo校验失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.workScheduler (延迟任务调度)](../errorcodes/errcode-workScheduler.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9700001 | Memory operation failed. |
| 9700002 | Parcel operation failed. |
| 9700003 | System service operation failed. |
| 9700004 | Check workInfo failed. |
**示例**
......@@ -133,13 +134,14 @@ getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 401 | Parameter error. | 参数检查错误 |
| 9700001 | Memory operation failed. | 内存操作失败 |
| 9700002 | Parcel operation failed. | Parcel读写操作失败 |
| 9700003 | System service operation failed. | 系统服务失败 |
| 9700004 | Check workInfo failed. | workInfo校验失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.workScheduler (延迟任务调度)](../errorcodes/errcode-workScheduler.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9700001 | Memory operation failed. |
| 9700002 | Parcel operation failed. |
| 9700003 | System service operation failed. |
| 9700004 | Check workInfo failed. |
**示例**
......@@ -180,13 +182,14 @@ getWorkStatus(workId: number): Promise\<WorkInfo>
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 401 | Parameter error. | 参数检查错误 |
| 9700001 | Memory operation failed. | 内存操作失败 |
| 9700002 | Parcel operation failed. | Parcel读写操作失败 |
| 9700003 | System service operation failed. | 系统服务失败 |
| 9700004 | Check workInfo failed. | workInfo校验失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.workScheduler (延迟任务调度)](../errorcodes/errcode-workScheduler.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9700001 | Memory operation failed. |
| 9700002 | Parcel operation failed. |
| 9700003 | System service operation failed. |
| 9700004 | Check workInfo failed. |
**示例**
......@@ -225,12 +228,13 @@ obtainAllWorks(callback : AsyncCallback\<void>): Array\<WorkInfo>
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 401 | Parameter error. | 参数检查错误 |
| 9700001 | Memory operation failed. | 内存操作失败 |
| 9700002 | Parcel operation failed. | Parcel读写操作失败 |
| 9700003 | System service operation failed. | 系统服务失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.workScheduler (延迟任务调度)](../errorcodes/errcode-workScheduler.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9700001 | Memory operation failed. |
| 9700002 | Parcel operation failed. |
| 9700003 | System service operation failed. |
**示例**
......@@ -263,12 +267,13 @@ obtainAllWorks(): Promise<Array\<WorkInfo>>
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 401 | Parameter error. | 参数检查错误 |
| 9700001 | Memory operation failed. | 内存操作失败 |
| 9700002 | Parcel operation failed. | Parcel读写操作失败 |
| 9700003 | System service operation failed. | 系统服务失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.workScheduler (延迟任务调度)](../errorcodes/errcode-workScheduler.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9700001 | Memory operation failed. |
| 9700002 | Parcel operation failed. |
| 9700003 | System service operation failed. |
**示例**
......@@ -293,12 +298,13 @@ stopAndClearWorks(): void
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 401 | Parameter error. | 参数检查错误 |
| 9700001 | Memory operation failed. | 内存操作失败 |
| 9700002 | Parcel operation failed. | Parcel读写操作失败 |
| 9700003 | System service operation failed. | 系统服务失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.workScheduler (延迟任务调度)](../errorcodes/errcode-workScheduler.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9700001 | Memory operation failed. |
| 9700002 | Parcel operation failed. |
| 9700003 | System service operation failed. |
**示例**
......@@ -333,12 +339,13 @@ isLastWorkTimeOut(workId: number, callback : AsyncCallback\<void>): boolean
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 401 | Parameter error. | 参数检查错误 |
| 9700001 | Memory operation failed. | 内存操作失败 |
| 9700002 | Parcel operation failed. | Parcel读写操作失败 |
| 9700003 | System service operation failed. | 系统服务失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.workScheduler (延迟任务调度)](../errorcodes/errcode-workScheduler.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9700001 | Memory operation failed. |
| 9700002 | Parcel operation failed. |
| 9700003 | System service operation failed. |
**示例**
......@@ -377,12 +384,13 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
**错误码**
| 错误码 | 错误信息 | 说明 |
| ---- | --------------------- | ---- |
| 401 | Parameter error. | 参数检查错误 |
| 9700001 | Memory operation failed. | 内存操作失败 |
| 9700002 | Parcel operation failed. | Parcel读写操作失败 |
| 9700003 | System service operation failed. | 系统服务失败 |
以下错误码的详细介绍请参见[@ohos.resourceschedule.workScheduler (延迟任务调度)](../errorcodes/errcode-workScheduler.md)错误码。
| 错误码ID | 错误码信息 |
| ---- | --------------------- |
| 9700001 | Memory operation failed. |
| 9700002 | Parcel operation failed. |
| 9700003 | System service operation failed. |
**示例**
......
......@@ -6,6 +6,7 @@
> **说明:**
>
> - 从API Version 9 开始,该接口不再维护,推荐使用新接口[@ohos.resourceschedule.workScheduler (延迟任务调度)](js-apis-resourceschedule-workScheduler.md)
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块接口仅可在Stage模型下使用。
> - 延迟任务调度约束见[延迟任务调度概述](../../task-management/work-scheduler-overview.md)。
......@@ -17,15 +18,11 @@
import workScheduler from '@ohos.workScheduler';
```
## workScheduler.startWork<sup>(deprecated)</sup>
## workScheduler.startWork
startWork(work: WorkInfo): boolean
通知WorkSchedulerService将工作添加到执行队列。
> **说明:** 从API version 9开始废弃,建议使用[workScheduler.startWork](./js-apis-resourceschedule-workScheduler.md/#workschedulerstartwork9)
>
> 从 API version 9开始支持。
**系统能力**:SystemCapability.ResourceSchedule.WorkScheduler
**参数**
......@@ -61,15 +58,11 @@ startWork(work: WorkInfo): boolean
console.info(`workschedulerLog res: ${res}`);
```
## workScheduler.stopWork<sup>(deprecated)</sup>
## workScheduler.stopWork
stopWork(work: WorkInfo, needCancel?: boolean): boolean
通知WorkSchedulerService停止指定工作。
> **说明:** 从API version 9开始废弃,建议使用[workScheduler.stopWork](./js-apis-resourceschedule-workScheduler.md/#workschedulerstopwork9)
>
> 从 API version 9开始支持。
**系统能力**:SystemCapability.ResourceSchedule.WorkScheduler
**参数**
......@@ -106,15 +99,11 @@ stopWork(work: WorkInfo, needCancel?: boolean): boolean
console.info(`workschedulerLog res: ${res}`);
```
## workScheduler.getWorkStatus<sup>(deprecated)</sup>
## workScheduler.getWorkStatus
getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void
获取工作的最新状态,使用Callback形式返回。
> **说明:** 从API version 9开始废弃,建议使用[workScheduler.getWorkStatus](./js-apis-resourceschedule-workScheduler.md/#workschedulergetworkstatuscallback9)
>
> 从 API version 9开始支持。
**系统能力**:SystemCapability.ResourceSchedule.WorkScheduler
**参数**
......@@ -138,15 +127,11 @@ getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void
});
```
## workScheduler.getWorkStatus<sup>(deprecated)</sup>
## workScheduler.getWorkStatus
getWorkStatus(workId: number): Promise\<WorkInfo>
获取工作的最新状态,使用Promise形式返回。
> **说明:** 从API version 9开始废弃,建议使用[workScheduler.getWorkStatus](./js-apis-resourceschedule-workScheduler.md/#workschedulergetworkstatuspromise9)
>
> 从 API version 9开始支持。
**系统能力**:SystemCapability.ResourceSchedule.WorkScheduler
**参数**
......@@ -173,15 +158,11 @@ getWorkStatus(workId: number): Promise\<WorkInfo>
})
```
## workScheduler.obtainAllWorks<sup>(deprecated)</sup>
## workScheduler.obtainAllWorks
obtainAllWorks(callback : AsyncCallback\<void>): Array\<WorkInfo>
获取与当前应用程序关联的所有工作,使用Callback形式返回。
> **说明:** 从API version 9开始废弃,建议使用[workScheduler.obtainAllWorks](./js-apis-resourceschedule-workScheduler.md/#workschedulerobtainallworkscallback9)
>
> 从 API version 9开始支持。
**系统能力**:SystemCapability.ResourceSchedule.WorkScheduler
**参数**
......@@ -208,15 +189,11 @@ obtainAllWorks(callback : AsyncCallback\<void>): Array\<WorkInfo>
});
```
## workScheduler.obtainAllWorks<sup>(deprecated)</sup>
## workScheduler.obtainAllWorks
obtainAllWorks(): Promise<Array\<WorkInfo>>
获取与当前应用程序关联的所有工作,使用Promise形式返回。
> **说明:** 从API version 9开始废弃,建议使用[workScheduler.obtainAllWorks](./js-apis-resourceschedule-workScheduler.md/#workschedulerobtainallworkspromise9)
>
> 从 API version 9开始支持。
**系统能力**:SystemCapability.ResourceSchedule.WorkScheduler
**返回值**
......@@ -235,15 +212,11 @@ obtainAllWorks(): Promise<Array\<WorkInfo>>
})
```
## workScheduler.stopAndClearWorks<sup>(deprecated)</sup>
## workScheduler.stopAndClearWorks
stopAndClearWorks(): boolean
停止和取消与当前应用程序关联的所有工作。
> **说明:** 从API version 9开始废弃,建议使用[workScheduler.stopAndClearWorks](./js-apis-resourceschedule-workScheduler.md/#workschedulerstopandclearworks9)
>
> 从 API version 9开始支持。
**系统能力**:SystemCapability.ResourceSchedule.WorkScheduler
**示例**
......@@ -253,15 +226,11 @@ stopAndClearWorks(): boolean
console.info(`workschedulerLog res: ${res}`);
```
## workScheduler.isLastWorkTimeOut<sup>(deprecated)</sup>
## workScheduler.isLastWorkTimeOut
isLastWorkTimeOut(workId: number, callback : AsyncCallback\<void>): boolean
检查指定工作的最后一次执行是否为超时操作,使用Callback形式返回。
> **说明:** 从API version 9开始废弃,建议使用[workScheduler.isLastWorkTimeOut](./js-apis-resourceschedule-workScheduler.md/#workschedulerisLastworktimeoutcallback9)
>
> 从 API version 9开始支持。
**系统能力**:SystemCapability.ResourceSchedule.WorkScheduler
**参数**
......@@ -289,15 +258,11 @@ isLastWorkTimeOut(workId: number, callback : AsyncCallback\<void>): boolean
});
```
## workScheduler.isLastWorkTimeOut<sup>(deprecated)</sup>
## workScheduler.isLastWorkTimeOut
isLastWorkTimeOut(workId: number): Promise\<boolean>
检查指定工作的最后一次执行是否为超时操作,使用Promise形式返回。
> **说明:** 从API version 9开始废弃,建议使用[workScheduler.isLastWorkTimeOut](./js-apis-resourceschedule-workScheduler.md/#workschedulerisLastworktimeoutpromise9)
>
> 从 API version 9开始支持。
**系统能力**:SystemCapability.ResourceSchedule.WorkScheduler
**参数**
......
# backgroundTaskManager错误码
从API version 9起,后台任务管理支持异常返回功能。错误码对应数值及含义如下。
## 201 权限校验失败
### 错误信息
Permission denied.
### 可能原因
该错误码表示权限校验失败,可能原因是未配置对应权限。
### 处理步骤
长时任务请配置权限ohos.permission.KEEP_BACKGROUND_RUNNING,能效资源申请请配置权限runningResourcesApply
## 401 参数检查错误
### 错误信息
Parameter error.
### 可能原因
该错误码表示入参检查错误,可能原因是入参检查错误。
### 处理步骤
1. 请根据@ohos.resourceschedule.backgroundTaskManager.d.ts文件检查入参是否为合法值。
## 9800001 内存操作失败
### 错误信息
......
# workScheduler错误码
从API version 9起,后台任务管理支持异常返回功能。错误码对应数值及含义如下。
## 401 参数检查错误
### 错误信息
Parameter error.
### 可能原因
该错误码表示入参检查错误,可能原因是入参检查错误。
### 处理步骤
1. 请根据@ohos.resourceschedule.workScheduler.d.ts文件检查入参是否为合法值。
## 9700001 内存操作失败
### 错误信息
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册