js-apis-application-appManager.md 22.4 KB
Newer Older
Z
zengyawen 已提交
1
# @ohos.application.appManager (appManager)
ahjxliubao2's avatar
ahjxliubao2 已提交
2

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

Y
yuyaozhi 已提交
5 6
> **说明:**
> 
D
merge  
donglin 已提交
7
> 本模块首批接口从API version 7 开始支持,从API version 9废弃,替换模块为[@ohos.app.ability.appManager](js-apis-app-ability-appManager.md)。后续版本的新增接口,采用上角标单独标记接口的起始版本。
ahjxliubao2's avatar
ahjxliubao2 已提交
8 9 10

## 导入模块

M
m00512953 已提交
11
```ts
D
donglin 已提交
12
import appManager from '@ohos.application.appManager';
ahjxliubao2's avatar
ahjxliubao2 已提交
13 14
```

M
m00512953 已提交
15
## appManager.isRunningInStabilityTest<sup>8+</sup>
ahjxliubao2's avatar
ahjxliubao2 已提交
16 17 18

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

W
wusongqing 已提交
19
查询当前是否处于稳定性测试场景。
ahjxliubao2's avatar
ahjxliubao2 已提交
20

Y
yuyaozhi 已提交
21 22 23 24 25
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**参数:**

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

Y
yuyaozhi 已提交
29
**示例:**
ahjxliubao2's avatar
ahjxliubao2 已提交
30
    
M
m00512953 已提交
31
  ```ts
D
donglin 已提交
32 33 34
  appManager.isRunningInStabilityTest((err, flag) => {
    console.log('error:' + JSON.stringfy(err));
    console.log('The result of isRunningInStabilityTest is:' + JSON.stringify(flag));
Y
yuyaozhi 已提交
35
  })  
ahjxliubao2's avatar
ahjxliubao2 已提交
36 37 38
  ```


M
m00512953 已提交
39
## appManager.isRunningInStabilityTest<sup>8+</sup>
ahjxliubao2's avatar
ahjxliubao2 已提交
40 41 42 43 44

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

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

Y
yuyaozhi 已提交
45 46 47 48 49
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**返回值:**

  | 类型 | 说明 | 
ahjxliubao2's avatar
ahjxliubao2 已提交
50 51 52
  | -------- | -------- |
  | Promise&lt;boolean&gt; | 返回当前是否处于稳定性测试场景。 | 

Y
yuyaozhi 已提交
53
**示例:**
ahjxliubao2's avatar
ahjxliubao2 已提交
54
    
M
m00512953 已提交
55
  ```ts
D
donglin 已提交
56 57
  appManager.isRunningInStabilityTest().then((flag) => {
      console.log('The result of isRunningInStabilityTest is:' + JSON.stringify(flag));
Y
yuyaozhi 已提交
58
  }).catch((error) => {
D
donglin 已提交
59
      console.log('error:' + JSON.stringify(error));
ahjxliubao2's avatar
ahjxliubao2 已提交
60 61
  });
  ```
62 63 64 65 66 67


## appManager.isRamConstrainedDevice

isRamConstrainedDevice(): Promise\<boolean>;

R
RayShih 已提交
68
查询是否为ram受限设备。
69 70 71 72 73 74 75 76 77 78 79

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

**返回值:**

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

**示例:**
    
M
m00512953 已提交
80
  ```ts
D
donglin 已提交
81 82
  appManager.isRamConstrainedDevice().then((data) => {
      console.log('The result of isRamConstrainedDevice is:' + JSON.stringify(data));
M
m00512953 已提交
83
  }).catch((error) => {
D
donglin 已提交
84
      console.log('error:' + JSON.stringify(error));
M
m00512953 已提交
85
  });
86 87 88 89 90 91
  ```

## appManager.isRamConstrainedDevice

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

R
RayShih 已提交
92
查询是否为ram受限设备。
93 94 95 96 97 98 99

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

**参数:**

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

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

