• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# AbilityStateData
2
3<!--Kit: Ability Kit-->
4<!--Subsystem: Ability-->
5<!--Owner: @zhu-feimo-->
6<!--Designer: @ccllee1-->
7<!--Tester: @lixueqing513-->
8<!--Adviser: @huipeizi-->
9AbilityStateData是Ability状态信息的数据结构。使用[on](js-apis-app-ability-appManager.md#appmanageronapplicationstate14)注册生命周期变化监听后,可以通过[ApplicationStateObserver](js-apis-inner-application-applicationStateObserver.md)的onAbilityStateChanged回调的入参获取该数据结构。
10
11> **说明:**
12>
13> 本模块首批接口从API version 14开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
14
15## 导入模块
16
17```ts
18import { appManager } from '@kit.AbilityKit';
19```
20
21## AbilityStateData
22
23
24**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
25
26| 名称                     | 类型     | 只读 | 可选 | 说明                       |
27| ----------------------- | ---------| ---- | ---- | ------------------------- |
28| pid                     | number   | 否   | 否   | 进程ID。                    |
29| bundleName              | string   | 否   | 否  | 应用Bundle名称。          |
30| abilityName            | string   | 否   | 否   | Ability名称。               |
31| uid                    | number   | 否   | 否   | 所属应用程序的UID。                  |
32| state                   | number   | 否   | 否   | Ability状态。<br>- Stage模型:[UIAbility](js-apis-app-ability-uiAbility.md)的状态参见[UIAbility状态](#uiability状态);[ExtensionAbility](js-apis-app-ability-extensionAbility.md)的状态参见[ExtensionAbility状态](#extensionability状态)。<br>- FA模型:参见[Ability状态](#ability状态)。                |
33| moduleName | string   | 否   | 否   | Ability所属的模块名称。    |
34| abilityType | number | 否   | 否   | [Ability类型](#ability类型):[UIAbility](js-apis-app-ability-uiAbility.md)或[ExtensionAbility](js-apis-app-ability-extensionAbility.md)等。 |
35| isAtomicService | boolean | 否 | 否 | 判断Ability所属应用是否为原子化服务。<br>true: 是原子化服务。<br>false: 不是原子化服务。 |
36| appCloneIndex          | number   | 否   | 是   | 应用包的[分身](../../quick-start/app-clone.md)索引标识。                  |
37
38### UIAbility状态
39
40| 值   | 状态                       | 说明                   |
41| ---- | -------------------------- | ---------------------- |
42| 0    | ABILITY_STATE_CREATE       | UIAbility正在创建中。      |
43| 1    | ABILITY_STATE_READY        | UIAbility已创建完成。      |
44| 2    | ABILITY_STATE_FOREGROUND   | UIAbility处于前台。        |
45| 3    | ABILITY_STATE_FOCUS        | UIAbility已获得焦点。        |
46| 4    | ABILITY_STATE_BACKGROUND   | UIAbility处于后台。        |
47| 5    | ABILITY_STATE_TERMINATED   | UIAbility已经销毁。        |
48
49### ExtensionAbility状态
50| 值   | 状态    | 说明                  |
51| ---- | -------------------------- | ---------------------- |
52| 0    | EXTENSION_STATE_CREATE     | ExtensionAbility正在创建中。  |
53| 1    | EXTENSION_STATE_READY      | ExtensionAbility已创建完成。  |
54| 2    | EXTENSION_STATE_CONNECTED  | ExtensionAbility已与客户端建立连接。 |
55| 3    | EXTENSION_STATE_DISCONNECTED | ExtensionAbility与客户端断开连接。 |
56| 4    | EXTENSION_STATE_TERMINATED  | ExtensionAbility已经销毁。  |
57
58### Ability状态
59
60| 值   | 状态                       | 说明                   |
61| ---- | -------------------------- | ---------------------- |
62| 0    | ABILITY_STATE_CREATE       | Ability正在创建中。      |
63| 1    | ABILITY_STATE_READY        | Ability已创建完成。      |
64| 2    | ABILITY_STATE_FOREGROUND   | Ability处于前台。        |
65| 3    | ABILITY_STATE_FOCUS        | Ability已获得焦点。       |
66| 4    | ABILITY_STATE_BACKGROUND   | Ability处于后台。        |
67| 5    | ABILITY_STATE_TERMINATED   | Ability已经销毁。        |
68| 7    | ABILITY_STATE_CONNECTED    | 后台服务已被客户端连接。 |
69| 8    | ABILITY_STATE_DISCONNECTED | 后台服务与客户端断开连接。 |
70
71### Ability类型
72
73| 值   | 状态    | 说明                  |
74| ---- | ------- | --------------------- |
75| 0    | UNKNOWN | 未知类型。(系统错误)              |
76| 1    | PAGE    | UI界面类型的Ability,即[UIAbility](js-apis-app-ability-uiAbility.md)。  |
77| 2    | SERVICE | 后台服务类型的Ability。(FA模型) |
78| 3    | DATA | 数据类型的Ability。(FA模型)               |
79| 4    | FORM    | 卡片类型的Ability。(FA模型)    |
80| 5    | EXTENSION | 扩展类型的Ability。(Stage模型)  |
81