js-apis-backgroundTaskManager.md 25.5 KB
Newer Older
廖康康 已提交
1 2
# 后台任务管理

廖康康 已提交
3
本模块提供后台任务管理能力。
廖康康 已提交
4

廖康康 已提交
5 6
当应用或业务模块处于后台(无可见界面)时,如果有需要继续执行或者后续执行的业务,可基于业务类型,申请短时任务延迟挂起(Suspend)或者长时任务避免进入挂起状态。

廖康康 已提交
7
应用有不可中断且短时间能完成的任务时(如,用户在文件管理器上点击垃圾文件清理,若清理未完成时退到后台,文件管理器需要申请短时任务完成清理),可以使用短时任务机制。
廖康康 已提交
8 9

应用中存在用户能够直观感受到的且需要一直在后台运行的业务时(如,后台播放音乐),可以使用长时任务机制。
廖康康 已提交
10

Z
zhangxin_T 已提交
11
对于系统特权应用,提供独立的能效资源申请接口。系统特权应用如果需要使用特定的系统资源,例如需要在被挂起期间仍然能够收到系统公共事件,可以使用能效资源申请接口。
Z
Zhao-PengFei35 已提交
12

H
HelloCrease 已提交
13
>  **说明:**
修改  
朱天怡 已提交
14
> - 从API Version 9 开始,该接口不再维护,推荐使用新接口[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](js-apis-resourceschedule-backgroundTaskManager.md)
修改  
朱天怡 已提交
15 16
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。从API version 9开始,导入模块由@ohos.backgroundTaskManager迁移至@ohos.resourceschedule.backgroundTaskManager
> - 后台任务管理错误码见[backgroundTaskManager错误码](../errorcodes/errorcode-backgroundTaskMgr.md)。
廖康康 已提交
17

修改  
朱天怡 已提交
18

修改  
朱天怡 已提交
19 20 21
## 导入模块

```js
修改  
朱天怡 已提交
22
import backgroundTaskManager from '@ohos.backgroundTaskManager';  
廖康康 已提交
23 24
```

修改  
朱天怡 已提交
25

26
## backgroundTaskManager.requestSuspendDelay<sup>7+(deprecated)</sup>
廖康康 已提交
27 28 29 30 31

requestSuspendDelay(reason: string, callback: Callback&lt;void&gt;): DelaySuspendInfo

后台应用申请延迟挂起。

Z
zhangxin_T 已提交
32
延迟挂起时间一般情况下默认值为180000毫秒,低电量(依据系统低电量广播)时默认值为60000毫秒。
廖康康 已提交
33

