js-apis-app-ability-appManager.md 24.1 KB
Newer Older
D
donglin 已提交
1 2 3 4 5 6 7 8 9 10
# appManager

appManager模块提供App管理的能力,包括查询当前是否处于稳定性测试场景、查询是否为ram受限设备、获取应用程序的内存大小、获取有关运行进程的信息等。

> **说明:**
> 
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

## 导入模块

M
m00512953 已提交
11
```ts
D
merge  
donglin 已提交
12
import appManager from '@ohos.app.ability.appManager';
D
donglin 已提交
13 14
```

M
m00512953 已提交
15
## appManager.isRunningInStabilityTest<sup>9+</sup>
D
donglin 已提交
16 17 18 19 20 21 22 23 24 25 26

static isRunningInStabilityTest(callback: AsyncCallback&lt;boolean&gt;): void

查询当前是否处于稳定性测试场景。

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**参数:**

  | 参数名 | 类型 | 必填 | 说明 | 
  | -------- | -------- | -------- | -------- |
D
fix  
donglin 已提交
27
  | callback | AsyncCallback&lt;boolean&gt; | 是 | 返回当前是否处于稳定性测试场景。 | 
D
donglin 已提交
28 29 30

**示例:**
    
M
m00512953 已提交
31 32
  ```ts
  import app from '@ohos.application.appManager';
D
donglin 已提交
33 34 35 36 37 38
  app.isRunningInStabilityTest((err, flag) => {
      console.log('startAbility result:' + JSON.stringify(err));
  })  
  ```


M
m00512953 已提交
39
## appManager.isRunningInStabilityTest<sup>9+</sup>
D
donglin 已提交
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

static isRunningInStabilityTest(): Promise&lt;boolean&gt;

查询当前是否处于稳定性测试场景。

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**返回值:**

  | 类型 | 说明 | 
  | -------- | -------- |
  | Promise&lt;boolean&gt; | 返回当前是否处于稳定性测试场景。 | 

**示例:**
    
M
m00512953 已提交
55 56
  ```ts
  import app from '@ohos.application.appManager';
D
donglin 已提交
57 58 59
  app.isRunningInStabilityTest().then((flag) => {
      console.log('success:' + JSON.stringify(flag));
  }).catch((error) => {
M
m00512953 已提交
60
      console.log('failed:' + JSON.stringify(error));
D
donglin 已提交
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
  });
  ```


## appManager.isRamConstrainedDevice

isRamConstrainedDevice(): Promise\<boolean>;

查询是否为ram受限设备。

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**返回值:**

  | 类型 | 说明 | 
  | -------- | -------- |
  | Promise&lt;boolean&gt; | 是否为ram受限设备。 | 

**示例:**
    
M
m00512953 已提交
81 82 83 84 85 86
  ```ts
  app.isRamConstrainedDevice().then((data) => {
      console.log('success:' + JSON.stringify(data));
  }).catch((error) => {
      console.log('failed:' + JSON.stringify(error));
  });
D
donglin 已提交
87 88 89 90 91 92 93 94 95 96 97 98 99 100
  ```

## appManager.isRamConstrainedDevice

isRamConstrainedDevice(callback: AsyncCallback\<boolean>): void;

查询是否为ram受限设备。

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**参数:**

  | 参数名 | 类型 | 必填 | 说明 | 
  | -------- | -------- | -------- | -------- |
D
fix  
donglin 已提交
101
  | callback | AsyncCallback&lt;boolean&gt; | 是 | 返回当前是否是ram受限设备。 | 
D
donglin 已提交
102 103 104

**示例:**
    
M
m00512953 已提交
105 106 107 108 109
  ```ts
  app.isRamConstrainedDevice((err, data) => {
    console.log('startAbility result failed:' + JSON.stringify(err));
    console.log('startAbility result success:' + JSON.stringify(data));
  })
D
donglin 已提交
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
  ```

## appManager.getAppMemorySize

getAppMemorySize(): Promise\<number>;

获取应用程序的内存大小。

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**返回值:**

  | 类型 | 说明 | 
  | -------- | -------- |
  | Promise&lt;number&gt; | 应用程序内存大小。 | 

**示例:**
    
