未验证 提交 6fbc6cfd 编写于 作者: 朱天怡 提交者: Gitee

修改

Signed-off-by: N朱天怡 <zhutianyi2@huawei.com>
上级 53f85004
...@@ -33,12 +33,14 @@ requestSuspendDelay(reason: string, callback: Callback&lt;void&gt;): DelaySuspen ...@@ -33,12 +33,14 @@ requestSuspendDelay(reason: string, callback: Callback&lt;void&gt;): DelaySuspen
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------ | | -------- | -------------------- | ---- | ------------------------------ |
| reason | string | 是 | 延迟挂起申请的原因。 | | reason | string | 是 | 延迟挂起申请的原因。 |
| callback | Callback&lt;void&gt; | 是 | 延迟即将超时的回调函数,一般在超时前6秒通过此回调通知应用。 | | callback | Callback&lt;void&gt; | 是 | 延迟即将超时的回调函数,一般在超时前6秒通过此回调通知应用。 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------- | --------- | | ------------------------------------- | --------- |
| [DelaySuspendInfo](#delaysuspendinfo) | 返回延迟挂起信息。 | | [DelaySuspendInfo](#delaysuspendinfo) | 返回延迟挂起信息。 |
...@@ -69,6 +71,7 @@ getRemainingDelayTime(requestId: number, callback: AsyncCallback&lt;number&gt;): ...@@ -69,6 +71,7 @@ getRemainingDelayTime(requestId: number, callback: AsyncCallback&lt;number&gt;):
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------------- | ---- | ---------------------------------------- | | --------- | --------------------------- | ---- | ---------------------------------------- |
| requestId | number | 是 | 延迟挂起的请求ID。这个值通过调用[requestSuspendDelay](#backgroundtaskmanagerrequestsuspenddelay)方法获取。 | | requestId | number | 是 | 延迟挂起的请求ID。这个值通过调用[requestSuspendDelay](#backgroundtaskmanagerrequestsuspenddelay)方法获取。 |
...@@ -99,16 +102,19 @@ getRemainingDelayTime(requestId: number): Promise&lt;number&gt; ...@@ -99,16 +102,19 @@ getRemainingDelayTime(requestId: number): Promise&lt;number&gt;
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------- | | --------- | ------ | ---- | ---------- |
| requestId | number | 是 | 延迟挂起的请求ID。这个值通过调用[requestSuspendDelay](#backgroundtaskmanagerrequestsuspenddelay)方法获取。 | | requestId | number | 是 | 延迟挂起的请求ID。这个值通过调用[requestSuspendDelay](#backgroundtaskmanagerrequestsuspenddelay)方法获取。 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ---------------------------------------- | | --------------------- | ---------------------------------------- |
| Promise&lt;number&gt; | 指定的Promise回调方法。返回应用程序进入挂起状态之前的剩余时间,以毫秒为单位。 | | Promise&lt;number&gt; | 指定的Promise回调方法。返回应用程序进入挂起状态之前的剩余时间,以毫秒为单位。 |
**示例** **示例**
```js ```js
let delayInfo = backgroundTaskManager.requestSuspendDelay("test", () => {}); let delayInfo = backgroundTaskManager.requestSuspendDelay("test", () => {});
backgroundTaskManager.getRemainingDelayTime(delayInfo.requestId).then( res => { backgroundTaskManager.getRemainingDelayTime(delayInfo.requestId).then( res => {
...@@ -128,11 +134,13 @@ cancelSuspendDelay(requestId: number): void ...@@ -128,11 +134,13 @@ cancelSuspendDelay(requestId: number): void
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------- | | --------- | ------ | ---- | ---------- |
| requestId | number | 是 | 延迟挂起的请求ID。这个值通过调用[requestSuspendDelay](#backgroundtaskmanagerrequestsuspenddelay)方法获取。 | | requestId | number | 是 | 延迟挂起的请求ID。这个值通过调用[requestSuspendDelay](#backgroundtaskmanagerrequestsuspenddelay)方法获取。 |
**示例** **示例**
```js ```js
let delayInfo = backgroundTaskManager.requestSuspendDelay("test", () => {}); let delayInfo = backgroundTaskManager.requestSuspendDelay("test", () => {});
backgroundTaskManager.cancelSuspendDelay(delayInfo.requestId); backgroundTaskManager.cancelSuspendDelay(delayInfo.requestId);
...@@ -150,6 +158,7 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want ...@@ -150,6 +158,7 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------- | ---- | ---------------------------------------- | | --------- | ---------------------------------- | ---- | ---------------------------------------- |
| context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | | context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
...@@ -249,6 +258,7 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want ...@@ -249,6 +258,7 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
| wantAgent | [WantAgent](js-apis-wantAgent.md) | 是 | 通知参数,用于指定长时任务通知点击跳转的界面。 | | wantAgent | [WantAgent](js-apis-wantAgent.md) | 是 | 通知参数,用于指定长时任务通知点击跳转的界面。 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ---------------- | | -------------- | ---------------- |
| Promise\<void> | 使用Promise形式返回结果。 | | Promise\<void> | 使用Promise形式返回结果。 |
...@@ -326,6 +336,7 @@ stopBackgroundRunning(context: Context, callback: AsyncCallback&lt;void&gt;): vo ...@@ -326,6 +336,7 @@ stopBackgroundRunning(context: Context, callback: AsyncCallback&lt;void&gt;): vo
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------- | | -------- | ------------------------- | ---- | ---------------------------------------- |
| context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | | context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
...@@ -381,11 +392,13 @@ stopBackgroundRunning(context: Context): Promise&lt;void&gt; ...@@ -381,11 +392,13 @@ stopBackgroundRunning(context: Context): Promise&lt;void&gt;
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ---------------------------------------- | | ------- | ------- | ---- | ---------------------------------------- |
| context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | | context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ---------------- | | -------------- | ---------------- |
| Promise\<void> | 使用Promise形式返回结果。 | | Promise\<void> | 使用Promise形式返回结果。 |
......
...@@ -11,7 +11,7 @@ ...@@ -11,7 +11,7 @@
对于系统特权应用,提供独立的能效资源申请接口。系统特权应用如果需要使用特定的系统资源,例如在被挂起期间仍然能够收到系统公共事件,可以使用能效资源申请接口。 对于系统特权应用,提供独立的能效资源申请接口。系统特权应用如果需要使用特定的系统资源,例如在被挂起期间仍然能够收到系统公共事件,可以使用能效资源申请接口。
> **说明:** > **说明:**
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。从API version 9开始,导入模块由@ohos.backgroundTaskManager迁移至@ohos.resourceschedule.backgroundTaskManager > - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
...@@ -20,7 +20,7 @@ ...@@ -20,7 +20,7 @@
import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager'; import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';
``` ```
## backgroundTaskManager.requestSuspendDelay<sup>9+</sup> ## backgroundTaskManager.requestSuspendDelay<sup>9</sup>
requestSuspendDelay(reason: string, callback: Callback&lt;void&gt;): DelaySuspendInfo requestSuspendDelay(reason: string, callback: Callback&lt;void&gt;): DelaySuspendInfo
...@@ -28,17 +28,17 @@ requestSuspendDelay(reason: string, callback: Callback&lt;void&gt;): DelaySuspen ...@@ -28,17 +28,17 @@ requestSuspendDelay(reason: string, callback: Callback&lt;void&gt;): DelaySuspen
延迟挂起时间一般情况下默认值为180000,低电量(依据系统低电量广播)时默认值为60000。 延迟挂起时间一般情况下默认值为180000,低电量(依据系统低电量广播)时默认值为60000。
> 从 API version 9开始支持。
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------ | | -------- | -------------------- | ---- | ------------------------------ |
| reason | string | 是 | 延迟挂起申请的原因。 | | reason | string | 是 | 延迟挂起申请的原因。 |
| callback | Callback&lt;void&gt; | 是 | 延迟即将超时的回调函数,一般在超时前6秒通过此回调通知应用。 | | callback | Callback&lt;void&gt; | 是 | 延迟即将超时的回调函数,一般在超时前6秒通过此回调通知应用。 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------- | --------- | | ------------------------------------- | --------- |
| [DelaySuspendInfo](#delaysuspendinfo) | 返回延迟挂起信息。 | | [DelaySuspendInfo](#delaysuspendinfo) | 返回延迟挂起信息。 |
...@@ -76,17 +76,16 @@ requestSuspendDelay(reason: string, callback: Callback&lt;void&gt;): DelaySuspen ...@@ -76,17 +76,16 @@ requestSuspendDelay(reason: string, callback: Callback&lt;void&gt;): DelaySuspen
``` ```
## backgroundTaskManager.getRemainingDelayTime:callback<sup>9+</sup> ## backgroundTaskManager.getRemainingDelayTime:callback<sup>9</sup>
getRemainingDelayTime(requestId: number, callback: AsyncCallback&lt;number&gt;): void getRemainingDelayTime(requestId: number, callback: AsyncCallback&lt;number&gt;): void
获取应用程序进入挂起状态前的剩余时间,使用callback形式返回。 获取应用程序进入挂起状态前的剩余时间,使用callback形式返回。
> 从 API version 9开始支持。
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------------- | ---- | ---------------------------------------- | | --------- | --------------------------- | ---- | ---------------------------------------- |
| requestId | number | 是 | 延迟挂起的请求ID。 | | requestId | number | 是 | 延迟挂起的请求ID。 |
...@@ -126,22 +125,24 @@ getRemainingDelayTime(requestId: number, callback: AsyncCallback&lt;number&gt;): ...@@ -126,22 +125,24 @@ getRemainingDelayTime(requestId: number, callback: AsyncCallback&lt;number&gt;):
``` ```
## backgroundTaskManager.getRemainingDelayTime:promise<sup>9+</sup> ## backgroundTaskManager.getRemainingDelayTime:promise<sup>9</sup>
getRemainingDelayTime(requestId: number): Promise&lt;number&gt; getRemainingDelayTime(requestId: number): Promise&lt;number&gt;
获取应用程序进入挂起状态前的剩余时间,使用Promise形式返回。 获取应用程序进入挂起状态前的剩余时间,使用Promise形式返回。
> 从 API version 9开始支持。
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------- | | --------- | ------ | ---- | ---------- |
| requestId | number | 是 | 延迟挂起的请求ID。 | | requestId | number | 是 | 延迟挂起的请求ID。 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ---------------------------------------- | | --------------------- | ---------------------------------------- |
| Promise&lt;number&gt; | 指定的Promise回调方法。返回应用程序进入挂起状态之前的剩余时间,以毫秒为单位。 | | Promise&lt;number&gt; | 指定的Promise回调方法。返回应用程序进入挂起状态之前的剩余时间,以毫秒为单位。 |
...@@ -160,6 +161,7 @@ getRemainingDelayTime(requestId: number): Promise&lt;number&gt; ...@@ -160,6 +161,7 @@ getRemainingDelayTime(requestId: number): Promise&lt;number&gt;
| 9900002 | Background task verification failed. | | 9900002 | Background task verification failed. |
**示例** **示例**
```js ```js
import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager'; import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';
...@@ -176,17 +178,16 @@ getRemainingDelayTime(requestId: number): Promise&lt;number&gt; ...@@ -176,17 +178,16 @@ getRemainingDelayTime(requestId: number): Promise&lt;number&gt;
``` ```
## backgroundTaskManager.cancelSuspendDelay<sup>9+</sup> ## backgroundTaskManager.cancelSuspendDelay<sup>9</sup>
cancelSuspendDelay(requestId: number): void cancelSuspendDelay(requestId: number): void
取消延迟挂起。 取消延迟挂起。
> 从 API version 9开始支持。
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------- | | --------- | ------ | ---- | ---------- |
| requestId | number | 是 | 延迟挂起的请求ID。 | | requestId | number | 是 | 延迟挂起的请求ID。 |
...@@ -205,6 +206,7 @@ cancelSuspendDelay(requestId: number): void ...@@ -205,6 +206,7 @@ cancelSuspendDelay(requestId: number): void
| 9900002 | Background task verification failed. | | 9900002 | Background task verification failed. |
**示例** **示例**
```js ```js
import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager'; import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';
...@@ -217,19 +219,18 @@ cancelSuspendDelay(requestId: number): void ...@@ -217,19 +219,18 @@ cancelSuspendDelay(requestId: number): void
``` ```
## backgroundTaskManager.startBackgroundRunning:callback<sup>9+</sup> ## backgroundTaskManager.startBackgroundRunning:callback<sup>9</sup>
startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent, callback: AsyncCallback&lt;void&gt;): void startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent, callback: AsyncCallback&lt;void&gt;): void
向系统申请长时任务,使用callback形式返回结果。 向系统申请长时任务,使用callback形式返回结果。
> 从 API version 9开始支持。
**需要权限:** ohos.permission.KEEP_BACKGROUND_RUNNING **需要权限:** ohos.permission.KEEP_BACKGROUND_RUNNING
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------- | ---- | ---------------------------------------- | | --------- | ---------------------------------- | ---- | ---------------------------------------- |
| context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | | context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
...@@ -252,6 +253,7 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want ...@@ -252,6 +253,7 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
| 9800007 | Task storage failed. | | 9800007 | Task storage failed. |
**示例** **示例**
```js ```js
import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager'; import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
...@@ -288,14 +290,12 @@ wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { ...@@ -288,14 +290,12 @@ wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
``` ```
## backgroundTaskManager.startBackgroundRunning:promise<sup>9+</sup> ## backgroundTaskManager.startBackgroundRunning:promise<sup>9</sup>
startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent): Promise&lt;void&gt; startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent): Promise&lt;void&gt;
向系统申请长时任务,使用promise形式返回结果。 向系统申请长时任务,使用promise形式返回结果。
> 从 API version 9开始支持。
**需要权限:** ohos.permission.KEEP_BACKGROUND_RUNNING **需要权限:** ohos.permission.KEEP_BACKGROUND_RUNNING
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
...@@ -309,11 +309,11 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want ...@@ -309,11 +309,11 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
| wantAgent | [WantAgent](js-apis-wantAgent.md) | 是 | 通知参数,用于指定长时任务通知点击跳转的界面。 | | wantAgent | [WantAgent](js-apis-wantAgent.md) | 是 | 通知参数,用于指定长时任务通知点击跳转的界面。 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ---------------- | | -------------- | ---------------- |
| Promise\<void> | 使用Promise形式返回结果。 | | Promise\<void> | 使用Promise形式返回结果。 |
**错误码** **错误码**
以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errcode-backgroundTaskMgr.md)错误码。 以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errcode-backgroundTaskMgr.md)错误码。
...@@ -329,6 +329,7 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want ...@@ -329,6 +329,7 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
| 9800007 | Task storage failed. | | 9800007 | Task storage failed. |
**示例** **示例**
```js ```js
import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager'; import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
...@@ -361,23 +362,21 @@ wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { ...@@ -361,23 +362,21 @@ wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
``` ```
## backgroundTaskManager.stopBackgroundRunning:callback<sup>9+</sup> ## backgroundTaskManager.stopBackgroundRunning:callback<sup>9</sup>
stopBackgroundRunning(context: Context, callback: AsyncCallback&lt;void&gt;): void stopBackgroundRunning(context: Context, callback: AsyncCallback&lt;void&gt;): void
向系统申请取消长时任务,使用callback形式返回结果。 向系统申请取消长时任务,使用callback形式返回结果。
> 从 API version 9开始支持。
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------- | | -------- | ------------------------- | ---- | ---------------------------------------- |
| context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | | context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动长时任务的结果。 | | callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动长时任务的结果。 |
**错误码** **错误码**
以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errcode-backgroundTaskMgr.md)错误码。 以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errcode-backgroundTaskMgr.md)错误码。
...@@ -393,6 +392,7 @@ stopBackgroundRunning(context: Context, callback: AsyncCallback&lt;void&gt;): vo ...@@ -393,6 +392,7 @@ stopBackgroundRunning(context: Context, callback: AsyncCallback&lt;void&gt;): vo
| 9800007 | Task storage failed. | | 9800007 | Task storage failed. |
**示例** **示例**
```js ```js
import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager'; import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
...@@ -413,27 +413,28 @@ try { ...@@ -413,27 +413,28 @@ try {
``` ```
## backgroundTaskManager.stopBackgroundRunning:promise<sup>9+</sup> ## backgroundTaskManager.stopBackgroundRunning:promise<sup>9</sup>
stopBackgroundRunning(context: Context): Promise&lt;void&gt; stopBackgroundRunning(context: Context): Promise&lt;void&gt;
向系统申请取消长时任务,使用promise形式返回结果。 向系统申请取消长时任务,使用promise形式返回结果。
> 从 API version 9开始支持。
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ---------------------------------------- | | ------- | ------- | ---- | ---------------------------------------- |
| context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | | context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ---------------- | | -------------- | ---------------- |
| Promise\<void> | 使用Promise形式返回结果。 | | Promise\<void> | 使用Promise形式返回结果。 |
**错误码** **错误码**
以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errcode-backgroundTaskMgr.md)错误码。 以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errcode-backgroundTaskMgr.md)错误码。
...@@ -449,6 +450,7 @@ stopBackgroundRunning(context: Context): Promise&lt;void&gt; ...@@ -449,6 +450,7 @@ stopBackgroundRunning(context: Context): Promise&lt;void&gt;
| 9800007 | Task storage failed. | | 9800007 | Task storage failed. |
**示例** **示例**
```js ```js
import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager'; import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
...@@ -465,15 +467,13 @@ try { ...@@ -465,15 +467,13 @@ try {
``` ```
## backgroundTaskManager.applyEfficiencyResources<sup>9+</sup> ## backgroundTaskManager.applyEfficiencyResources<sup>9</sup>
applyEfficiencyResources(request: [EfficiencyResourcesRequest](#efficiencyresourcesrequest9)): void applyEfficiencyResources(request: [EfficiencyResourcesRequest](#efficiencyresourcesrequest9)): void
向系统申请能效资源,使用boolean形式返回结果 向系统申请能效资源。
进程和它所属的应用可以同时申请某一类资源,例如CPU资源,但是应用释放资源的时候会将进程的资源一起释放。 进程和它所属的应用可以同时申请某一类资源,例如CPU资源,但是应用释放资源的时候会将进程的资源一起释放。
> 从 API version 9开始支持。
**系统能力**: SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply **系统能力**: SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
**系统API**: 此接口为系统接口。 **系统API**: 此接口为系统接口。
...@@ -518,14 +518,12 @@ try { ...@@ -518,14 +518,12 @@ try {
} }
``` ```
## backgroundTaskManager.resetAllEfficiencyResources<sup>9+</sup> ## backgroundTaskManager.resetAllEfficiencyResources<sup>9</sup>
resetAllEfficiencyResources(): void resetAllEfficiencyResources(): void
释放所有已经申请的资源。 释放所有已经申请的资源。
> 从 API version 9开始支持。
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
**系统API**: 此接口为系统接口。 **系统API**: 此接口为系统接口。
...@@ -554,7 +552,7 @@ try { ...@@ -554,7 +552,7 @@ try {
} }
``` ```
## DelaySuspendInfo<sup>9+</sup> ## DelaySuspendInfo<sup>9</sup>
延迟挂起信息。 延迟挂起信息。
...@@ -566,7 +564,7 @@ try { ...@@ -566,7 +564,7 @@ try {
| actualDelayTime | number | 是 | 应用的实际挂起延迟时间,以毫秒为单位。<br/>一般情况下默认值为180000,低电量(依据系统低电量广播)时默认值为60000。 | | actualDelayTime | number | 是 | 应用的实际挂起延迟时间,以毫秒为单位。<br/>一般情况下默认值为180000,低电量(依据系统低电量广播)时默认值为60000。 |
## BackgroundMode<sup>9+</sup> ## BackgroundMode<sup>9</sup>
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
...@@ -582,7 +580,7 @@ try { ...@@ -582,7 +580,7 @@ try {
| VOIP | 8 | 音视频通话<br />此接口为系统接口。 | | VOIP | 8 | 音视频通话<br />此接口为系统接口。 |
| TASK_KEEPING | 9 | 计算任务(仅在特定设备生效)。 | | TASK_KEEPING | 9 | 计算任务(仅在特定设备生效)。 |
## EfficiencyResourcesRequest<sup>9+</sup> ## EfficiencyResourcesRequest<sup>9</sup>
能效资源申请参数。 能效资源申请参数。
...@@ -599,7 +597,7 @@ try { ...@@ -599,7 +597,7 @@ try {
| isProcess | boolean | 否 | 应用申请或者是进程申请。 | | isProcess | boolean | 否 | 应用申请或者是进程申请。 |
| reason | string | 是 | 申请资源的原因。 | | reason | string | 是 | 申请资源的原因。 |
## ResourceType<sup>9+</sup> ## ResourceType<sup>9</sup>
能效资源类型。 能效资源类型。
......
...@@ -2,64 +2,79 @@ ...@@ -2,64 +2,79 @@
## 9800001 内存操作失败 ## 9800001 内存操作失败
### 错误信息 **错误信息**
Memory operation failed. Memory operation failed.
### 可能原因 **可能原因**
1. 系统内存泄漏。 1. 系统内存泄漏。
2. 系统内存不足。 2. 系统内存不足。
### 处理步骤 **处理步骤**
1. 内存不足,请释放内存。 1. 内存不足,请释放内存。
2. 请检查是否内存泄漏。 2. 请检查是否内存泄漏。
## 9800002 Parcel读写操作失败 ## 9800002 Parcel读写操作失败
### 错误信息 **错误信息**
Parcel operation failed. Parcel operation failed.
### 可能原因 **可能原因**
1. 调用MessageParcel对象读取或写入对象异常 1. 调用MessageParcel对象读取或写入对象异常
### 处理步骤 **处理步骤**
系统内部工作异常,请稍候重试,或者重启设备尝试。 系统内部工作异常,请稍候重试,或者重启设备尝试。
## 9800003 IPC通信失败 ## 9800003 IPC通信失败
### 错误信息 **错误信息**
Inner transact failed. Inner transact failed.
### 可能原因 **可能原因**
1. IPC通信失败 1. IPC通信失败
### 处理步骤 **处理步骤**
系统内部工作异常,请稍候重试,或者重启设备尝试。 系统内部工作异常,请稍候重试,或者重启设备尝试。
## 9800004 系统服务失败 ## 9800004 系统服务失败
### 错误信息 **错误信息**
System service operation failed. System service operation failed.
### 可能原因 **可能原因**
1. 系统服务还未启动 1. 系统服务还未启动
2. 系统服务异常 2. 系统服务异常
### 处理步骤 **处理步骤**
系统服务内部工作异常,请稍候重试,或者重启设备尝试。 系统服务内部工作异常,请稍候重试,或者重启设备尝试。
## 9800005 长时任务校验失败 ## 9800005 长时任务校验失败
### 错误信息 **错误信息**
Background task verification failed. Background task verification failed.
### 可能原因 **可能原因**
1. 应用重复申请长时任务。 1. 应用重复申请长时任务。
2. 应用重复取消长时任务。 2. 应用重复取消长时任务。
3. bgMode无效,应用配置文件属性backgroundModes没有配置任何长时任务类型。 3. bgMode无效,应用配置文件属性backgroundModes没有配置任何长时任务类型。
4. 只有PC设备才能申请长时任务KEEPING_TASK。 4. 只有PC设备才能申请长时任务KEEPING_TASK。
5. 只有系统应用才能申请长时任务WIFI_INTERACTION或VOIP。 5. 只有系统应用才能申请长时任务WIFI_INTERACTION或VOIP。
### 处理步骤 **处理步骤**
1. 请检查应用代码。 1. 请检查应用代码。
2. 请检查应用是否拥有系统权限。 2. 请检查应用是否拥有系统权限。
3. 请检查应用所在设备类型。 3. 请检查应用所在设备类型。
...@@ -67,70 +82,85 @@ Background task verification failed. ...@@ -67,70 +82,85 @@ Background task verification failed.
## 9800006 长时任务通知信息校验失败 ## 9800006 长时任务通知信息校验失败
### 错误信息 **错误信息**
Notification verification failed. Notification verification failed.
### 可能原因 **可能原因**
1. 缓存在资源子系统的长时任务通知信息资源加载失败。 1. 缓存在资源子系统的长时任务通知信息资源加载失败。
2. 通知子系统服务异常。 2. 通知子系统服务异常。
### 处理步骤 **处理步骤**
1. 请检查系统长时任务资源"ohos.backgroundtaskmgr.resources"是否存在。 1. 请检查系统长时任务资源"ohos.backgroundtaskmgr.resources"是否存在。
2. 系统服务内部工作异常,请稍候重试,或者重启设备尝试。 2. 系统服务内部工作异常,请稍候重试,或者重启设备尝试。
## 9800007 长时任务信息存储失败 ## 9800007 长时任务信息存储失败
### 错误信息 **错误信息**
Task storage failed. Task storage failed.
### 可能原因 **可能原因**
1. 创建存储任务文件失败。 1. 创建存储任务文件失败。
2. 获取真实文件路径失败。 2. 获取真实文件路径失败。
3. 打开存储任务文件失败。 3. 打开存储任务文件失败。
### 处理步骤 **处理步骤**
1. 请检查文件/data/service/el1/public/background_task_mgr/running_task。 1. 请检查文件/data/service/el1/public/background_task_mgr/running_task。
2. 系统内部工作异常,请稍候重试,或者重启设备尝试。 2. 系统内部工作异常,请稍候重试,或者重启设备尝试。
## 9900001 短时任务调用方信息校验失败 ## 9900001 短时任务调用方信息校验失败
### 错误信息 **错误信息**
Caller information verification failed. Caller information verification failed.
### 可能原因 **可能原因**
1. 获取调用方的uid或pid错误。 1. 获取调用方的uid或pid错误。
2. 获取调用方的bundleName错误。 2. 获取调用方的bundleName错误。
3. 取消短时任务时传入的requestId无效,在申请短时任务的列表中找不到对应的requestId。 3. 取消短时任务时传入的requestId无效,在申请短时任务的列表中找不到对应的requestId。
### 处理步骤 **处理步骤**
1. 请检查应用uid是否存在。 1. 请检查应用uid是否存在。
2. 请检查应用是否申请了短时任务。 2. 请检查应用是否申请了短时任务。
3. 系统服务内部工作异常,请稍候重试,或者重启设备尝试。 3. 系统服务内部工作异常,请稍候重试,或者重启设备尝试。
## 9900002 短时任务校验失败 ## 9900002 短时任务校验失败
### 错误信息 **错误信息**
Background task verification failed. Background task verification failed.
### 可能原因 **可能原因**
1. requestSuspendDelay()方法传递的callback对象已存在。 1. requestSuspendDelay()方法传递的callback对象已存在。
2. cancelSuspendDelay()方法传递的callback对象不存在。 2. cancelSuspendDelay()方法传递的callback对象不存在。
3. 应用退入后台后5s内允许申请短时任务。 3. 应用退入后台后5s内允许申请短时任务。
4. 应用申请短时任务数量不能超过3个。 4. 应用申请短时任务数量不能超过3个。
5. 应用申请短时任务每日剩余配额不足。 5. 应用申请短时任务每日剩余配额不足。
### 处理步骤 **处理步骤**
1. 请检查应用自身代码逻辑。 1. 请检查应用自身代码逻辑。
2. 应用运行短时任务完毕及时释放。 2. 应用运行短时任务完毕及时释放。
## 18700001 资源申请接口信息校验失败 ## 18700001 资源申请接口信息校验失败
### 错误信息 **错误信息**
Caller information verification failed. Caller information verification failed.
### 可能原因 **可能原因**
1. 获取调用方的uid或pid错误。 1. 获取调用方的uid或pid错误。
2. 申请资源的resourceTypes超过上限。 2. 申请资源的resourceTypes超过上限。
### 处理步骤 **处理步骤**
1. 请检查输入的参数。 1. 请检查输入的参数。
\ No newline at end of file
...@@ -2,62 +2,77 @@ ...@@ -2,62 +2,77 @@
## 9700001 内存操作失败 ## 9700001 内存操作失败
### 错误信息 **错误信息**
Memory operation failed. Memory operation failed.
### 可能原因 **可能原因**
1. 系统内存泄漏。 1. 系统内存泄漏。
2. 系统内存不足。 2. 系统内存不足。
### 处理步骤 **处理步骤**
1. 内存不足,请释放内存。 1. 内存不足,请释放内存。
2. 请检查是否内存泄漏。 2. 请检查是否内存泄漏。
## 9700002 Parcel读写操作失败 ## 9700002 Parcel读写操作失败
### 错误信息 **错误信息**
Parcel operation failed. Parcel operation failed.
### 可能原因 **可能原因**
1. 调用MessageParcel对象读取或写入对象异常
调用MessageParcel对象读取或写入对象异常
**处理步骤**
### 处理步骤
系统内部工作异常,请稍候重试,或者重启设备尝试。 系统内部工作异常,请稍候重试,或者重启设备尝试。
## 9700003 系统服务失败 ## 9700003 系统服务失败
### 错误信息 **错误信息**
System service operation failed. System service operation failed.
### 可能原因 **可能原因**
1. 系统服务还未启动 1. 系统服务还未启动
2. 系统服务异常 2. 系统服务异常
### 处理步骤 **处理步骤**
系统服务内部工作异常,请稍候重试,或者重启设备尝试。 系统服务内部工作异常,请稍候重试,或者重启设备尝试。
## 9700004 workInfo校验失败 ## 9700004 workInfo校验失败
### 错误信息 **错误信息**
Check workInfo failed. Check workInfo failed.
### 可能原因 **可能原因**
1. workInfo中的bundleName和应用的uid不匹配。 1. workInfo中的bundleName和应用的uid不匹配。
2. 取消或查询延迟任务时,延迟任务不存在。 2. 取消或查询延迟任务时,延迟任务不存在。
### 处理步骤 **处理步骤**
1. 请检查workInfo参数。
请检查workInfo参数。
## 9700005 StartWork失败 ## 9700005 StartWork失败
### 错误信息 **错误信息**
StartWork failed. StartWork failed.
### 可能原因 **可能原因**
1. 延迟任务已存在。 1. 延迟任务已存在。
2. 每个应用uid最多添加10个延迟任务。 2. 每个应用uid最多添加10个延迟任务。
3. 重复任务设置的重复时间应至少为20分钟。 3. 重复任务设置的重复时间应至少为20分钟。
### 处理步骤 **处理步骤**
1. 请检查输入的参数。
请检查输入的参数和代码逻辑。
...@@ -13,8 +13,6 @@ ohos.permission.KEEP_BACKGROUND_RUNNING ...@@ -13,8 +13,6 @@ ohos.permission.KEEP_BACKGROUND_RUNNING
**表2** 长时任务主要接口 **表2** 长时任务主要接口
> **说明:** 后台任务管理错误码见[backgroundTaskManager错误码](../errorcodes/errorcode-backgroundTaskMgr.md)。
| 接口名 | 描述 | | 接口名 | 描述 |
| ---------------------------------------- | ---------------------------- | | ---------------------------------------- | ---------------------------- |
| startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent): Promise&lt;void&gt; | 服务启动后,向系统申请长时任务,使服务一直保持后台运行。 | | startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent): Promise&lt;void&gt; | 服务启动后,向系统申请长时任务,使服务一直保持后台运行。 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册