• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.application.abilityManager (AbilityManager)
2
3AbilityManager模块提供对Ability相关信息和状态信息进行获取、新增、修改等能力。
4
5> **说明：**
6>
7> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8> 本模块接口均为系统接口，三方应用不支持调用。
9
10## 导入模块
11
12```ts
13import AbilityManager from '@ohos.application.abilityManager';
14```
15
16## AbilityState
17
18Ability的状态信息。
19
20**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
21
22**系统API**: 此接口为系统接口，三方应用不支持调用。
23
24| 名称 | 值 | 说明 |
25| -------- | -------- | -------- |
26| INITIAL | 0 | 表示ability为initial状态。|
27| FOREGROUND | 9 | 表示ability为foreground状态。  |
28| BACKGROUND | 10 | 表示ability为background状态。  |
29| FOREGROUNDING | 11 | 表示ability为foregrounding状态。  |
30| BACKGROUNDING | 12 | 表示ability为backgrounding状态。  |
31
32## updateConfiguration
33
34updateConfiguration(config: Configuration, callback: AsyncCallback\<void>): void
35
36通过修改配置来更新配置（callback形式）。
37
38**需要权限**: ohos.permission.UPDATE_CONFIGURATION
39
40**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
41
42**参数**：
43
44| 参数名        | 类型                                       | 必填   | 说明             |
45| --------- | ---------------------------------------- | ---- | -------------- |
46| config    | [Configuration](js-apis-application-configuration.md)   | 是    | 新的配置项。 |
47| callback  | AsyncCallback\<void>                   | 是    | 被指定的回调方法。      |
48
49**示例**：
50
51```ts
52import abilitymanager from '@ohos.application.abilityManager';
53
54let config = {
55  language: 'chinese'
56};
57
58abilitymanager.updateConfiguration(config, () => {
59    console.log('------------ updateConfiguration -----------');
60})
61```
62
63## updateConfiguration
64
65updateConfiguration(config: Configuration): Promise\<void>
66
67通过修改配置来更新配置（Promise形式）。
68
69**需要权限**: ohos.permission.UPDATE_CONFIGURATION
70
71**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
72
73**参数**：
74
75| 参数名        | 类型                                       | 必填   | 说明             |
76| --------- | ---------------------------------------- | ---- | -------------- |
77| config    | [Configuration](js-apis-application-configuration.md)   | 是    | 新的配置项。 |
78
79**返回值：**
80
81| 类型                                       | 说明      |
82| ---------------------------------------- | ------- |
83| Promise\<void> | 返回执行结果。 |
84
85**示例**：
86
87```ts
88import abilitymanager from '@ohos.application.abilityManager';
89
90let config = {
91  language: 'chinese'
92};
93
94abilitymanager.updateConfiguration(config).then(() => {
95  console.log('updateConfiguration success');
96}).catch((err) => {
97  console.log('updateConfiguration fail');
98})
99```
100
101## getAbilityRunningInfos
102
103getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): void
104
105获取Ability运行相关信息（callback形式）。
106
107**需要权限**: ohos.permission.GET_RUNNING_INFO
108
109**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
110
111**参数**：
112
113| 参数名        | 类型                                       | 必填   | 说明             |
114| --------- | ---------------------------------------- | ---- | -------------- |
115| callback  | AsyncCallback\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)>>  | 是    | 被指定的回调方法。      |
116
117**示例**：
118
119```ts
120import abilitymanager from '@ohos.application.abilityManager';
121
122abilitymanager.getAbilityRunningInfos((err,data) => {
123    console.log("getAbilityRunningInfos err: "  + err + " data: " + JSON.stringify(data));
124});
125```
126
127## getAbilityRunningInfos
128
129getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>>
130
131获取Ability运行相关信息（Promise形式）。
132
133**需要权限**: ohos.permission.GET_RUNNING_INFO
134
135**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
136
137**返回值：**
138
139| 类型                                       | 说明      |
140| ---------------------------------------- | ------- |
141| Promise\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)>> | 返回执行结果。 |
142
143**示例**：
144
145```ts
146import abilitymanager from '@ohos.application.abilityManager';
147
148abilitymanager.getAbilityRunningInfos().then((data) => {
149    console.log("getAbilityRunningInfos  data: " + JSON.stringify(data));
150}).catch((err) => {
151  console.log("getAbilityRunningInfos err: "  + err);
152});
153```