M
m00512953 已提交
128 129 130 131 132 133
  ```ts
  app.getAppMemorySize().then((data) => {
      console.log('success:' + JSON.stringify(data));
  }).catch((error) => {
      console.log('failed:' + JSON.stringify(error));
  });
D
donglin 已提交
134 135 136 137 138 139 140 141 142 143 144 145 146 147
  ```

## appManager.getAppMemorySize

getAppMemorySize(callback: AsyncCallback\<number>): void;

获取应用程序的内存大小。

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**参数:**

  | 参数名 | 类型 | 必填 | 说明 | 
  | -------- | -------- | -------- | -------- |
D
fix  
donglin 已提交
148
  | callback | AsyncCallback&lt;number&gt; | 是 | 应用程序内存大小。 | 
D
donglin 已提交
149 150 151

**示例:**
    
M
m00512953 已提交
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
  ```ts
  app.getAppMemorySize((err, data) => {
      console.log('startAbility result failed :' + JSON.stringify(err));
      console.log('startAbility result success:' + JSON.stringify(data));
  })
  ```
## appManager.getProcessRunningInfos<sup>(deprecated)</sup>

getProcessRunningInfos(): Promise\<Array\<ProcessRunningInfo>>;

获取有关运行进程的信息。

> 从 API Version 9 开始废弃,建议使用[appManager.getProcessRunningInformation<sup>9+</sup>](#appmanagergetprocessrunninginformation9)替代。

**需要权限**:ohos.permission.GET_RUNNING_INFO

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

D
merge  
donglin 已提交
170 171
**系统API**: 此接口为系统接口,三方应用不支持调用。

M
m00512953 已提交
172 173 174 175 176 177 178 179 180 181 182 183 184 185
**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| Promise\<Array\<ProcessRunningInfo>> | 获取有关运行进程的信息。 |

**示例:**
    
  ```ts
  app.getProcessRunningInfos().then((data) => {
      console.log('success:' + JSON.stringify(data));
  }).catch((error) => {
      console.log('failed:' + JSON.stringify(error));
  });
D
donglin 已提交
186 187
  ```

M
m00512953 已提交
188 189 190 191 192 193 194 195 196 197 198 199
## appManager.getProcessRunningInfos<sup>(deprecated)</sup>

getProcessRunningInfos(callback: AsyncCallback\<Array\<ProcessRunningInfo>>): void;

获取有关运行进程的信息。

> 从 API Version 9 开始废弃,建议使用[appManager.getProcessRunningInformation<sup>9+</sup>](#appmanagergetprocessrunninginformation9-1)替代。

**需要权限**:ohos.permission.GET_RUNNING_INFO

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

D
merge  
donglin 已提交
200 201
**系统API**: 此接口为系统接口,三方应用不支持调用。

M
m00512953 已提交
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback\<Array\<ProcessRunningInfo>> | 否 | 获取有关运行进程的信息。 |

**示例:**
    
  ```ts
  app.getProcessRunningInfos((err, data) => {
      console.log('startAbility result failed :' + JSON.stringify(err));
      console.log('startAbility result success:' + JSON.stringify(data));
  })
  ```

## appManager.getProcessRunningInformation<sup>9+</sup>
D
donglin 已提交
218 219 220 221 222 223 224 225 226

getProcessRunningInformation(): Promise\<Array\<ProcessRunningInformation>>;

获取有关运行进程的信息。

**需要权限**:ohos.permission.GET_RUNNING_INFO

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

D
fix  
donglin 已提交
227 228
**系统API**: 此接口为系统接口,三方应用不支持调用。

D
donglin 已提交
229 230 231 232
**返回值:**

| 类型 | 说明 |
| -------- | -------- |
M
m00512953 已提交
233
| Promise\<Array\<[ProcessRunningInformation](js-apis-inner-application-processRunningInformation.md)>> | 获取有关运行进程的信息。 |
D
donglin 已提交
234 235 236

**示例:**
    
M
m00512953 已提交
237 238 239 240 241 242
  ```ts
  app.getProcessRunningInformation().then((data) => {
      console.log('success:' + JSON.stringify(data));
  }).catch((error) => {
      console.log('failed:' + JSON.stringify(error));
  });
D
donglin 已提交
243 244
  ```

M
m00512953 已提交
245
## appManager.getProcessRunningInformation<sup>9+</sup>
D
donglin 已提交
246 247 248 249 250 251 252 253 254 255 256 257 258

getProcessRunningInformation(callback: AsyncCallback\<Array\<ProcessRunningInformation>>): void;

获取有关运行进程的信息。

**需要权限**:ohos.permission.GET_RUNNING_INFO

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
D
merge  
donglin 已提交
259
| callback | AsyncCallback\<Array\<[ProcessRunningInformation](js-apis-inner-application-processRunningInformation.md)>> | 是 | 获取有关运行进程的信息。 |
D
donglin 已提交
260 261 262

**示例:**
    
M
m00512953 已提交
263 264 265 266 267
  ```ts
  app.getProcessRunningInformation((err, data) => {
    console.log('startAbility result failed :' + JSON.stringify(err));
    console.log('startAbility result success:' + JSON.stringify(data));
  })
D
donglin 已提交
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
  ```

## appManager.on

on(type: "applicationState", observer: ApplicationStateObserver): number;

注册全部应用程序状态观测器。

**需要权限**:ohos.permission.RUNNING_STATE_OBSERVER

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**:该接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 调用接口类型 |
D
merge  
donglin 已提交
287
| observer | [ApplicationStateObserver](./js-apis-inner-application-applicationStateObserver.md) | 是 | 返回观察者的数字代码。 |
D
donglin 已提交
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334

**示例:**
    
  ```js
  var applicationStateObserver = {
    onForegroundApplicationChanged(appStateData) {
        console.log('------------ onForegroundApplicationChanged -----------', appStateData);
    },
    onAbilityStateChanged(abilityStateData) {
        console.log('------------ onAbilityStateChanged -----------', abilityStateData);
    },
    onProcessCreated(processData) {
        console.log('------------ onProcessCreated -----------', processData);
    },
    onProcessDied(processData) {
        console.log('------------ onProcessDied -----------', processData);
    },
    onProcessStateChanged(processData) {
        console.log('------------ onProcessStateChanged -----------', processData);
    }
  }
  try {
    const observerCode = app.on(applicationStateObserver);
    console.log('-------- observerCode: ---------', observerCode);
  } catch (paramError) {
    console.log('error: ' + paramError.code + ', ' + paramError.message);
  }

  ```

## appManager.on

on(type: "applicationState", observer: ApplicationStateObserver, bundleNameList: Array\<string>): number;

注册指定应用程序状态观测器。

**需要权限**:ohos.permission.RUNNING_STATE_OBSERVER

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**:该接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 调用接口类型 |
D
merge  
donglin 已提交
335
| observer | [ApplicationStateObserver](./js-apis-inner-application-applicationStateObserver.md) | 是 | 返回观察者的数字代码。 |
D
fix  
donglin 已提交
336
| bundleNameList | Array<string> | 是 | 表示需要注册监听的bundleName数组。最大值128。 |
D
donglin 已提交
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383

**示例:**
    
  ```js
  var applicationStateObserver = {
    onForegroundApplicationChanged(appStateData) {
        console.log('------------ onForegroundApplicationChanged -----------', appStateData);
    },
    onAbilityStateChanged(abilityStateData) {
        console.log('------------ onAbilityStateChanged -----------', abilityStateData);
    },
    onProcessCreated(processData) {
        console.log('------------ onProcessCreated -----------', processData);
    },
    onProcessDied(processData) {
        console.log('------------ onProcessDied -----------', processData);
    },
    onProcessStateChanged(processData) {
        console.log('------------ onProcessStateChanged -----------', processData);
    }
  }
  var bundleNameList = ['bundleName1', 'bundleName2'];
  try {
    const observerCode = app.on("applicationState", applicationStateObserver, bundleNameList);
    console.log('-------- observerCode: ---------', observerCode);
  } catch (paramError) {
    console.log('error: ' + paramError.code + ', ' + paramError.message);
  }

  ```
## appManager.off

off(type: "applicationState", observerId: number,  callback: AsyncCallback\<void>): void;

取消注册应用程序状态观测器。

**需要权限**:ohos.permission.RUNNING_STATE_OBSERVER

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**:该接口为系统接口,三方应用不支持调用。

**参数:**
 
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 调用接口类型 |
D
fix  
donglin 已提交
384 385
| observerId | number | 是 | 表示观察者的编号代码。 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法。 |
D
donglin 已提交
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420

**示例:**
    
  ```js
    var observerId = 100;

    function unregisterApplicationStateObserverCallback(err) {
      if (err) {
          console.log('------------ unregisterApplicationStateObserverCallback ------------', err);
      }
    }
    try {
      app.off(observerId, unregisterApplicationStateObserverCallback);
    } catch (paramError) {
      console.log('error: ' + paramError.code + ', ' + paramError.message);
    }
  ```

## appManager.off

off(type: "applicationState", observerId: number): Promise\<void>;

取消注册应用程序状态观测器。

**需要权限**:ohos.permission.RUNNING_STATE_OBSERVER

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**:该接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 调用接口类型 |
M
m00512953 已提交
421
| observerId | number | 否 | 表示观察者的编号代码。 |
D
donglin 已提交
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| Promise\<void> | 返回执行结果。 |

**示例:**
    
  ```js
    var observerId = 100;
    
    try {
      app.off(observerId)
        .then((data) => {
          console.log('----------- unregisterApplicationStateObserver success ----------', data);
        })
        .catch((err) => {
          console.log('----------- unregisterApplicationStateObserver fail ----------', err);
        })
    } catch (paramError) {
      console.log('error: ' + paramError.code + ', ' + paramError.message);
    }
  ```

## appManager.getForegroundApplications

getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;

获取前台进程的应用程序。

**需要权限**:ohos.permission.GET_RUNNING_INFO

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**:该接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
463
| callback | AsyncCallback\<Array\<AppStateData>> | 是 | 表示应用的状态数据。 |
D
donglin 已提交
464 465 466 467 468 469 470 471 472 473 474 475 476 477

**示例:**
    
  ```js
    function getForegroundApplicationsCallback(err, data) {
      if (err) {
          console.log('--------- getForegroundApplicationsCallback fail ---------', err.code + ': ' + err.message);
      } else {
          console.log('--------- getForegroundApplicationsCallback success ---------', data)
      }
    }
    app.getForegroundApplications(getForegroundApplicationsCallback);
  ```

M
m00512953 已提交
478 479 480 481 482 483 484 485 486 487 488 489 490 491
unregisterApplicationStateObserver(observerId: number): Promise\<void>;

取消注册应用程序状态观测器。

**需要权限**:ohos.permission.RUNNING_STATE_OBSERVER

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**:该接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
D
merge  
donglin 已提交
492
| observerId | number | 是 | 表示观察者的编号代码。 |
M
m00512953 已提交
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| Promise\<void> | 返回执行结果。 |

**示例:**
    
  ```ts
  var observerId = 100;
  app.unregisterApplicationStateObserver(observerId)
  .then((data) => {
      console.log('----------- unregisterApplicationStateObserver success ----------', data);
  })
  .catch((err) => {
      console.log('----------- unregisterApplicationStateObserver fail ----------', err);
  })
  ```

## appManager.getForegroundApplications<sup>9+</sup>

getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;

获取前台进程的应用程序。

**需要权限**:ohos.permission.GET_RUNNING_INFO

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**:该接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
D
merge  
donglin 已提交
529
| callback | AsyncCallback\<Array\<AppStateData>> | 是 | 表示应用的状态数据。 |
M
m00512953 已提交
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544

**示例:**
    
  ```ts
  function getForegroundApplicationsCallback(err, data) {
    if (err) {
        console.log('--------- getForegroundApplicationsCallback fail ---------', err);
    } else {
        console.log('--------- getForegroundApplicationsCallback success ---------', data)
    }
  }
  app.getForegroundApplications(getForegroundApplicationsCallback);
  ```

## appManager.getForegroundApplications<sup>9+</sup>
D
donglin 已提交
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563

getForegroundApplications(): Promise\<Array\<AppStateData>>;

获取前台进程的应用程序。

**需要权限**:ohos.permission.GET_RUNNING_INFO

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**:该接口为系统接口,三方应用不支持调用。

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| Promise\<Array\<ProcessRunningInfo>> | 返回进程运行信息的数组。 |

**示例:**
    
M
m00512953 已提交
564 565 566 567 568 569 570 571
  ```ts
  app.getForegroundApplications()
  .then((data) => {
      console.log('--------- getForegroundApplications success -------', data);
  })
  .catch((err) => {
      console.log('--------- getForegroundApplications fail -------', err);
  })
D
donglin 已提交
572 573
  ```

M
m00512953 已提交
574
## appManager.killProcessWithAccount<sup>9+</sup>
D
donglin 已提交
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594

killProcessWithAccount(bundleName: string, accountId: number): Promise\<void\>

切断account进程(Promise形式)。

**需要权限**:ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS, ohos.permission.CLEAN_BACKGROUND_PROCESSES

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

  | 参数名 | 类型 | 必填 | 说明 | 
  | -------- | -------- | -------- | -------- |
  | bundleName | string | 是 | 应用包名。 | 
  | accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | 

**示例:**

M
m00512953 已提交
595
```ts
D
donglin 已提交
596 597
var bundleName = 'bundleName';
var accountId = 0;
M
m00512953 已提交
598 599
app.killProcessWithAccount(bundleName, accountId)
   .then((data) => {
D
donglin 已提交
600
       console.log('------------ killProcessWithAccount success ------------', data);
M
m00512953 已提交
601 602
   })
   .catch((err) => {
D
donglin 已提交
603
       console.log('------------ killProcessWithAccount fail ------------', err);
M
m00512953 已提交
604
   })
D
donglin 已提交
605 606 607
```


M
m00512953 已提交
608
## appManager.killProcessWithAccount<sup>9+</sup>
D
donglin 已提交
609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629

killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCallback\<void\>): void

切断account进程(callback形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**需要权限**:ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS, ohos.permission.CLEAN_BACKGROUND_PROCESSES

**参数:**

  | 参数名 | 类型 | 必填 | 说明 | 
  | -------- | -------- | -------- | -------- |
  | bundleName | string | 是 | 应用包名。 | 
  | accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | 
  | callback | AsyncCallback\<void\> | 是 | 切断account进程的回调函数。 | 

**示例:**

M
m00512953 已提交
630
```ts
D
donglin 已提交
631 632 633 634 635 636 637 638 639
var bundleName = 'bundleName';
var accountId = 0;
function killProcessWithAccountCallback(err, data) {
   if (err) {
       console.log('------------- killProcessWithAccountCallback fail, err: --------------', err);
   } else {
       console.log('------------- killProcessWithAccountCallback success, data: --------------', data);
   }
}
M
m00512953 已提交
640
app.killProcessWithAccount(bundleName, accountId, killProcessWithAccountCallback);
D
donglin 已提交
641 642
```

M
m00512953 已提交
643
## appManager.killProcessesByBundleName<sup>9+</sup>
D
donglin 已提交
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658

killProcessesByBundleName(bundleName: string, callback: AsyncCallback\<void>);

通过包名终止进程。

**需要权限**:ohos.permission.CLEAN_BACKGROUND_PROCESSES

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**:该接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
D
fix  
donglin 已提交
659 660
| bundleName | string | 是 | 表示包名。 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法。 |
D
donglin 已提交
661 662 663

**示例:**
    
M
m00512953 已提交
664 665 666 667 668 669 670
  ```ts
  var bundleName = 'bundleName';
  function killProcessesByBundleNameCallback(err, data) {
    if (err) {
        console.log('------------- killProcessesByBundleNameCallback fail, err: --------------', err);
    } else {
        console.log('------------- killProcessesByBundleNameCallback success, data: --------------', data);
D
donglin 已提交
671
    }
M
m00512953 已提交
672 673
  }
  app.killProcessesByBundleName(bundleName, killProcessesByBundleNameCallback);
D
donglin 已提交
674 675
  ```

M
m00512953 已提交
676
## appManager.killProcessesByBundleName<sup>9+</sup>
D
donglin 已提交
677 678 679 680 681 682 683 684 685 686 687 688 689 690 691

killProcessesByBundleName(bundleName: string): Promise\<void>;

通过包名终止进程。

**需要权限**:ohos.permission.CLEAN_BACKGROUND_PROCESSES

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**:该接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
D
merge  
donglin 已提交
692
| bundleName | string | 是 | 表示包名。 |
D
donglin 已提交
693 694 695 696 697 698 699 700 701

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| Promise\<void> | 返回执行结果。 |

**示例:**
    
M
m00512953 已提交
702
  ```ts
D
donglin 已提交
703
var bundleName = 'bundleName';
M
m00512953 已提交
704
app.killProcessesByBundleName(bundleName)
D
donglin 已提交
705 706 707 708 709 710 711 712
   .then((data) => {
       console.log('------------ killProcessesByBundleName success ------------', data);
   })
   .catch((err) => {
       console.log('------------ killProcessesByBundleName fail ------------', err);
   })
  ```

M
m00512953 已提交
713
## appManager.clearUpApplicationData<sup>9+</sup>
D
donglin 已提交
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728

clearUpApplicationData(bundleName: string, callback: AsyncCallback\<void>);

通过包名清除应用数据。

**需要权限**:ohos.permission.CLEAN_APPLICATION_DATA

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**:该接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
D
fix  
donglin 已提交
729 730
| bundleName | string | 是 | 表示包名。 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法。 |
D
donglin 已提交
731 732 733

**示例:**
    
M
m00512953 已提交
734 735 736 737 738 739 740
  ```ts
  var bundleName = 'bundleName';
  function clearUpApplicationDataCallback(err, data) {
    if (err) {
        console.log('------------- clearUpApplicationDataCallback fail, err: --------------', err);
    } else {
        console.log('------------- clearUpApplicationDataCallback success, data: --------------', data);
D
donglin 已提交
741
    }
M
m00512953 已提交
742 743
  }
  app.clearUpApplicationData(bundleName, clearUpApplicationDataCallback);
D
donglin 已提交
744 745
  ```

M
m00512953 已提交
746
## appManager.clearUpApplicationData<sup>9+</sup>
D
donglin 已提交
747 748 749 750 751 752 753 754 755 756 757 758 759 760 761

clearUpApplicationData(bundleName: string): Promise\<void>;

通过包名清除应用数据。

**需要权限**:ohos.permission.CLEAN_APPLICATION_DATA

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**:该接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
D
fix  
donglin 已提交
762
| bundleName | string | 是 | 表示包名。 |
D
donglin 已提交
763 764 765 766 767 768 769 770 771

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| Promise\<void> | 返回执行结果。 |

**示例:**
    
M
m00512953 已提交
772
  ```ts
D
donglin 已提交
773
  var bundleName = 'bundleName';
M
m00512953 已提交
774 775
  app.clearUpApplicationData(bundleName)
    .then((data) => {
D
donglin 已提交
776
        console.log('------------ clearUpApplicationData success ------------', data);
M
m00512953 已提交
777 778
    })
    .catch((err) => {
D
donglin 已提交
779
        console.log('------------ clearUpApplicationData fail ------------', err);
M
m00512953 已提交
780
    })
D
donglin 已提交
781 782
  ```

M
m00512953 已提交
783
## ApplicationState<sup>9+</sup>
D
donglin 已提交
784 785 786 787 788

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

789
| 名称                 | 值  | 说明                               |
D
donglin 已提交
790 791 792 793 794 795 796
| -------------------- | --- | --------------------------------- |
| STATE_CREATE    | 1   |   当应用在创建中的时候处于的状态。         |
| STATE_FOREGROUND          | 2   |      当应用切换到前台的时候处于的状态。            |
| STATE_ACTIVE  | 3   |         当应用在获焦的时候处于的状态。     |
| STATE_BACKGROUND        | 4   |       当应用处于后台不可见时处于的状态。           |
| STATE_DESTROY        | 5   |           当应用在销毁的时候处于的状态。       |

M
m00512953 已提交
797
## ProcessState<sup>9+</sup>
D
donglin 已提交
798 799 800 801 802

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

803
| 名称                 | 值  | 说明                               |
D
donglin 已提交
804 805 806 807 808 809
| -------------------- | --- | --------------------------------- |
| STATE_CREATE    | 1   |      当进程在创建中的时候处于的状态。       |
| STATE_FOREGROUND          | 2   |            当进程切换到前台的时候处于的状态。      |
| STATE_ACTIVE  | 3   |          当进程在获焦的时候处于的状态。   |
| STATE_BACKGROUND        | 4   |       当进程处于后台不可见时处于的状态。           |
| STATE_DESTROY        | 5   |         当进程在销毁的时候处于的状态。         |