Skip to content

D
Docs

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

通知 159
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

未验证 提交 879b98e9 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!21875 后台任务文档整改 

Merge pull request !21875 from ningning/master
上级 95ddbaea 7f698f04
展开全部 隐藏空白更改
内联 并排
Showing with 241 addition and 247 deletion
zh-cn/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md
浏览文件 @ 879b98e9
# @ohos.WorkSchedulerExtensionAbility (延迟任务调度回调)
本模块提供延迟任务回调能力。
开发者在开发应用时，通过复写该模块的接口，在延迟任务触发的时候，系统会通过接口回调应用，开发者在回调接口里面可以处理自己的任务逻辑。
本模块提供延迟任务回调能力。开发者可重写模块接口，在延迟任务触发时，系统可通过本模块接口回调应用，在回调里处理任务逻辑。
> **说明：**
>
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> - 本模块接口仅可在Stage模型下使用。
## 导入模块
```ts
......@@ -28,7 +26,7 @@ import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility'
onWorkStart(work: workScheduler.WorkInfo): void
延迟任务调度开始回调。
开始延迟任务调度回调。
**系统能力：** SystemCapability.ResourceSchedule.WorkScheduler
......@@ -36,7 +34,7 @@ onWorkStart(work: workScheduler.WorkInfo): void
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ---------------------------------------- | ---- | -------------- |
| work | [workScheduler.WorkInfo](js-apis-resourceschedule-workScheduler.md#workinfo) | 是 | 指示要添加到执行队列的工作。 |
| work | [workScheduler.WorkInfo](js-apis-resourceschedule-workScheduler.md#workinfo) | 是 | 要添加到执行队列的任务。 |
**示例：**
......@@ -52,7 +50,7 @@ onWorkStart(work: workScheduler.WorkInfo): void
onWorkStop(work: workScheduler.WorkInfo): void
延迟任务调度结束回调。
结束延迟任务调度回调。
**系统能力：** SystemCapability.ResourceSchedule.WorkScheduler
......@@ -60,7 +58,7 @@ onWorkStop(work: workScheduler.WorkInfo): void
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ---------------------------------------- | ---- | -------------- |
| work | [workScheduler.WorkInfo](js-apis-resourceschedule-workScheduler.md#workinfo) | 是 | 指示要添加到执行队列的工作。 |
| work | [workScheduler.WorkInfo](js-apis-resourceschedule-workScheduler.md#workinfo) | 是 | 执行队列中要结束回调的任务。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md
浏览文件 @ 879b98e9
# @ohos.distributedMissionManager (分布式任务管理)
分布式任务管理模块提供跨设备系统任务管理能力，包括注册系统任务状态监听、取消系统任务状态监听、开始同步远端任务列表、停止同步远端任务列表、迁移任务操作。
分布式任务管理模块提供跨设备任务管理能力，包括注册和取消任务状态监听、开始和停止同步远端设备任务列表、通过任务ID和包名进行迁移任务等。
> **说明：**
>
......@@ -14,12 +14,11 @@
import distributedMissionManager from '@ohos.distributedMissionManager'
```
## distributedMissionManager.registerMissionListener
registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback, callback: AsyncCallback<void>): void;
注册系统任务状态监听，以回调函数的方式返回。
注册任务状态监听。使用callback异步回调。
**需要权限**：ohos.permission.MANAGE_MISSIONS
......@@ -29,9 +28,9 @@ registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback,
| 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------------------------- | ---- | --------- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 注册监听设备信息。 |
| options | [MissionCallback](#missioncallback) | 是 | 注册的回调方法。 |
| callback | AsyncCallback<void> | 是 | 执行结果回调函数。 |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 注册监听时的设备信息。 |
| options | [MissionCallback](#missioncallback) | 是 | 注册的回调方法。 |
| callback | AsyncCallback<void> | 是 | 回调函数，注册监听成功，err为undefined，否则为错误对象。 |
**示例：**
......@@ -70,7 +69,7 @@ registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback,
registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback): Promise<void>
注册系统任务状态监听，以promise的方式返回。
注册任务状态监听。使用promise异步回调。
**需要权限**：ohos.permission.MANAGE_MISSIONS
......@@ -80,14 +79,14 @@ registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback):
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 设备信息。 |
| options | <a href="#missioncallback">MissionCallback</a> | 是 | 注册的回调方法。 |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 注册监听时的设备信息。 |
| options | <a href="#missioncallback">MissionCallback</a> | 是 | 注册的回调方法。|
**返回值：**
| 类型 | 说明 |
| ------------------- | ---------------- |
| Promise&lt;void&gt; | promise方式返回执行结果。 |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
......@@ -123,12 +122,11 @@ registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback):
}
```
## distributedMissionManager.unRegisterMissionListener
unRegisterMissionListener(parameter: MissionDeviceInfo, callback: AsyncCallback&lt;void&gt;): void;
取消任务状态监听, 以回调函数的方式返回。
取消任务状态监听。使用callback异步回调。
**需要权限**：ohos.permission.MANAGE_MISSIONS
......@@ -138,8 +136,8 @@ unRegisterMissionListener(parameter: MissionDeviceInfo, callback: AsyncCallback&
| 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------------------------- | ---- | --------- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 设备信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 注册监听时的设备信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，取消监听成功，err为undefined，否则为错误对象。|
**示例：**
......@@ -159,12 +157,11 @@ unRegisterMissionListener(parameter: MissionDeviceInfo, callback: AsyncCallback&
}
```
## distributedMissionManager.unRegisterMissionListener
unRegisterMissionListener(parameter: MissionDeviceInfo): Promise&lt;void&gt;
取消任务状态监听，以promise方式返回执行结果。
取消任务状态监听。使用promise异步回调。
**需要权限**：ohos.permission.MANAGE_MISSIONS
......@@ -174,13 +171,13 @@ unRegisterMissionListener(parameter: MissionDeviceInfo): Promise&lt;void&gt;
| 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------------------------- | ---- | ----- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 设备信息。 |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 注册监听时的设备信息。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | ---------------- |
| Promise&lt;void&gt; | promise方式返回执行结果。 |
| Promise&lt;void&gt; |无返回结果的Promise对象。 |
**示例：**
......@@ -204,7 +201,7 @@ unRegisterMissionListener(parameter: MissionDeviceInfo): Promise&lt;void&gt;
startSyncRemoteMissions(parameter: MissionParameter, callback: AsyncCallback&lt;void&gt;): void;
开始同步远端任务列表, 以回调函数的方式返回。
开始同步远端设备的任务列表。使用callback异步回调。
**需要权限**：ohos.permission.MANAGE_MISSIONS
......@@ -215,7 +212,7 @@ startSyncRemoteMissions(parameter: MissionParameter, callback: AsyncCallback&lt;
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------------- | ---- | --------- |
| parameter | [MissionParameter](#missionparameter) | 是 | 同步信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，同步远端任务列表成功时，err为undefined，否则返回错误对象。 |
**示例：**
......@@ -241,7 +238,7 @@ startSyncRemoteMissions(parameter: MissionParameter, callback: AsyncCallback&lt;
startSyncRemoteMissions(parameter: MissionParameter): Promise&lt;void&gt;
开始同步远端任务列表，以promise方式返回执行结果。
开始同步远端设备的任务列表。使用promise异步回调。
**需要权限**：ohos.permission.MANAGE_MISSIONS
......@@ -257,7 +254,7 @@ startSyncRemoteMissions(parameter: MissionParameter): Promise&lt;void&gt;
| 类型 | 说明 |
| ------------------- | ---------------- |
| Promise&lt;void&gt; | promise方式返回执行结果。 |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
......@@ -283,7 +280,7 @@ startSyncRemoteMissions(parameter: MissionParameter): Promise&lt;void&gt;
stopSyncRemoteMissions(parameter: MissionDeviceInfo, callback: AsyncCallback&lt;void&gt;): void;
停止同步远端任务列表, 以回调函数的方式返回。
停止同步远端设备的任务列表。使用callback异步回调。
**需要权限**：ohos.permission.MANAGE_MISSIONS
......@@ -294,7 +291,7 @@ stopSyncRemoteMissions(parameter: MissionDeviceInfo, callback: AsyncCallback&lt;
| 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------------------------- | ---- | --------- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 同步信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，停止同步远端任务列表成功时，err为undefined，否则为错误对象。 |
**示例：**
......@@ -318,7 +315,7 @@ stopSyncRemoteMissions(parameter: MissionDeviceInfo, callback: AsyncCallback&lt;
stopSyncRemoteMissions(parameter: MissionDeviceInfo): Promise&lt;void&gt;
停止同步远端任务列表，以promise方式返回执行结果。
停止同步远端设备的任务列表。使用promise异步回调。
**需要权限**：ohos.permission.MANAGE_MISSIONS
......@@ -334,7 +331,7 @@ stopSyncRemoteMissions(parameter: MissionDeviceInfo): Promise&lt;void&gt;
| 类型 | 说明 |
| ------------------- | ---------------- |
| Promise&lt;void&gt; | promise方式返回执行结果。 |
| Promise&lt;void&gt; | 无返回结果的promise对象。 |
**示例：**
......@@ -358,7 +355,7 @@ stopSyncRemoteMissions(parameter: MissionDeviceInfo): Promise&lt;void&gt;
continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback, callback: AsyncCallback&lt;void&gt;): void;
迁移任务，以回调函数的方式返回。
通过指定任务ID（missionId）的方式进行迁移任务。使用callback异步回调。
**需要权限**：ohos.permission.MANAGE_MISSIONS，ohos.permission.DISTRIBUTED_DATASYNC
......@@ -370,7 +367,7 @@ continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback, callba
| --------- | --------------------------------------- | ---- | ----- |
| parameter | [ContinueDeviceInfo](js-apis-inner-application-continueDeviceInfo.md) | 是 | 迁移信息。 |
| options | [ContinueCallback](js-apis-inner-application-continueCallback.md) | 是 | 迁移任务完成回调函数。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，迁移任务完成时，err为undefined，否则返回错误对象。 |
**错误码：**
......@@ -416,7 +413,7 @@ continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback, callba
continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback): Promise&lt;void&gt;
迁移任务，以promise方式返回执行结果。
通过指定任务ID（missionId）的方式进行迁移任务。使用promise异步回调。
**需要权限**：ohos.permission.MANAGE_MISSIONS，ohos.permission.DISTRIBUTED_DATASYNC
......@@ -433,7 +430,7 @@ continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback): Promi
| 类型 | 说明 |
| ------------------- | ---------------- |
| Promise&lt;void&gt; | promise方式返回执行结果。 |
| Promise&lt;void&gt; |无返回结果的promise对象。 |
**错误码：**
......@@ -479,7 +476,7 @@ continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback): Promi
continueMission(parameter: ContinueMissionInfo, callback: AsyncCallback&lt;void&gt;): void;
通过指定包名的方式进行迁移任务，使用callback异步回调。
通过指定包名（bundleName）的方式进行迁移任务。使用callback异步回调。
**需要权限**：ohos.permission.MANAGE_MISSIONS，ohos.permission.DISTRIBUTED_DATASYNC
......@@ -490,7 +487,7 @@ continueMission(parameter: ContinueMissionInfo, callback: AsyncCallback&lt;void&
| 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------------------------- | ---- | ----- |
| parameter | [ContinueMissionInfo](./js-apis-inner-application-continueMissionInfo.md) | 是 | 迁移信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 迁移任务完成回调函数。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，通过指定包名迁移任务完成时，err为undefined，否则为错误对象。 |
**错误码：**
......@@ -530,7 +527,7 @@ continueMission(parameter: ContinueMissionInfo, callback: AsyncCallback&lt;void&
continueMission(parameter: ContinueMissionInfo): Promise&lt;void&gt;
通过指定包名的方式进行迁移任务，使用Promise异步回调。
通过指定包名（bundleName）的方式进行迁移任务。使用Promise异步回调。
**需要权限**：ohos.permission.MANAGE_MISSIONS，ohos.permission.DISTRIBUTED_DATASYNC
......@@ -546,7 +543,7 @@ continueMission(parameter: ContinueMissionInfo): Promise&lt;void&gt;
| 类型 | 说明 |
| ------------------- | ---------------- |
| Promise&lt;void&gt; | promise方式返回执行结果。 |
| Promise&lt;void&gt; | 无返回结果的promise对象。 |
**错误码：**
......@@ -586,7 +583,7 @@ continueMission(parameter: ContinueMissionInfo): Promise&lt;void&gt;
on(type: 'continueStateChange', callback: Callback&lt;{ state: ContinueState, info: ContinuableInfo }&gt;): void
注册当前应用任务流转状态的监听。
注册当前任务流转状态的监听。
**需要权限**：ohos.permission.MANAGE_MISSIONS
......@@ -596,8 +593,8 @@ on(type: 'continueStateChange', callback: Callback&lt;{ state: ContinueState, i
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------- |
| type | string | 是 | 注册当前应用任务流转的状态监听，取值为continueStateChange |
| callback | Callback&lt;{&nbsp;state:&nbsp;[ContinueState](#continuestate10),&nbsp;info:&nbsp;[ContinuableInfo](./js-apis-inner-application-continuableInfo.md)&nbsp;}&gt; | 是 | 指示要注册的应用任务流转状态监听的回调，返回应用任务流转状态和流转信息。 |
| type | string | 是 | 当前任务流转状态，取值为'continueStateChange'。 |
| callback | Callback&lt;{&nbsp;state:&nbsp;[ContinueState](#continuestate10),&nbsp;info:&nbsp;[ContinuableInfo](./js-apis-inner-application-continuableInfo.md)&nbsp;}&gt; | 是 | 回调函数，返回当前任务的流转状态和流转信息。 |
**示例：**
......@@ -615,7 +612,7 @@ on(type: 'continueStateChange', callback: Callback&lt;{ state: ContinueState, i
off(type: 'continueStateChange', callback?: Callback&lt;{ state: ContinueState, info: ContinuableInfo }&gt;): void
取消当前应用任务流转的状态监听。
取消当前任务流转的状态监听。
**需要权限**：ohos.permission.MANAGE_MISSIONS
......@@ -625,8 +622,8 @@ off(type: 'continueStateChange', callback?: Callback&lt;{ state: ContinueState,
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------- |
| type | string | 是 | 取消当前应用任务流转的状态监听，取值为continueStateChange |
| callback | Callback&lt;{&nbsp;state:&nbsp;[ContinueState](#continuestate10),&nbsp;info:&nbsp;[ContinuableInfo](./js-apis-inner-application-continuableInfo.md)&nbsp;}&gt; | 否 | 指示要取消的应用任务流转状态监听的回调。 |
| type | string | 是 | 当前任务流转状态，取值为'continueStateChange'。 |
| callback | Callback&lt;{&nbsp;state:&nbsp;[ContinueState](#continuestate10),&nbsp;info:&nbsp;[ContinuableInfo](./js-apis-inner-application-continuableInfo.md)&nbsp;}&gt; | 否 | 回调函数，返回当前任务的流转状态和流转信息。<br>参数不填写，取消type对应的所有回调监听。 |
**示例：**
......@@ -642,7 +639,7 @@ off(type: 'continueStateChange', callback?: Callback&lt;{ state: ContinueState,
## MissionCallback
表示开始同步后，建立的回调函数。
开始同步后，建立的回调函数。
**需要权限**：ohos.permission.MANAGE_MISSIONS
......@@ -651,12 +648,12 @@ off(type: 'continueStateChange', callback?: Callback&lt;{ state: ContinueState,
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------------------- | -------- | ---- | ---- | ------------------ |
| notifyMissionsChanged | function | 是 | 否 | 通知任务变化，返回设备ID。 |
| notifySnapshot | function | 是 | 否 | 通知快照变化，返回设备ID，任务ID |
| notifyNetDisconnect | function | 是 | 否 | 通知断开连接，返回设备ID，网络状态 |
| notifySnapshot | function | 是 | 否 | 通知快照变化，返回设备ID，任务ID。 |
| notifyNetDisconnect | function | 是 | 否 | 通知断开连接，返回设备ID，网络状态。 |
## MissionParameter
表示同步时所需参数的枚举。
同步时所需参数的枚举。
**需要权限**：ohos.permission.MANAGE_MISSIONS
......@@ -670,7 +667,7 @@ off(type: 'continueStateChange', callback?: Callback&lt;{ state: ContinueState,
## MissionDeviceInfo
表示注册监听时所需参数的枚举。
注册监听时所需参数的枚举。
**需要权限**：ohos.permission.MANAGE_MISSIONS
......@@ -682,11 +679,11 @@ off(type: 'continueStateChange', callback?: Callback&lt;{ state: ContinueState,
## ContinueState<sup>10+</sup>
ContinueState说明枚举，表示当前应用任务流转的状态。
当前任务流转状态的枚举。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 值 | 说明 |
| ------------- | --------- | ------------------------------------------------------------ |
| ACTIVE | 0 | 表示当前应用任务流转处于激活状态。 |
| INACTIVE | 1 | 表示当前应用任务流转处于未激活状态。 |
\ No newline at end of file
| ACTIVE | 0 | 表示当前任务流转处于激活状态。 |
| INACTIVE | 1 | 表示当前任务流转处于未激活状态。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-reminderAgentManager.md
浏览文件 @ 879b98e9
# @ohos.reminderAgentManager (后台代理提醒)
本模块提供后台代理提醒的能力。
开发应用时，开发者可以调用相关接口创建定时提醒，包括倒计时、日历、闹钟这三类提醒类型。使用后台代理提醒能力后，应用被冻结或退出后，计时和弹出提醒的功能将被后台系统服务代理。
本模块提供后台代理提醒的能力，即当应用被冻结或应用退出时，计时和提醒的功能将被系统服务代理。在开发过程中，开发者可以调用本模块接口创建定时提醒，提醒类型支持倒计时、日历、闹钟三种。
> **说明：**
>
......@@ -15,12 +13,15 @@
import reminderAgentManager from'@ohos.reminderAgentManager';
```
## reminderAgentManager.publishReminder
publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback\<number>): void
发布一个后台代理提醒，使用回调的方式实现异步调用，该方法需要申请通知弹窗权限[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后才能调用。
发布后台代理提醒。使用callback异步回调。
> **说明：**
>
> 该接口需要申请通知弹窗权限[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后调用。
**需要权限**： ohos.permission.PUBLISH_AGENT_REMINDER
......@@ -30,12 +31,12 @@ publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback\<number>):
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| reminderReq | [ReminderRequest](#reminderrequest) | 是 | 需要发布的提醒实例。 |
| callback | AsyncCallback\<number> | 是 | 异步回调，返回当前发布的提醒的id。 |
| reminderReq | [ReminderRequest](#reminderrequest) | 是 | 需要发布的代理提醒实例。 |
| callback | AsyncCallback\<number> | 是 | 回调函数，返回当前发布提醒的id。 |
**错误码：**
以下错误码的详细介绍请参见[@ohos.reminderAgentManager（后台代理提醒）](../errorcodes/errorcode-reminderAgentManager.md)错误码。
以下错误码的详细介绍请参见[reminderAgentManager错误码](../errorcodes/errorcode-reminderAgentManager.md)错误码。
| 错误码ID | 错误信息 |
| --------- | ------- |
......@@ -62,12 +63,15 @@ try {
};
```
## reminderAgentManager.publishReminder
publishReminder(reminderReq: ReminderRequest): Promise\<number>
发布一个后台代理提醒，使用`Promise`的方式实现异步调用，该方法需要申请通知弹窗权限[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后才能调用。
发布后台代理提醒。使用promisek异步回调。
> **说明：**
>
> 该接口需要申请通知弹窗权限[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后调用。
**需要权限**： ohos.permission.PUBLISH_AGENT_REMINDER
......@@ -76,16 +80,16 @@ publishReminder(reminderReq: ReminderRequest): Promise\<number>
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| reminderReq | [ReminderRequest](#reminderrequest) | 是 | 需要发布的提醒实例。 |
| reminderReq | [ReminderRequest](#reminderrequest) | 是 | 需要发布的代理提醒实例。 |
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Promise\<number> | 返回提醒的id。 |
| Promise\<number> | Promise对象，返回提醒的id。 |
**错误码：**
以下错误码的详细介绍请参见[@ohos.reminderAgentManager（后台代理提醒）](../errorcodes/errorcode-reminderAgentManager.md)错误码。
以下错误码的详细介绍请参见[reminderAgentManager错误码](../errorcodes/errorcode-reminderAgentManager.md)错误码。
| 错误码ID | 错误信息 |
| --------- | ------- |
......@@ -115,7 +119,7 @@ try {
cancelReminder(reminderId: number, callback: AsyncCallback\<void>): void
取消指定id的提醒，使用回调的方式实现异步调用。
取消指定Id的代理提醒。使用callback异步回调。
**系统能力**： SystemCapability.Notification.ReminderAgent
......@@ -123,12 +127,12 @@ cancelReminder(reminderId: number, callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| reminderId | number | 是 | 目标提醒的id号。 |
| callback | AsyncCallback\<void> | 是 | 异步回调。 |
| reminderId | number | 是 | 需要取消的代理提醒的Id。 |
| callback | AsyncCallback\<void> | 是 | 回调函数，取消代理提醒成功，err为undefined，否则返回err信息。 |
**错误码：**
以下错误码的详细介绍请参见[@ohos.reminderAgentManager（后台代理提醒）](../errorcodes/errorcode-reminderAgentManager.md)错误码。
以下错误码的详细介绍请参见[reminderAgentManager错误码](../errorcodes/errorcode-reminderAgentManager.md)错误码。
| 错误码ID | 错误信息 |
| --------- | ------- |
......@@ -151,12 +155,11 @@ try {
};
```
## reminderAgentManager.cancelReminder
cancelReminder(reminderId: number): Promise\<void>
取消指定id的提醒，使用Promise方式实现异步调用。
取消指定Id的代理提醒。使用Promise异步回调。
**系统能力**： SystemCapability.Notification.ReminderAgent
......@@ -164,17 +167,17 @@ cancelReminder(reminderId: number): Promise\<void>
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| reminderId | number | 是 | 目标提醒的id号。 |
| reminderId | number | 是 | 需要取消的代理提醒的Id。 |
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Promise\<void> | Promise类型异步回调。 |
| Promise\<void> | 无返回结果的Promise对象。 |
**错误码：**
以下错误码的详细介绍请参见[@ohos.reminderAgentManager（后台代理提醒）](../errorcodes/errorcode-reminderAgentManager.md)错误码。
以下错误码的详细介绍请参见[reminderAgentManager错误码](../errorcodes/errorcode-reminderAgentManager.md)错误码。
| 错误码ID | 错误信息 |
| --------- | ------- |
......@@ -199,8 +202,7 @@ try {
getValidReminders(callback: AsyncCallback<Array\<ReminderRequest>>): void
获取当前应用已设置的所有有效（未过期）的提醒，使用回调方式实现异步调用。
获取当前应用设置的所有有效（未过期）的代理提醒。使用callback异步回调。
**系统能力**： SystemCapability.Notification.ReminderAgent
......@@ -208,11 +210,11 @@ getValidReminders(callback: AsyncCallback<Array\<ReminderRequest>>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback\<Array\<[ReminderRequest](#reminderrequest)>> | 是 | 异步回调，返回当前应用已设置的所有有效（未过期）的提醒。 |
| callback | AsyncCallback\<Array\<[ReminderRequest](#reminderrequest)>> | 是 | 回调函数，返回当前应用设置的所有有效的代理提醒。 |
**错误码：**
以下错误码的详细介绍请参见[@ohos.reminderAgentManager（后台代理提醒）](../errorcodes/errorcode-reminderAgentManager.md)错误码。
以下错误码的详细介绍请参见[reminderAgentManager错误码](../errorcodes/errorcode-reminderAgentManager.md)错误码。
| 错误码ID | 错误信息 |
| --------- | ------- |
......@@ -259,7 +261,7 @@ try {
getValidReminders(): Promise\<Array\<ReminderRequest>>
获取当前应用已设置的所有有效（未过期）的提醒，使用Promise方式实现异步调用。
获取当前应用设置的所有有效（未过期）的代理提醒。使用promise异步回调。
**系统能力**： SystemCapability.Notification.ReminderAgent
......@@ -267,11 +269,11 @@ getValidReminders(): Promise\<Array\<ReminderRequest>>
| 类型 | 说明 |
| -------- | -------- |
| Promise\<Array\<[ReminderRequest](#reminderrequest)>> | 返回当前应用已设置的所有有效（未过期）的提醒。 |
| Promise\<Array\<[ReminderRequest](#reminderrequest)>> | Promise对象，返回当前应用设置的所有有效的代理提醒。 |
**错误码：**
以下错误码的详细介绍请参见[@ohos.reminderAgentManager（后台代理提醒）](../errorcodes/errorcode-reminderAgentManager.md)错误码。
以下错误码的详细介绍请参见[reminderAgentManager错误码](../errorcodes/errorcode-reminderAgentManager.md)错误码。
| 错误码ID | 错误信息 |
| --------- | ------- |
......@@ -312,12 +314,11 @@ try {
};
```
## reminderAgentManager.cancelAllReminders
cancelAllReminders(callback: AsyncCallback\<void>): void
取消当前应用所有的提醒，使用回调的方式实现异步调用。
取消当前应用设置的所有代理提醒。使用callback异步回调。
**系统能力**： SystemCapability.Notification.ReminderAgent
......@@ -325,11 +326,11 @@ cancelAllReminders(callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback\<void> | 是 | 异步回调。 |
| callback | AsyncCallback\<void> | 是 | 回调函数，取消代理提醒成功，err为undefined，否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[@ohos.reminderAgentManager（后台代理提醒）](../errorcodes/errorcode-reminderAgentManager.md)错误码。
以下错误码的详细介绍请参见[reminderAgentManager错误码](../errorcodes/errorcode-reminderAgentManager.md)错误码。
| 错误码ID | 错误信息 |
| --------- | ------- |
......@@ -351,12 +352,11 @@ try {
};
```
## reminderAgentManager.cancelAllReminders
cancelAllReminders(): Promise\<void>
取消当前应用所有的提醒，使用Promise方式实现异步调用。
取消当前应用设置的所有代理提醒。使用Promise异步回调。
**系统能力**： SystemCapability.Notification.ReminderAgent
......@@ -364,11 +364,11 @@ cancelAllReminders(): Promise\<void>
| 类型 | 说明 |
| -------- | -------- |
| Promise\<void> | Promise类型异步回调。 |
| Promise\<void> | 无返回结果的Promise对象。 |
**错误码：**
以下错误码的详细介绍请参见[@ohos.reminderAgentManager（后台代理提醒）](../errorcodes/errorcode-reminderAgentManager.md)错误码。
以下错误码的详细介绍请参见[reminderAgentManager错误码](../errorcodes/errorcode-reminderAgentManager.md)错误码。
| 错误码ID | 错误信息 |
| --------- | ------- |
......@@ -393,7 +393,7 @@ try {
addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback\<void>): void
添加一个NotificationSlot，使用回调的方式实现异步调用。
添加NotificationSlot（通知槽）。使用callback异步回调。
**系统能力**： SystemCapability.Notification.ReminderAgent
......@@ -402,7 +402,7 @@ addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback\<void>): voi
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| slot | [NotificationSlot](js-apis-notification.md#notificationslot) | 是 | notification\.slot实例，仅支持设置其type属性。 |
| callback | AsyncCallback\<void> | 是 | 异步回调。 |
| callback | AsyncCallback\<void> | 是 | 回调函数，添加NotificationSlot成功时，err为undefined，否则err为错误对象。 |
**示例**：
......@@ -430,7 +430,7 @@ try {
addNotificationSlot(slot: NotificationSlot): Promise\<void>
添加一个NotificationSlot，使用Promise方式实现异步调用。
添加NotificationSlot（通知槽）。使用promise异步回调。
**系统能力**： SystemCapability.Notification.ReminderAgent
......@@ -444,7 +444,7 @@ addNotificationSlot(slot: NotificationSlot): Promise\<void>
| 类型 | 说明 |
| -------- | -------- |
| Promise\<void> | Promise类型异步回调。 |
| Promise\<void> | 无返回结果的Promise对象。 |
**示例**：
......@@ -470,7 +470,7 @@ try {
removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback\<void>): void
删除目标NotificationSlot，使用回调的方式实现异步调用。
删除目标NotificationSlot（通知槽），使用callback异步回调。
**系统能力**： SystemCapability.Notification.ReminderAgent
......@@ -479,7 +479,7 @@ removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback\
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| slotType | [notification.SlotType](js-apis-notification.md#slottype) | 是 | 目标notification\.slot的类型。 |
| callback | AsyncCallback\<void> | 是 | 异步回调。 |
| callback | AsyncCallback\<void> | 是 | 回调函数，当删除成功时，err为undefined，否则为错误对象。 |
**示例**：
......@@ -504,7 +504,7 @@ try {
removeNotificationSlot(slotType: notification.SlotType): Promise\<void>
删除目标NotificationSlot，使用Promise方式实现异步调用。
删除目标NotificationSlot（通知槽）。使用Promise异步回调。
**系统能力**： SystemCapability.Notification.ReminderAgent
......@@ -518,7 +518,7 @@ removeNotificationSlot(slotType: notification.SlotType): Promise\<void>
| 类型 | 说明 |
| -------- | -------- |
| Promise\<void> | Promise类型异步回调。 |
| Promise\<void> | 无返回结果的Promise对象。 |
**示例**：
......@@ -564,8 +564,7 @@ try {
## ActionButton
用于设置弹出的提醒通知信息上显示的按钮类型和标题。
弹出的提醒通知中按钮的类型和标题。
**系统能力**：SystemCapability.Notification.ReminderAgent
......@@ -585,14 +584,14 @@ try {
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pkgName | string | 是 | 指明跳转的目标包名。 |
| abilityName | string | 是 | 指明跳转的目标ability名称。 |
| pkgName | string | 是 | 指明跳转目标的包名。 |
| abilityName | string | 是 | 指明跳转目标的ability名称。 |
| uri<sup>10+</sup> | string | 否 | 指明跳转目标的uri信息。<br>**系统接口**: 系统接口，三方应用不支持调用。 |
## MaxScreenWantAgent
全屏显示提醒到达时自动拉起的目标ability信息，该接口预留。
提醒到达时，全屏显示自动拉起目标的ability信息。该接口为预留接口，暂不支持使用。
**系统能力**：SystemCapability.Notification.ReminderAgent
......@@ -604,16 +603,16 @@ try {
## ReminderRequest
提醒实例对象，用于设置提醒类型、响铃时长等具体信息。
代理提醒对象，用于设置提醒类型、响铃时长等具体信息。
**系统能力**：SystemCapability.Notification.ReminderAgent
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| reminderType | [ReminderType](#remindertype) | 是 | 指明提醒类型。 |
| reminderType | [ReminderType](#remindertype) | 是 | 指明代理提醒类型。 |
| actionButton<sup></sup> | [ActionButton](#actionbutton) | 否 | 弹出的提醒通知栏中显示的按钮。<br>-普通应用：最多支持两个按钮。<br>-系统应用：API9最多支持两个按钮，在API10开始最多支持三个按钮。 |
| wantAgent | [WantAgent](#wantagent) | 否 | 点击通知后需要跳转的目标ability信息。 |
| maxScreenWantAgent | [MaxScreenWantAgent](#maxscreenwantagent) | 否 | 提醒到达时跳转的目标包。如果设备正在使用中，则弹出一个通知框。 |
| maxScreenWantAgent | [MaxScreenWantAgent](#maxscreenwantagent) | 否 | 提醒到达时，全屏显示自动拉起目标的ability信息。如果设备正在使用中，则弹出一个通知框。 <br> 说明：该接口为预留接口，暂不支持使用。|
| ringDuration | number | 否 | 指明响铃时长（单位：秒），默认1秒。 |
| snoozeTimes | number | 否 | 指明延迟提醒次数，默认0次。 |
| timeInterval | number | 否 | 执行延迟提醒间隔（单位：秒），最少5分钟。 |
......@@ -623,8 +622,8 @@ try {
| snoozeContent | string | 否 | 指明延迟提醒时需要显示的内容。 |
| notificationId | number | 否 | 指明提醒使用的通知的id号，相同id号的提醒会覆盖。 |
| slotType | [notification.SlotType](js-apis-notificationManager.md#slottype) | 否 | 指明提醒的slot类型。 |
| tapDismissed<sup>10+</sup> | boolean | 否 | 通知是否自动清除，同[NotificationRequest.tapDismissed](js-apis-inner-notification-notificationRequest.md#notificationrequest)。 |
| autoDeletedTime<sup>10+</sup> | number | 否 | 自动清除的时间，同[NotificationRequest.autoDeletedTime](js-apis-inner-notification-notificationRequest.md#notificationrequest)。 |
| tapDismissed<sup>10+</sup> | boolean | 否 | 通知是否自动清除，具体请参考[NotificationRequest.tapDismissed](js-apis-inner-notification-notificationRequest.md#notificationrequest)。 |
| autoDeletedTime<sup>10+</sup> | number | 否 | 自动清除的时间，具体请参考[NotificationRequest.autoDeletedTime](js-apis-inner-notification-notificationRequest.md#notificationrequest)。 |
## ReminderRequestCalendar
......
zh-cn/application-dev/reference/apis/js-apis-resourceschedule-workScheduler.md
浏览文件 @ 879b98e9
# @ohos.resourceschedule.workScheduler (延迟任务调度)
本模块提供延迟任务注册、取消、查询的能力。
开发者在开发应用时，通过调用延迟任务注册接口，注册对实时性要求不高的延迟任务，该任务默认由系统安排，在系统空闲时根据性能、功耗、热等情况进行调度执行。
本模块提供延迟任务注册、取消、查询的能力。在开发过程中，对于实时性要求不高的任务，可以调用本模块接口注册延迟任务，在系统空闲时根据性能、功耗、热等情况进行调度执行。
> **说明：**
>
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 本模块接口仅可在Stage模型下使用。
> - 延迟任务调度约束见[延迟任务调度约束](../../task-management/work-scheduler.md#约束与限制)。
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> 本模块接口仅可在Stage模型下使用。
## 导入模块
......@@ -18,9 +15,10 @@ import workScheduler from '@ohos.resourceschedule.workScheduler';
```
## workScheduler.startWork
startWork(work: WorkInfo): void
通知WorkSchedulerService将工作添加到执行队列。
申请延迟任务。
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
......@@ -28,11 +26,11 @@ startWork(work: WorkInfo): void
| 参数名 | 类型 | 必填 | 说明 |
| ---- | --------------------- | ---- | -------------- |
| work | [WorkInfo](#workinfo) | 是 | 指示要添加到执行队列的工作。 |
| work | [WorkInfo](#workinfo) | 是 | 要添加到执行队列的延迟任务。 |
**错误码**：
以下错误码的详细介绍请参见[@ohos.resourceschedule.workScheduler (延迟任务调度)](../errorcodes/errorcode-workScheduler.md)错误码。
以下错误码的详细介绍请参见[workScheduler错误码](../errorcodes/errorcode-workScheduler.md)错误码。
| 错误码ID | 错误信息 |
| ---- | --------------------- |
......@@ -42,7 +40,6 @@ startWork(work: WorkInfo): void
| 9700004 | Check workInfo failed. |
| 9700005 | StartWork failed. |
**示例**：
```js
......@@ -69,9 +66,10 @@ startWork(work: WorkInfo): void
```
## workScheduler.stopWork
stopWork(work: WorkInfo, needCancel?: boolean): void
通知WorkSchedulerService停止指定工作。
取消延迟任务。
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
......@@ -79,12 +77,12 @@ stopWork(work: WorkInfo, needCancel?: boolean): void
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------- | ---- | ---------- |
| work | [WorkInfo](#workinfo) | 是 | 指示要停止的工作。 |
| needCancel | boolean | 否 | 是否需要取消的工作，默认为不取消。 |
| work | [WorkInfo](#workinfo) | 是 | 要停止或移除的延迟任务。 |
| needCancel | boolean | 否 | 是否需要移除的任务。<br>- true表示停止并移除，false表示只停止不移除。默认为false。|
**错误码**：
以下错误码的详细介绍请参见[@ohos.resourceschedule.workScheduler (延迟任务调度)](../errorcodes/errorcode-workScheduler.md)错误码。
以下错误码的详细介绍请参见[workScheduler错误码](../errorcodes/errorcode-workScheduler.md)错误码。
| 错误码ID | 错误信息 |
| ---- | --------------------- |
......@@ -119,9 +117,10 @@ stopWork(work: WorkInfo, needCancel?: boolean): void
```
## workScheduler.getWorkStatus
getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void
获取工作的最新状态，使用Callback形式返回。
通过workId获取延迟任务，使用Callback异步回调。
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
......@@ -129,12 +128,12 @@ getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ---------------------------------------- |
| workId | number | 是 | work的id。 |
| callback | AsyncCallback\<[WorkInfo](#workinfo)> | 是 | 指定的callback回调方法。如果指定的工作Id有效，则返回从WorkSchedulerService获取的有效工作状态；否则抛出异常。 |
| workId | number | 是 | 延迟任务Id。 |
| callback | AsyncCallback\<[WorkInfo](#workinfo)> | 是 | 回调函数。如果workId有效，则返回从WorkSchedulerService获取的任务，否则抛出异常。 |
**错误码**：
以下错误码的详细介绍请参见[@ohos.resourceschedule.workScheduler (延迟任务调度)](../errorcodes/errorcode-workScheduler.md)错误码。
以下错误码的详细介绍请参见[workScheduler错误码](../errorcodes/errorcode-workScheduler.md)错误码。
| 错误码ID | 错误信息 |
| ---- | --------------------- |
......@@ -162,9 +161,10 @@ getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void
```
## workScheduler.getWorkStatus
getWorkStatus(workId: number): Promise\<WorkInfo>
获取工作的最新状态，使用Promise形式返回。
通过workId获取延迟任务，使用Promise异步回调。
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
......@@ -172,17 +172,17 @@ getWorkStatus(workId: number): Promise\<WorkInfo>
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------- |
| workId | number | 是 | work的id。 |
| workId | number | 是 | 延迟任务Id。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------- | ---------------------------------------- |
| Promise\<[WorkInfo](#workinfo)> | 指定的Promise回调方法。如果指定的工作ID有效，则返回从WorkSchedulerService获取的有效工作状态；否则抛出异常。 |
| Promise\<[WorkInfo](#workinfo)> | Promise对象，如果workId有效，则返回从WorkSchedulerService获取的任务。 |
**错误码**：
以下错误码的详细介绍请参见[@ohos.resourceschedule.workScheduler (延迟任务调度)](../errorcodes/errorcode-workScheduler.md)错误码。
以下错误码的详细介绍请参见[workScheduler错误码](../errorcodes/errorcode-workScheduler.md)错误码。
| 错误码ID | 错误信息 |
| ---- | --------------------- |
......@@ -208,9 +208,10 @@ getWorkStatus(workId: number): Promise\<WorkInfo>
```
## workScheduler.obtainAllWorks
obtainAllWorks(callback : AsyncCallback\<void>): Array\<WorkInfo>
获取与当前应用程序关联的所有工作，使用Callback形式返回。
获取当前应用所有的延迟任务，使用Callback异步回调。
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
......@@ -218,17 +219,17 @@ obtainAllWorks(callback : AsyncCallback\<void>): Array\<WorkInfo>
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------- |
| callback | AsyncCallback\<void> | 是 | 指定的callback回调方法。返回与应用程序关联的所有工作。 |
| callback | AsyncCallback\<void> | 是 | 回调函数，获取成功时，err为undefined，否则为错误对象。 |
**返回值**：
| 类型 | 说明 |
| ----------------------------- | --------------- |
| Array\<[WorkInfo](#workinfo)> | 返回与应用程序关联的所有工作。 |
| Array\<[WorkInfo](#workinfo)> | 返回当前应用所有的延迟任务。 |
**错误码**：
以下错误码的详细介绍请参见[@ohos.resourceschedule.workScheduler (延迟任务调度)](../errorcodes/errorcode-workScheduler.md)错误码。
以下错误码的详细介绍请参见[workScheduler错误码](../errorcodes/errorcode-workScheduler.md)错误码。
| 错误码ID | 错误信息 |
| ---- | --------------------- |
......@@ -253,9 +254,10 @@ obtainAllWorks(callback : AsyncCallback\<void>): Array\<WorkInfo>
```
## workScheduler.obtainAllWorks
obtainAllWorks(): Promise\<Array\<WorkInfo>>
获取与当前应用程序关联的所有工作，使用Promise形式返回。
获取当前应用所有的延迟任务，使用Promise异步回调。
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
......@@ -263,11 +265,11 @@ obtainAllWorks(): Promise\<Array\<WorkInfo>>
| 类型 | 说明 |
| -------------------------------------- | ------------------------------ |
| Promise<Array\<[WorkInfo](#workinfo)>> | 指定的Promise回调方法。返回与应用程序关联的所有工作。 |
| Promise<Array\<[WorkInfo](#workinfo)>> | Promise对象，返回当前应用所有的延迟任务。 |
**错误码**：
以下错误码的详细介绍请参见[@ohos.resourceschedule.workScheduler (延迟任务调度)](../errorcodes/errorcode-workScheduler.md)错误码。
以下错误码的详细介绍请参见[workScheduler错误码](../errorcodes/errorcode-workScheduler.md)错误码。
| 错误码ID | 错误信息 |
| ---- | --------------------- |
......@@ -290,15 +292,16 @@ obtainAllWorks(): Promise\<Array\<WorkInfo>>
```
## workScheduler.stopAndClearWorks
stopAndClearWorks(): void
停止和取消与当前应用程序关联的所有工作。
停止和取消当前应用所有的延迟任务。
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
**错误码**：
以下错误码的详细介绍请参见[@ohos.resourceschedule.workScheduler (延迟任务调度)](../errorcodes/errorcode-workScheduler.md)错误码。
以下错误码的详细介绍请参见[workScheduler错误码](../errorcodes/errorcode-workScheduler.md)错误码。
| 错误码ID | 错误信息 |
| ---- | --------------------- |
......@@ -318,9 +321,10 @@ stopAndClearWorks(): void
```
## workScheduler.isLastWorkTimeOut
isLastWorkTimeOut(workId: number, callback : AsyncCallback\<void>): boolean
检查指定工作的最后一次执行是否为超时操作，使用Callback形式返回。
检查延迟任务的最后一次执行是否超时，使用Callback异步回调。
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
......@@ -328,18 +332,18 @@ isLastWorkTimeOut(workId: number, callback : AsyncCallback\<void>): boolean
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------------------- |
| workId | number | 是 | work的id。 |
| callback | AsyncCallback\<void> | 是 | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。 |
| workId | number | 是 | 指定延迟任务的Id。 |
| callback | AsyncCallback\<void> | 是 | 回调函数。 |
**返回值**：
| 类型 | 说明 |
| ------- | ---------------------------------------- |
| boolean | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。 |
| boolean | 返回true表示指定任务的最后一次执行超时，false表示未超时。 |
**错误码**：
以下错误码的详细介绍请参见[@ohos.resourceschedule.workScheduler (延迟任务调度)](../errorcodes/errorcode-workScheduler.md)错误码。
以下错误码的详细介绍请参见[workScheduler错误码](../errorcodes/errorcode-workScheduler.md)错误码。
| 错误码ID | 错误信息 |
| ---- | --------------------- |
......@@ -365,9 +369,10 @@ isLastWorkTimeOut(workId: number, callback : AsyncCallback\<void>): boolean
```
## workScheduler.isLastWorkTimeOut
isLastWorkTimeOut(workId: number): Promise\<boolean>
检查指定工作的最后一次执行是否为超时操作，使用Promise形式返回。
检查延迟任务的最后一次执行是否超时，使用Promise形式返回。
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
......@@ -375,17 +380,17 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------- |
| workId | number | 是 | work的id。 |
| workId | number | 是 | 指定延迟任务的Id。 |
**返回值**：
| 类型 | 说明 |
| ----------------- | ---------------------------------------- |
| Promise\<boolean> | 指定的Promise回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。 |
| Promise\<boolean> | Promise对象。返回true表示指定任务的最后一次执行超时，false表示未超时。 |
**错误码**：
以下错误码的详细介绍请参见[@ohos.resourceschedule.workScheduler (延迟任务调度)](../errorcodes/errorcode-workScheduler.md)错误码。
以下错误码的详细介绍请参见[workScheduler错误码](../errorcodes/errorcode-workScheduler.md)错误码。
| 错误码ID | 错误信息 |
| ---- | --------------------- |
......@@ -411,31 +416,33 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
```
## WorkInfo
提供工作的具体信息。WorkInfo设置参数约束见[延迟任务调度约束](../../task-management/work-scheduler.md#约束与限制)
延迟任务的具体信息。
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
| 名称 | 类型 | 必填 | 说明 |
| --------------- | --------------------------------- | ---- | ---------------- |
| workId | number | 是 | 当前工作的ID |
| bundleName | string | 是 | 延迟任务包名 |
| abilityName | string | 是 | 延迟任务回调通知的组件名（必填） |
| networkType | [NetworkType](#networktype) | 否 | 网络类型 |
| isCharging | boolean | 否 | 是否充电 |
| chargerType | [ChargingType](#chargingtype) | 否 | 充电类型 |
| batteryLevel | number | 否 | 电量 |
| batteryStatus | [BatteryStatus](#batterystatus) | 否 | 电池状态 |
| storageRequest | [StorageRequest](#storagerequest) | 否 | 存储状态 |
| isRepeat | boolean | 否 | 是否循环任务 |
| repeatCycleTime | number | 否 | 循环间隔 |
| repeatCount | number | 否 | 循环次数 |
| isPersisted | boolean | 否 | 是否持久化保存工作 |
| isDeepIdle | boolean | 否 | 是否要求设备进入空闲状态 |
| idleWaitTime | number | 否 | 空闲等待时间 |
| parameters | {[key: string]: number \| string \| boolean} | 否 | 携带参数信息 |
| workId | number | 是 | 延迟任务ID。 |
| bundleName | string | 是 | 延迟任务包名。 |
| abilityName | string | 是 | 延迟任务回调通知的组件名。 |
| networkType | [NetworkType](#networktype) | 否 | 网络类型。 |
| isCharging | boolean | 否 | 是否充电。<br>- true表示充电触发延迟回调，false表示不充电触发延迟回调。|
| chargerType | [ChargingType](#chargingtype) | 否 | 充电类型。 |
| batteryLevel | number | 否 | 电量。 |
| batteryStatus | [BatteryStatus](#batterystatus) | 否 | 电池状态。 |
| storageRequest | [StorageRequest](#storagerequest) | 否 | 存储状态。 |
| isRepeat | boolean | 否 | 是否循环任务。<br>- true表示循环任务，false表示非循环任务。 |
| repeatCycleTime | number | 否 | 循环间隔。 |
| repeatCount | number | 否 | 循环次数。 |
| isPersisted | boolean | 否 | 是否持久化保存工作。<br>- true表示持久化保存工作。false表示非持久化保存工作。|
| isDeepIdle | boolean | 否 | 是否要求设备进入空闲状态。<br>- true表示需要，false表示不需要。 |
| idleWaitTime | number | 否 | 空闲等待时间。 |
| parameters | [key: string]: number \| string \| boolean | 否 | 携带参数信息。 |
## NetworkType
触发工作的网络类型。
触发延迟回调的网络类型。
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
......@@ -449,7 +456,8 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
| NETWORK_TYPE_ETHERNET | 5 | 表示这个触发条件是有线网络连接。 |
## ChargingType
触发工作的充电类型。
触发延迟回调的充电类型。
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
......@@ -461,7 +469,8 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
| CHARGING_PLUGGED_WIRELESS | 3 | 表示这个触发条件是无线充电器连接。 |
## BatteryStatus
触发工作的电池状态。
触发延迟回调的电池状态。
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
......@@ -472,7 +481,8 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
| BATTERY_STATUS_LOW_OR_OKAY | 2 | 表示这个触发条件是从低电恢复到正常电量或者低电告警。 |
## StorageRequest
触发工作的存储状态。
触发延迟回调的存储状态。
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
......@@ -480,4 +490,4 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
| ------------------------- | ---- | ------------------------------ |
| STORAGE_LEVEL_LOW | 0 | 表示这个触发条件是存储空间不足。 |
| STORAGE_LEVEL_OKAY | 1 | 表示这个触发条件是从存储空间不足恢复到正常。 |
| STORAGE_LEVEL_LOW_OR_OKAY | 2 | 表示这个触发条件是从存储空间不足恢复到正常或者存储空间不足。 |
\ No newline at end of file
| 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.
先完成此消息的编辑！
想要评论请 注册 或