## appManager.getAppMemorySize

getAppMemorySize(): Promise\<number>;

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

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

**返回值:**

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

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

## appManager.getAppMemorySize

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

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

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

**参数:**

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

**示例:**
    
M
m00512953 已提交
151
  ```ts
D
donglin 已提交
152 153 154
  appManager.getAppMemorySize((err, data) => {
      console.log('error:' + JSON.stringify(err));
      console.log('The size of app memory is:' + JSON.stringify(data));
M
m00512953 已提交
155
  })
156
  ```
D
dy_study 已提交
157 158
## appManager.getProcessRunningInfos<sup>(deprecated)</sup>

Z
zengyawen 已提交
159
getProcessRunningInfos(): Promise\<Array\<ProcessRunningInfo>>;
160 161 162

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

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

Y
yuyaozhi 已提交
165 166
**需要权限**:ohos.permission.GET_RUNNING_INFO

167 168 169 170
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**返回值:**

Z
zengyawen 已提交
171 172
| 类型 | 说明 |
| -------- | -------- |
M
m00512953 已提交
173
| Promise\<Array\<[ProcessRunningInfo](js-apis-inner-application-processRunningInfo.md)>> | 获取有关运行进程的信息。 |
174 175 176

**示例:**
    
M
m00512953 已提交
177
  ```ts
D
donglin 已提交
178 179
  appManager.getProcessRunningInfos().then((data) => {
      console.log('The process running infos is:' + JSON.stringify(data));
M
m00512953 已提交
180
  }).catch((error) => {
D
donglin 已提交
181
      console.log('error:' + JSON.stringify(error));
M
m00512953 已提交
182
  });
183 184
  ```

D
dy_study 已提交
185 186
## appManager.getProcessRunningInfos<sup>(deprecated)</sup>

Z
zengyawen 已提交
187
getProcessRunningInfos(callback: AsyncCallback\<Array\<ProcessRunningInfo>>): void;
188 189 190

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

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

Y
yuyaozhi 已提交
193 194
**需要权限**:ohos.permission.GET_RUNNING_INFO

195 196 197 198
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**参数:**

Z
zengyawen 已提交
199 200
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
201
| callback | AsyncCallback\<Array\<[ProcessRunningInfo](js-apis-inner-application-processRunningInfo.md)>> | 是 | 获取有关运行进程的信息。 |
202 203 204

**示例:**
    
M
m00512953 已提交
205
  ```ts
D
donglin 已提交
206 207 208
  appManager.getProcessRunningInfos((err, data) => {
      console.log('error:' + JSON.stringify(err));
      console.log('The process running infos is:' + JSON.stringify(data));
M
m00512953 已提交
209
  })
210
  ```
211

D
dy_study 已提交
212 213 214 215 216 217 218 219 220 221 222 223 224 225
## appManager.getProcessRunningInformation<sup>9+</sup>

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

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

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

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

**返回值:**

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

**示例:**
    
M
m00512953 已提交
230
  ```ts
D
donglin 已提交
231 232
  appManager.getProcessRunningInformation().then((data) => {
      console.log('The process running info is:' + JSON.stringify(data));
M
m00512953 已提交
233
  }).catch((error) => {
D
donglin 已提交
234
      console.log('error:' + JSON.stringify(error));
M
m00512953 已提交
235
  });
D
dy_study 已提交
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
  ```

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

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

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

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

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

**参数:**

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

**示例:**
    
M
m00512953 已提交
256
  ```ts
D
donglin 已提交
257 258 259
  appManager.getProcessRunningInformation((err, data) => {
      console.log('error:' + JSON.stringify(err));
      console.log('The process running info is:' + JSON.stringify(data));
M
m00512953 已提交
260
  })
D
dy_study 已提交
261 262
  ```

263 264 265 266
## appManager.registerApplicationStateObserver<sup>8+</sup>

registerApplicationStateObserver(observer: ApplicationStateObserver): number;

