• 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```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';
53import { Configuration } from '@ohos.application.Configuration';
54
55let config: Configuration = {
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';
90import { Configuration } from '@ohos.application.Configuration';
91import { BusinessError } from '@ohos.base';
92
93let config: Configuration = {
94  language: 'chinese'
95};
96
97abilityManager.updateConfiguration(config).then(() => {
98  console.log('updateConfiguration success');
99}).catch((err: BusinessError) => {
100  console.error('updateConfiguration fail');
101});
102```
103
104## getAbilityRunningInfos
105
106getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): void
107
108获取Ability运行相关信息（callback形式）。
109
110**需要权限**: ohos.permission.GET_RUNNING_INFO
111
112**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
113
114**参数**：
115
116| 参数名        | 类型                                       | 必填   | 说明             |
117| --------- | ---------------------------------------- | ---- | -------------- |
118| callback  | AsyncCallback\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)>>  | 是    | 被指定的回调方法。      |
119
120**示例**：
121
122```ts
123import abilityManager from '@ohos.application.abilityManager';
124
125abilityManager.getAbilityRunningInfos((err,data) => {
126    console.log(`getAbilityRunningInfos err: ${err}, data: ${JSON.stringify(data)}`);
127});
128```
129
130## getAbilityRunningInfos
131
132getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>>
133
134获取Ability运行相关信息（Promise形式）。
135
136**需要权限**: ohos.permission.GET_RUNNING_INFO
137
138**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
139
140**返回值：**
141
142| 类型                                       | 说明      |
143| ---------------------------------------- | ------- |
144| Promise\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)>> | 返回执行结果。 |
145
146**示例**：
147
148```ts
149import abilityManager from '@ohos.application.abilityManager';
150import { BusinessError } from '@ohos.base';
151
152abilityManager.getAbilityRunningInfos().then((data) => {
153    console.log(`getAbilityRunningInfos  data: ${JSON.stringify(data)}`);
154}).catch((err: BusinessError) => {
155  console.error(`getAbilityRunningInfos err: ${JSON.stringify(err)}`);
156});
157```