bugfix  
朱天怡 已提交
34
> **说明:** 从API version 9开始废弃,建议使用[backgroundTaskManager.requestSuspendDelay](./js-apis-resourceschedule-backgroundTaskManager.md/#backgroundtaskmanagerrequestsuspenddelay9)
修改  
朱天怡 已提交
35 36
>
> 从 API version 7开始支持。
修改  
朱天怡 已提交
37

Z
zhangxin_T 已提交
38 39
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask

Z
zhangxin_T 已提交
40
**参数**
H
HelloCrease 已提交
41 42 43 44
| 参数名      | 类型                   | 必填   | 说明                             |
| -------- | -------------------- | ---- | ------------------------------ |
| reason   | string               | 是    | 延迟挂起申请的原因。                     |
| callback | Callback&lt;void&gt; | 是    | 延迟即将超时的回调函数,一般在超时前6秒通过此回调通知应用。 |
廖康康 已提交
45

Z
zhangxin_T 已提交
46
**返回值**
H
HelloCrease 已提交
47 48 49
| 类型                                    | 说明        |
| ------------------------------------- | --------- |
| [DelaySuspendInfo](#delaysuspendinfo) | 返回延迟挂起信息。 |
廖康康 已提交
50

Z
zhangxin_T 已提交
51
**示例**
W
wangqing 已提交
52

Z
zhangxin_T 已提交
53
  ```js
修改  
朱天怡 已提交
54
  import backgroundTaskManager from '@ohos.backgroundTaskManager';
修改  
朱天怡 已提交
55

廖康康 已提交
56
  let myReason = 'test requestSuspendDelay';
修改  
朱天怡 已提交
57 58 59
  let delayInfo = backgroundTaskManager.requestSuspendDelay(myReason, () => {
      console.info("Request suspension delay will time out.");
  })
Z
zhangxin_T 已提交
60 61 62

  let id = delayInfo.requestId;
  let time = delayInfo.actualDelayTime;
修改  
朱天怡 已提交
63 64
  console.info("The requestId is: " + id);
  console.info("The actualDelayTime is: " + time);
廖康康 已提交
65 66 67
  ```


修改  
朱天怡 已提交
68
## backgroundTaskManager.getRemainingDelayTime<sup>7+(deprecated)</sup>
廖康康 已提交
69 70 71 72 73

getRemainingDelayTime(requestId: number, callback: AsyncCallback&lt;number&gt;): void

获取应用程序进入挂起状态前的剩余时间,使用callback形式返回。

bugfix  
朱天怡 已提交
74
> **说明:** 从API version 9开始废弃,建议使用[backgroundTaskManager.getRemainingDelayTime](./js-apis-resourceschedule-backgroundTaskManager.md/#backgroundtaskmanagergetremainingdelaytimecallback9)
修改  
朱天怡 已提交
75 76
>
> 从 API version 7开始支持。
修改  
朱天怡 已提交
77

Z
zhangxin_T 已提交
78 79
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask

Z
zhangxin_T 已提交
80
**参数**
H
HelloCrease 已提交
81 82
| 参数名       | 类型                          | 必填   | 说明                                       |
| --------- | --------------------------- | ---- | ---------------------------------------- |
Z
zhangxin_T 已提交
83
| requestId | number                      | 是    | 延迟挂起的请求ID。这个值通过调用[requestSuspendDelay](#backgroundtaskmanagerrequestsuspenddelay)方法获取。 |
H
HelloCrease 已提交
84
| callback  | AsyncCallback&lt;number&gt; | 是    | 指定的callback回调方法。用于返回应用程序进入挂起状态之前的剩余时间,以毫秒为单位。 |
廖康康 已提交
85

Z
zhangxin_T 已提交
86
**示例**
W
wangqing 已提交
87

Z
zhangxin_T 已提交
88
  ```js
修改  
朱天怡 已提交
89
  import backgroundTaskManager from '@ohos.backgroundTaskManager';
修改  
朱天怡 已提交
90

Z
zhangxin_T 已提交
91 92
  let delayInfo = backgroundTaskManager.requestSuspendDelay("test", () => {});
  backgroundTaskManager.getRemainingDelayTime(delayInfo.requestId, (err, res) => {
修改  
朱天怡 已提交
93 94 95 96 97 98
      if(err) {
          console.log('callback => Operation getRemainingDelayTime failed. Cause: ' + err.code);
      } else {
          console.log('callback => Operation getRemainingDelayTime succeeded. Data: ' + JSON.stringify(res));
      }
  })
廖康康 已提交
99 100 101
  ```


修改  
朱天怡 已提交
102
## backgroundTaskManager.getRemainingDelayTime<sup>7+(deprecated)</sup>
廖康康 已提交
103 104 105 106 107

getRemainingDelayTime(requestId: number): Promise&lt;number&gt;

获取应用程序进入挂起状态前的剩余时间,使用Promise形式返回。

bugfix  
朱天怡 已提交
108
> **说明:** 从API version 9开始废弃,建议使用[backgroundTaskManager.getRemainingDelayTime](./js-apis-resourceschedule-backgroundTaskManager.md/#backgroundtaskmanagergetremainingdelaytimepromise9)
修改  
朱天怡 已提交
109 110
>
> 从 API version 7开始支持。
修改  
朱天怡 已提交
111

Z
zhangxin_T 已提交
112 113
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask

Z
zhangxin_T 已提交
114
**参数**
H
HelloCrease 已提交
115 116
| 参数名       | 类型     | 必填   | 说明         |
| --------- | ------ | ---- | ---------- |
Z
zhangxin_T 已提交
117
| requestId | number | 是    | 延迟挂起的请求ID。这个值通过调用[requestSuspendDelay](#backgroundtaskmanagerrequestsuspenddelay)方法获取。 |
廖康康 已提交
118

Z
zhangxin_T 已提交
119
**返回值**
H
HelloCrease 已提交
120 121 122
| 类型                    | 说明                                       |
| --------------------- | ---------------------------------------- |
| Promise&lt;number&gt; | 指定的Promise回调方法。返回应用程序进入挂起状态之前的剩余时间,以毫秒为单位。 |
廖康康 已提交
123

Z
zhangxin_T 已提交
124 125
**示例**
  ```js
Z
zhangxin_T 已提交
126 127
  let delayInfo = backgroundTaskManager.requestSuspendDelay("test", () => {});
  backgroundTaskManager.getRemainingDelayTime(delayInfo.requestId).then( res => {
修改  
朱天怡 已提交
128 129 130 131
      console.log('promise => Operation getRemainingDelayTime succeeded. Data: ' + JSON.stringify(res));
  }).catch( err => {
      console.log('promise => Operation getRemainingDelayTime failed. Cause: ' + err.code);
  })
廖康康 已提交
132 133 134
  ```


修改  
朱天怡 已提交
135
## backgroundTaskManager.cancelSuspendDelay<sup>7+(deprecated)</sup>
廖康康 已提交
136 137 138 139 140

cancelSuspendDelay(requestId: number): void

取消延迟挂起。

bugfix  
朱天怡 已提交
141
> **说明:** 从API version 9开始废弃,建议使用[backgroundTaskManager.cancelSuspendDelay](./js-apis-resourceschedule-backgroundTaskManager.md/#backgroundtaskmanagercancelsuspenddelay9)
修改  
朱天怡 已提交
142 143
>
> 从 API version 7开始支持。
修改  
朱天怡 已提交
144

Z
zhangxin_T 已提交
145 146
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask

Z
zhangxin_T 已提交
147
**参数**
H
HelloCrease 已提交
148 149
| 参数名       | 类型     | 必填   | 说明         |
| --------- | ------ | ---- | ---------- |
Z
zhangxin_T 已提交
150
| requestId | number | 是    | 延迟挂起的请求ID。这个值通过调用[requestSuspendDelay](#backgroundtaskmanagerrequestsuspenddelay)方法获取。 |
廖康康 已提交
151

Z
zhangxin_T 已提交
152 153
**示例**
  ```js
Z
zhangxin_T 已提交
154 155
  let delayInfo = backgroundTaskManager.requestSuspendDelay("test", () => {});
  backgroundTaskManager.cancelSuspendDelay(delayInfo.requestId);
廖康康 已提交
156 157 158
  ```


修改  
朱天怡 已提交
159
## backgroundTaskManager.startBackgroundRunning<sup>8+(deprecated)</sup>
廖康康 已提交
160

Z
zhangxin_T 已提交
161
startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent, callback: AsyncCallback&lt;void&gt;): void
Z
zhangxin_T 已提交
162 163 164

向系统申请长时任务,使用callback形式返回结果。

bugfix  
朱天怡 已提交
165
> **说明:** 从API version 9开始废弃,建议使用[backgroundTaskManager.startBackgroundRunning](./js-apis-resourceschedule-backgroundTaskManager.md/#backgroundtaskmanagerstartbackgroundrunningcallback9)
修改  
朱天怡 已提交
166 167
>
> 从 API version 7开始支持。
修改  
朱天怡 已提交
168

Z
zhangxin_T 已提交
169 170
**需要权限:** ohos.permission.KEEP_BACKGROUND_RUNNING

Z
zhangxin_T 已提交
171 172
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask

Z
zhangxin_T 已提交
173
**参数**
H
HelloCrease 已提交
174 175 176 177 178 179
| 参数名       | 类型                                 | 必填   | 说明                                       |
| --------- | ---------------------------------- | ---- | ---------------------------------------- |
| context   | Context                            | 是    | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
| bgMode    | [BackgroundMode](#backgroundmode8) | 是    | 向系统申请的后台模式。                              |
| wantAgent | [WantAgent](js-apis-wantAgent.md)  | 是    | 通知参数,用于指定长时任务通知点击后跳转的界面。                 |
| callback  | AsyncCallback&lt;void&gt;          | 是    | callback形式返回启动长时任务的结果。                   |
Z
zhangxin_T 已提交
180

Z
zhangxin_T 已提交
181
**示例**
Z
zhangxin_T 已提交
182 183 184

FA模型示例:

Z
zhangxin_T 已提交
185
```js
修改  
朱天怡 已提交
186
import backgroundTaskManager from '@ohos.backgroundTaskManager';
Z
zhangxin_T 已提交
187 188 189
import featureAbility from '@ohos.ability.featureAbility';
import wantAgent from '@ohos.wantAgent';

修改  
朱天怡 已提交
190 191 192
function callback(err, data) {
    if (err) {
        console.error("Operation startBackgroundRunning failed Cause: " + err);
Z
zhangxin_T 已提交
193
    } else {
W
wangqing 已提交
194
        console.info("Operation startBackgroundRunning succeeded");
Z
zhangxin_T 已提交
195 196 197 198 199 200 201 202 203 204 205 206
    }
}

let wantAgentInfo = {
    wants: [
        {
            bundleName: "com.example.myapplication",
            abilityName: "com.example.myapplication.MainAbility"
        }
    ],
    operationType: wantAgent.OperationType.START_ABILITY,
    requestCode: 0,
W
wangqing 已提交
207
    wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
Z
zhangxin_T 已提交
208 209 210
};

wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
修改  
朱天怡 已提交
211
    backgroundTaskManager.startBackgroundRunning(featureAbility.getContext(),
Z
zhangxin_T 已提交
212
        backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj, callback)
Z
zhangxin_T 已提交
213 214 215 216
});

```

Z
zhangxin_T 已提交
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
Stage模型示例:

```ts
import Ability from '@ohos.application.Ability'
import backgroundTaskManager from '@ohos.backgroundTaskManager';
import wantAgent from '@ohos.wantAgent';

function callback(err, data) {
    if (err) {
        console.error("Operation startBackgroundRunning failed Cause: " + err);
    } else {
        console.info("Operation startBackgroundRunning succeeded");
    }
}

export default class MainAbility extends Ability {
    onCreate(want, launchParam) {
        let wantAgentInfo = {
            wants: [
                {
                    bundleName: "com.example.myapplication",
                    abilityName: "com.example.myapplication.MainAbility"
                }
            ],
            operationType: wantAgent.OperationType.START_ABILITY,
            requestCode: 0,
            wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
        };

        wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
            backgroundTaskManager.startBackgroundRunning(this.context,
                backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj, callback)
        });
    }
};
```

修改  
朱天怡 已提交
254
## backgroundTaskManager.startBackgroundRunning<sup>8+(deprecated)</sup>
Z
zhangxin_T 已提交
255

Z
zhangxin_T 已提交
256
startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent): Promise&lt;void&gt;
Z
zhangxin_T 已提交
257 258 259

向系统申请长时任务,使用promise形式返回结果。

bugfix  
朱天怡 已提交
260
> **说明:** 从API version 9开始废弃,建议使用[backgroundTaskManager.startBackgroundRunning](./js-apis-resourceschedule-backgroundTaskManager.md/#backgroundtaskmanagerstartbackgroundrunningpromise9)
修改  
朱天怡 已提交
261 262
>
> 从 API version 7开始支持。
修改  
朱天怡 已提交
263

Z
zhangxin_T 已提交
264 265
**需要权限:** ohos.permission.KEEP_BACKGROUND_RUNNING

Z
zhangxin_T 已提交
266 267
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask

Z
zhangxin_T 已提交
268
**参数**
W
wangqing 已提交
269

H
HelloCrease 已提交
270 271 272 273 274
| 参数名       | 类型                                 | 必填   | 说明                                       |
| --------- | ---------------------------------- | ---- | ---------------------------------------- |
| context   | Context                            | 是    | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
| bgMode    | [BackgroundMode](#backgroundmode8) | 是    | 向系统申请的后台模式。                              |
| wantAgent | [WantAgent](js-apis-wantAgent.md)  | 是    | 通知参数,用于指定长时任务通知点击跳转的界面。                  |
W
wangqing 已提交
275

276
**返回值**
H
HelloCrease 已提交
277 278 279
| 类型             | 说明               |
| -------------- | ---------------- |
| Promise\<void> | 使用Promise形式返回结果。 |
Z
zhangxin_T 已提交
280

Z
zhangxin_T 已提交
281
**示例**
Z
zhangxin_T 已提交
282 283 284

FA模型示例:

Z
zhangxin_T 已提交
285
```js
修改  
朱天怡 已提交
286
import backgroundTaskManager from '@ohos.backgroundTaskManager';
Z
zhangxin_T 已提交
287 288 289 290 291 292 293 294 295 296 297 298
import featureAbility from '@ohos.ability.featureAbility';
import wantAgent from '@ohos.wantAgent';

let wantAgentInfo = {
    wants: [
        {
            bundleName: "com.example.myapplication",
            abilityName: "com.example.myapplication.MainAbility"
        }
    ],
    operationType: wantAgent.OperationType.START_ABILITY,
    requestCode: 0,
W
wangqing 已提交
299
    wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
Z
zhangxin_T 已提交
300 301 302
};

wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
修改  
朱天怡 已提交
303
    backgroundTaskManager.startBackgroundRunning(featureAbility.getContext(),
Z
zhangxin_T 已提交
304
        backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj).then(() => {
修改  
朱天怡 已提交
305 306 307 308
        console.info("Operation startBackgroundRunning succeeded");
    }).catch((err) => {
        console.error("Operation startBackgroundRunning failed Cause: " + err);
    });
Z
zhangxin_T 已提交
309
});
Z
zhangxin_T 已提交
310 311 312 313 314 315 316 317
```

Stage模型示例:

```ts
import Ability from '@ohos.application.Ability'
import backgroundTaskManager from '@ohos.backgroundTaskManager';
import wantAgent from '@ohos.wantAgent';
Z
zhangxin_T 已提交
318

Z
zhangxin_T 已提交
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
export default class MainAbility extends Ability {
    onCreate(want, launchParam) {
        let wantAgentInfo = {
            wants: [
                {
                    bundleName: "com.example.myapplication",
                    abilityName: "com.example.myapplication.MainAbility"
                }
            ],
            operationType: wantAgent.OperationType.START_ABILITY,
            requestCode: 0,
            wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
        };

        wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
            backgroundTaskManager.startBackgroundRunning(this.context,
                backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj).then(() => {
                console.info("Operation startBackgroundRunning succeeded");
            }).catch((err) => {
                console.error("Operation startBackgroundRunning failed Cause: " + err);
            });
        });
    }
};
Z
zhangxin_T 已提交
343 344
```

修改  
朱天怡 已提交
345
## backgroundTaskManager.stopBackgroundRunning<sup>8+(deprecated)</sup>
Z
zhangxin_T 已提交
346

Z
zhangxin_T 已提交
347
stopBackgroundRunning(context: Context, callback: AsyncCallback&lt;void&gt;): void
Z
zhangxin_T 已提交
348 349 350

向系统申请取消长时任务,使用callback形式返回结果。

bugfix  
朱天怡 已提交
351
> **说明:** 从API version 9开始废弃,建议使用[backgroundTaskManager.stopBackgroundRunning](./js-apis-resourceschedule-backgroundTaskManager.md/#backgroundtaskmanagerstopbackgroundrunningcallback9)
修改  
朱天怡 已提交
352 353
>
> 从 API version 7开始支持。
修改  
朱天怡 已提交
354

Z
zhangxin_T 已提交
355 356
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask

Z
zhangxin_T 已提交
357
**参数**
H
HelloCrease 已提交
358 359 360 361
| 参数名      | 类型                        | 必填   | 说明                                       |
| -------- | ------------------------- | ---- | ---------------------------------------- |
| 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形式返回启动长时任务的结果。                   |
Z
zhangxin_T 已提交
362

Z
zhangxin_T 已提交
363
**示例**
Z
zhangxin_T 已提交
364 365 366

FA模型示例:

Z
zhangxin_T 已提交
367
```js
修改  
朱天怡 已提交
368
import backgroundTaskManager from '@ohos.backgroundTaskManager';
Z
zhangxin_T 已提交
369 370
import featureAbility from '@ohos.ability.featureAbility';

修改  
朱天怡 已提交
371 372 373
function callback(err, data) {
    if (err) {
        console.error("Operation stopBackgroundRunning failed Cause: " + err);
Z
zhangxin_T 已提交
374
    } else {
W
wangqing 已提交
375
        console.info("Operation stopBackgroundRunning succeeded");
Z
zhangxin_T 已提交
376 377 378
    }
}

修改  
朱天怡 已提交
379
backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext(), callback);
Z
zhangxin_T 已提交
380 381 382

```

Z
zhangxin_T 已提交
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
Stage模型示例:

```ts
import Ability from '@ohos.application.Ability'
import backgroundTaskManager from '@ohos.backgroundTaskManager';

function callback(err, data) {
    if (err) {
        console.error("Operation stopBackgroundRunning failed Cause: " + err);
    } else {
        console.info("Operation stopBackgroundRunning succeeded");
    }
}

export default class MainAbility extends Ability {
    onCreate(want, launchParam) {
        backgroundTaskManager.stopBackgroundRunning(this.context, callback);
    }
};
```

修改  
朱天怡 已提交
404
## backgroundTaskManager.stopBackgroundRunning<sup>8+(deprecated)</sup>
Z
zhangxin_T 已提交
405

Z
zhangxin_T 已提交
406
stopBackgroundRunning(context: Context): Promise&lt;void&gt;
Z
zhangxin_T 已提交
407 408 409

向系统申请取消长时任务,使用promise形式返回结果。

bugfix  
朱天怡 已提交
410
> **说明:** 从API version 9开始废弃,建议使用[backgroundTaskManager.stopBackgroundRunning](./js-apis-resourceschedule-backgroundTaskManager.md/#backgroundtaskmanagerstopbackgroundrunningpromise9)
修改  
朱天怡 已提交
411 412
>
> 从 API version 7开始支持。
修改  
朱天怡 已提交
413

Z
zhangxin_T 已提交
414 415
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask

Z
zhangxin_T 已提交
416
**参数**
H
HelloCrease 已提交
417 418
| 参数名     | 类型      | 必填   | 说明                                       |
| ------- | ------- | ---- | ---------------------------------------- |
Z
zhangxin_T 已提交
419
| context | Context | 是    | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
Z
zhangxin_T 已提交
420

421
**返回值**
H
HelloCrease 已提交
422 423 424
| 类型             | 说明               |
| -------------- | ---------------- |
| Promise\<void> | 使用Promise形式返回结果。 |
Z
zhangxin_T 已提交
425

Z
zhangxin_T 已提交
426
**示例**
Z
zhangxin_T 已提交
427 428 429

FA模型示例:

Z
zhangxin_T 已提交
430
```js
修改  
朱天怡 已提交
431
import backgroundTaskManager from '@ohos.backgroundTaskManager';
Z
zhangxin_T 已提交
432 433
import featureAbility from '@ohos.ability.featureAbility';

修改  
朱天怡 已提交
434 435 436 437 438
backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(() => {
    console.info("Operation stopBackgroundRunning succeeded");
}).catch((err) => {
    console.error("Operation stopBackgroundRunning failed Cause: " + err);
});
Z
zhangxin_T 已提交
439 440 441

```

Z
zhangxin_T 已提交
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
Stage模型示例:

```ts
import Ability from '@ohos.application.Ability'
import backgroundTaskManager from '@ohos.backgroundTaskManager';

export default class MainAbility extends Ability {
    onCreate(want, launchParam) {
        backgroundTaskManager.stopBackgroundRunning(this.context).then(() => {
            console.info("Operation stopBackgroundRunning succeeded");
        }).catch((err) => {
            console.error("Operation stopBackgroundRunning failed Cause: " + err);
        });
    }
};
```

修改  
朱天怡 已提交
459
## backgroundTaskManager.applyEfficiencyResources<sup>9+(deprecated)</sup>
Z
Zhao-PengFei35 已提交
460

修改  
朱天怡 已提交
461
applyEfficiencyResources(request: [EfficiencyResourcesRequest](#efficiencyresourcesrequest9)): void
Z
Zhao-PengFei35 已提交
462

Z
zhangxin_T 已提交
463
向系统申请或释放能效资源,使用boolean形式返回结果。
Z
zhangxin_T 已提交
464 465
通过EfficiencyResourcesRequest参数中的isApply变量,设置是申请还是释放。
应用使用此接口,需要向应用中心申请获得相应特权。
466
进程和它所属的应用可以同时申请某一类资源,例如CPU资源,但是应用释放资源的时候会将进程的资源一起释放。
Z
Zhao-PengFei35 已提交
467

bugfix  
朱天怡 已提交
468
> **说明:** 从API version 9开始废弃,建议使用[backgroundTaskManager.applyEfficiencyResources](./js-apis-resourceschedule-backgroundTaskManager.md/#backgroundtaskmanagerapplyefficiencyresources9)
修改  
朱天怡 已提交
469
>
修改  
朱天怡 已提交
470 471
> 从 API version 9开始支持。

472
**系统能力**: SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
473

474
**系统API**: 此接口为系统接口。
Z
Zhao-PengFei35 已提交
475 476

**参数**
477

Z
Zhao-PengFei35 已提交
478 479
| 参数名     | 类型      | 必填   | 说明                                       |
| ------- | ------- | ---- | ---------------------------------------- |
480
| request | [EfficiencyResourcesRequest](#efficiencyresourcesrequest9) | 是    | 请求的必要信息。包括资源类型,超时时间等信息。详见[EfficiencyResourcesRequest](#efficiencyresourcesrequest9)。 |
Z
Zhao-PengFei35 已提交
481 482

**示例**
483

Z
Zhao-PengFei35 已提交
484
```js
修改  
朱天怡 已提交
485
import backgroundTaskManager from '@ohos.backgroundTaskManager';  
Z
Zhao-PengFei35 已提交
486 487 488

let request = {
    resourceTypes: backgroundTaskManager.ResourceType.CPU,
Z
zhangxin_T 已提交
489
    // 如果将isApply置为false,则表示释放资源
Z
Zhao-PengFei35 已提交
490 491 492 493 494 495
    isApply: true,
    timeOut: 0,
    reason: "apply",
    isPersist: true,
    isProcess: false,
};
修改  
朱天怡 已提交
496 497 498 499 500 501
try {
    backgroundTaskManager.applyEfficiencyResources(request);
    console.info("applyEfficiencyResources success. ");
} catch (error) {
    console.error(`applyEfficiencyResources failed. code is ${error.code} message is ${error.message}`);
}
Z
Zhao-PengFei35 已提交
502 503
```

修改  
朱天怡 已提交
504
## backgroundTaskManager.resetAllEfficiencyResources<sup>9+(deprecated)</sup>
Z
Zhao-PengFei35 已提交
505 506 507

resetAllEfficiencyResources(): void

508
释放所有已经申请的资源。
Z
zhangxin_T 已提交
509
应用使用此接口,需要向应用中心申请获得相应特权。
Z
Zhao-PengFei35 已提交
510

bugfix  
朱天怡 已提交
511
> **说明:** 从API version 9开始废弃,建议使用[backgroundTaskManager.resetAllEfficiencyResources](./js-apis-resourceschedule-backgroundTaskManager.md/#backgroundtaskmanagerresetallefficiencyresources9)
修改  
朱天怡 已提交
512
>
修改  
朱天怡 已提交
513 514
> 从 API version 9开始支持。

Z
Zhao-PengFei35 已提交
515
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
516

517
**系统API**: 此接口为系统接口。
Z
Zhao-PengFei35 已提交
518 519

**示例**
520

Z
Zhao-PengFei35 已提交
521
```js
修改  
朱天怡 已提交
522
import backgroundTaskManager from '@ohos.backgroundTaskManager';  
Z
Zhao-PengFei35 已提交
523

修改  
朱天怡 已提交
524 525 526 527 528
try {
    backgroundTaskManager.backgroundTaskManager.resetAllEfficiencyResources();
} catch (error) {
    console.error(`resetAllEfficiencyResources failed. code is ${error.code} message is ${error.message}`);
}
Z
Zhao-PengFei35 已提交
529 530
```

修改  
朱天怡 已提交
531
## DelaySuspendInfo<sup>7+(deprecated)</sup>
Z
zhangxin_T 已提交
532 533 534

延迟挂起信息。

bugfix  
朱天怡 已提交
535
> **说明:** 从API version 9开始废弃,建议使用[backgroundTaskManager.DelaySuspendInfo](./js-apis-resourceschedule-backgroundTaskManager.md/#backgroundtaskmanagerdelaysuspendinfo9)
修改  
朱天怡 已提交
536 537 538
>
> 从 API version 7开始支持。

H
HelloCrease 已提交
539
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
Z
zhangxin_T 已提交
540

H
HelloCrease 已提交
541 542 543 544
| 参数名             | 类型     | 必填   | 说明                                       |
| --------------- | ------ | ---- | ---------------------------------------- |
| requestId       | number | 是    | 延迟挂起的请求ID。                               |
| actualDelayTime | number | 是    | 应用的实际挂起延迟时间,以毫秒为单位。<br/>一般情况下默认值为180000,低电量(依据系统低电量广播)时默认值为60000。 |
Z
zhangxin_T 已提交
545 546


修改  
朱天怡 已提交
547
## BackgroundMode<sup>8+(deprecated)</sup>
Z
zhangxin_T 已提交
548

H
HelloCrease 已提交
549 550 551 552
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask

| 参数名                     | 参数值  | 描述                    |
| ----------------------- | ---- | --------------------- |
553 554 555 556 557 558
| DATA_TRANSFER           | 1    | 数据传输。                  |
| AUDIO_PLAYBACK          | 2    | 音频播放。                  |
| AUDIO_RECORDING         | 3    | 录音。                    |
| LOCATION                | 4    | 定位导航。                  |
| BLUETOOTH_INTERACTION   | 5    | 蓝牙相关。                  |
| MULTI_DEVICE_CONNECTION | 6    | 多设备互联。                 |
H
HelloCrease 已提交
559 560
| WIFI_INTERACTION        | 7    | WLAN相关<br />此接口为系统接口。 |
| VOIP                    | 8    | 音视频通话<br />此接口为系统接口。  |
561
| TASK_KEEPING            | 9    | 计算任务(仅在特定设备生效)。        |
Z
Zhao-PengFei35 已提交
562

修改  
朱天怡 已提交
563
## EfficiencyResourcesRequest<sup>9+(deprecated)</sup>
Z
Zhao-PengFei35 已提交
564

565
能效资源申请参数。
Z
Zhao-PengFei35 已提交
566

bugfix  
朱天怡 已提交
567
> **说明:** 从API version 9开始废弃,建议使用[backgroundTaskManager.EfficiencyResourcesRequest](./js-apis-resourceschedule-backgroundTaskManager.md/#backgroundtaskmanagerefficiencyresourcesrequest9)
修改  
朱天怡 已提交
568 569 570
>
> 从 API version 9开始支持。

Z
Zhao-PengFei35 已提交
571 572
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply

573 574
**系统API**: 此接口为系统接口。

Z
Zhao-PengFei35 已提交
575 576 577 578
| 参数名             | 类型     | 必填   | 说明                                       |
| --------------- | ------ | ---- | ---------------------------------------- |
| resourceTypes   | number  | 是    | 申请的资源类型。                               |
| isApply         | boolean | 是    | 申请资源或者是释放资源。          |
579
| timeOut         | number  | 是    | 资源的使用时间,以毫秒为单位。                |
Z
Zhao-PengFei35 已提交
580 581 582 583
| isPersist       | boolean | 否    | 是否永久持有资源,如果是true,那么timeOut就无效。    |
| isProcess       | boolean | 否    | 应用申请或者是进程申请。          |
| reason          | string  | 是    | 申请资源的原因。                |

修改  
朱天怡 已提交
584
## ResourceType<sup>9+(deprecated)</sup>
Z
Zhao-PengFei35 已提交
585

586 587
能效资源类型。

bugfix  
朱天怡 已提交
588
> **说明:** 从API version 9开始废弃,建议使用[backgroundTaskManager.ResourceType](./js-apis-resourceschedule-backgroundTaskManager.md/#backgroundtaskmanagerresourcetype9)
修改  
朱天怡 已提交
589 590 591
>
> 从 API version 9开始支持。

Z
Zhao-PengFei35 已提交
592 593
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply

594 595
**系统API**: 此接口为系统接口。

Z
Zhao-PengFei35 已提交
596 597
| 参数名                     | 参数值  | 描述                    |
| ----------------------- | ---- | --------------------- |
598 599 600 601 602 603
| CPU                     | 1    | CPU资源,申请后不被挂起。             |
| COMMON_EVENT            | 2    | 公共事件,申请后挂起状态下不被代理掉。  |
| TIMER                   | 4    | 计时器,申请后挂起状态下不被代理掉。    |
| WORK_SCHEDULER          | 8    | 延迟任务,申请后有更长的执行时间。      |
| BLUETOOTH               | 16   | 蓝牙相关,申请后挂起状态下不被代理掉。  |
| GPS                     | 32   | GPS相关,申请后挂起状态下不被代理掉。  |
修改  
朱天怡 已提交
604
| AUDIO                   | 64   | 音频资源,申请后挂起状态下不被代理掉。 |