Z
zhoushicheng 已提交
267
注册全部应用程序状态观测器。
268 269 270 271 272 273 274 275 276 277 278

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

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
D
merge  
donglin 已提交
279
| observer | [ApplicationStateObserver](js-apis-inner-application-applicationStateObserver.md) | 是 | 返回观察者的数字代码。 |
280 281 282

**示例:**
    
M
m00512953 已提交
283
  ```ts
284 285 286 287 288 289 290 291 292 293 294 295
  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);
Y
yuyaozhi 已提交
296 297 298
    },
    onProcessStateChanged(processData) {
        console.log('------------ onProcessStateChanged -----------', processData);
299 300
    }
  }
D
donglin 已提交
301
  const observerCode = appManager.registerApplicationStateObserver(applicationStateObserver);
302
  console.log('-------- observerCode: ---------', observerCode);
Z
zhoushicheng 已提交
303 304 305 306
  ```

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

Y
yuyaozhi 已提交
307
registerApplicationStateObserver(observer: ApplicationStateObserver, bundleNameList: Array\<string>): number;
Z
zhoushicheng 已提交
308 309 310 311 312 313 314 315 316 317 318 319 320

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

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

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
D
merge  
donglin 已提交
321 322
| observer | [ApplicationStateObserver](js-apis-inner-application-applicationStateObserver.md) | 是 | 返回观察者的数字代码。 |
| bundleNameList | Array<string> | 是 | 表示需要注册监听的bundleName数组。最大值128。 |
Z
zhoushicheng 已提交
323 324 325

**示例:**
    
M
m00512953 已提交
326
  ```ts
Z
zhoushicheng 已提交
327 328 329 330 331 332 333 334 335 336 337 338
  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);
Y
yuyaozhi 已提交
339 340 341
    },
    onProcessStateChanged(processData) {
        console.log('------------ onProcessStateChanged -----------', processData);
Z
zhoushicheng 已提交
342 343 344
    }
  }
  var bundleNameList = ['bundleName1', 'bundleName2'];
D
donglin 已提交
345
  const observerCode = appManager.registerApplicationStateObserver(applicationStateObserver, bundleNameList);
Z
zhoushicheng 已提交
346
  console.log('-------- observerCode: ---------', observerCode);
347 348 349 350 351 352 353 354 355 356 357 358 359 360
  ```
## appManager.unregisterApplicationStateObserver<sup>8+</sup>

unregisterApplicationStateObserver(observerId: number,  callback: AsyncCallback\<void>): void;

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

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

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

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

**参数:**
361

362 363
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
D
merge  
donglin 已提交
364 365
| observerId | number | 是 | 表示观察者的编号代码。 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法。 |
366 367 368

**示例:**
    
M
m00512953 已提交
369 370
  ```ts
  var observerId = 100;
371

M
m00512953 已提交
372 373 374
  function unregisterApplicationStateObserverCallback(err) {
    if (err) {
        console.log('------------ unregisterApplicationStateObserverCallback ------------', err);
375
    }
M
m00512953 已提交
376
  }
D
donglin 已提交
377
  appManager.unregisterApplicationStateObserver(observerId, unregisterApplicationStateObserverCallback);
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
  ```

## appManager.unregisterApplicationStateObserver<sup>8+</sup>

unregisterApplicationStateObserver(observerId: number): Promise\<void>;

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

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

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
D
merge  
donglin 已提交
396
| observerId | number | 是 | 表示观察者的编号代码。 |
397 398 399 400 401 402 403 404 405

**返回值:**

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

**示例:**
    
M
m00512953 已提交
406 407 408
  ```ts
  var observerId = 100;

D
donglin 已提交
409
  appManager.unregisterApplicationStateObserver(observerId)
M
m00512953 已提交
410 411 412 413 414 415
  .then((data) => {
      console.log('----------- unregisterApplicationStateObserver success ----------', data);
  })
  .catch((err) => {
      console.log('----------- unregisterApplicationStateObserver fail ----------', err);
  })
416 417 418 419 420 421
  ```

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

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

