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