M
m00512953 已提交
422 423
获取所有当前处于前台的应用信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。
  
424 425 426 427 428 429 430 431 432 433
**需要权限**:ohos.permission.GET_RUNNING_INFO

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
434
| callback | AsyncCallback\<Array\<[AppStateData](js-apis-inner-application-appStateData.md)>> | 是 | callback形式返回所有当前处于前台的应用信息。 |
435 436 437

**示例:**
    
M
m00512953 已提交
438 439 440 441 442 443
  ```ts
  function getForegroundApplicationsCallback(err, data) {
    if (err) {
        console.log('--------- getForegroundApplicationsCallback fail ---------', err);
    } else {
        console.log('--------- getForegroundApplicationsCallback success ---------', data)
444
    }
M
m00512953 已提交
445
  }
D
donglin 已提交
446
  appManager.getForegroundApplications(getForegroundApplicationsCallback);
447 448 449 450
  ```

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

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

M
m00512953 已提交
453
获取所有当前处于前台的应用信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。
454 455 456 457 458 459 460 461 462 463 464

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

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

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

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
M
m00512953 已提交
465
| Promise\<Array\<[AppStateData](js-apis-inner-application-appStateData.md)>> | Promise形式返回所有当前处于前台的应用信息。 |
466 467 468

**示例:**
    
M
m00512953 已提交
469
  ```ts
D
donglin 已提交
470
  appManager.getForegroundApplications()
M
m00512953 已提交
471 472 473 474 475 476
  .then((data) => {
      console.log('--------- getForegroundApplications success -------', data);
  })
  .catch((err) => {
      console.log('--------- getForegroundApplications fail -------', err);
  })
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
  ```

## appManager.killProcessWithAccount<sup>8+</sup>

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**: 此接口为系统接口,三方应用不支持调用。

**参数:**

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

**示例:**

M
m00512953 已提交
500
```ts
501 502
var bundleName = 'bundleName';
var accountId = 0;
D
donglin 已提交
503
appManager.killProcessWithAccount(bundleName, accountId)
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
   .then((data) => {
       console.log('------------ killProcessWithAccount success ------------', data);
   })
   .catch((err) => {
       console.log('------------ killProcessWithAccount fail ------------', err);
   })
```


## appManager.killProcessWithAccount<sup>8+</sup>

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

**参数:**

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

**示例:**

M
m00512953 已提交
535
```ts
536 537 538 539 540 541 542 543 544
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);
   }
}
D
donglin 已提交
545
appManager.killProcessWithAccount(bundleName, accountId, killProcessWithAccountCallback);
546 547 548 549 550 551
```

## appManager.killProcessesByBundleName<sup>8+</sup>

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

552
通过Bundle名称终止进程。
553 554 555 556 557 558 559 560 561 562 563

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

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
564
| bundleName | string | 是 | 表示Bundle名称。 |
D
merge  
donglin 已提交
565
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法。 |
566 567 568

**示例:**
    
M
m00512953 已提交
569 570 571 572 573 574 575
  ```ts
  var bundleName = 'bundleName';
  function killProcessesByBundleNameCallback(err, data) {
    if (err) {
        console.log('------------- killProcessesByBundleNameCallback fail, err: --------------', err);
    } else {
        console.log('------------- killProcessesByBundleNameCallback success, data: --------------', data);
576
    }
M
m00512953 已提交
577
  }
D
donglin 已提交
578
  appManager.killProcessesByBundleName(bundleName, killProcessesByBundleNameCallback);
579 580 581 582 583 584
  ```

## appManager.killProcessesByBundleName<sup>8+</sup>

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

585
通过Bundle名称终止进程。
586 587 588 589 590 591 592 593 594 595 596

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

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
597
| bundleName | string | 是 | 表示Bundle名称。 |
598 599 600 601 602 603 604 605

**返回值:**

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

**示例:**
606

M
m00512953 已提交
607
  ```ts
608
  var bundleName = 'com.example.myapplication';
D
donglin 已提交
609
  appManager.killProcessesByBundleName(bundleName)
M
m00512953 已提交
610 611 612 613 614 615
    .then((data) => {
        console.log('------------ killProcessesByBundleName success ------------', data);
    })
    .catch((err) => {
        console.log('------------ killProcessesByBundleName fail ------------', err);
    })
616 617 618 619
  ```

## appManager.clearUpApplicationData<sup>8+</sup>

Y
yuyaozhi 已提交
620
clearUpApplicationData(bundleName: string, callback: AsyncCallback\<void>);
621

622
通过Bundle名称清除应用数据。
623 624 625 626 627 628 629 630 631 632 633

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

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
634
| bundleName | string | 是 | 表示Bundle名称。 |
D
merge  
donglin 已提交
635
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法。 |
636 637 638

**示例:**
    
M
m00512953 已提交
639 640 641 642 643 644 645
  ```ts
  var bundleName = 'bundleName';
  function clearUpApplicationDataCallback(err, data) {
    if (err) {
        console.log('------------- clearUpApplicationDataCallback fail, err: --------------', err);
    } else {
        console.log('------------- clearUpApplicationDataCallback success, data: --------------', data);
646
    }
M
m00512953 已提交
647
  }
D
donglin 已提交
648
  appManager.clearUpApplicationData(bundleName, clearUpApplicationDataCallback);
649 650 651 652
  ```

## appManager.clearUpApplicationData<sup>8+</sup>

Y
yuyaozhi 已提交
653
clearUpApplicationData(bundleName: string): Promise\<void>;
654

655
通过Bundle名称清除应用数据。
656 657 658 659 660 661 662 663 664 665 666

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

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
667
| bundleName | string | 是 | 表示Bundle名称。 |
668 669 670 671 672 673 674 675 676

**返回值:**

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

**示例:**
    
M
m00512953 已提交
677
  ```ts
678
  var bundleName = 'bundleName';
D
donglin 已提交
679
  appManager.clearUpApplicationData(bundleName)
680 681 682 683 684 685 686 687
    .then((data) => {
        console.log('------------ clearUpApplicationData success ------------', data);
    })
    .catch((err) => {
        console.log('------------ clearUpApplicationData fail ------------', err);
    })
  ```

Y
yuyaozhi 已提交
688 689 690 691 692 693
## ApplicationState<sup>9+</sup>

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

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

D
merge  
donglin 已提交
694
| 名称                 | 值  | 说明                               |
Y
yuyaozhi 已提交
695 696 697 698 699 700 701 702 703 704 705 706 707
| -------------------- | --- | --------------------------------- |
| STATE_CREATE    | 1   |   当应用在创建中的时候处于的状态。         |
| STATE_FOREGROUND          | 2   |      当应用切换到前台的时候处于的状态。            |
| STATE_ACTIVE  | 3   |         当应用在获焦的时候处于的状态。     |
| STATE_BACKGROUND        | 4   |       当应用处于后台不可见时处于的状态。           |
| STATE_DESTROY        | 5   |           当应用在销毁的时候处于的状态。       |

## ProcessState<sup>9+</sup>

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

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

D
merge  
donglin 已提交
708
| 名称                 | 值  | 说明                               |
Y
yuyaozhi 已提交
709 710 711 712 713
| -------------------- | --- | --------------------------------- |
| STATE_CREATE    | 1   |      当进程在创建中的时候处于的状态。       |
| STATE_FOREGROUND          | 2   |            当进程切换到前台的时候处于的状态。      |
| STATE_ACTIVE  | 3   |          当进程在获焦的时候处于的状态。   |
| STATE_BACKGROUND        | 4   |       当进程处于后台不可见时处于的状态。           |
M
m00512953 已提交
714
| STATE_DESTROY        | 5   |         当进程在销毁的时候处于的状态。         |