• 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-sys.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**系统接口**: 此接口为系统接口。
23
24| 名称 | 值 | 说明 |
25| -------- | -------- | -------- |
26| INITIAL | 0 | 表示Ability为初始化状态。|
27| FOREGROUND | 9 | 表示Ability处于前台。  |
28| BACKGROUND | 10 | 表示Ability处于后台。  |
29| FOREGROUNDING | 11 | 表示Ability处于前台调度中。  |
30| BACKGROUNDING | 12 | 表示Ability处于后台调度中。  |
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>                   | 是    | 回调函数，当通过修改配置来更新配置成功，err为undefined，否则为错误对象。      |
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| 参数名        | 类型                                       | 必填   | 说明             |
79| --------- | ---------------------------------------- | ---- | -------------- |
80| config    | [Configuration](js-apis-application-configuration.md)   | 是    | 新的配置项。 |
81
82**返回值：**
83
84| 类型                                       | 说明      |
85| ---------------------------------------- | ------- |
86| Promise\<void> | Promise对象。无返回结果的Promise对象。 |
87
88**示例**：
89
90```ts
91import abilityManager from '@ohos.application.abilityManager';
92import { Configuration } from '@ohos.application.Configuration';
93import { BusinessError } from '@ohos.base';
94
95let config: Configuration = {
96  language: 'chinese'
97};
98
99abilityManager.updateConfiguration(config).then(() => {
100  console.log('updateConfiguration success');
101}).catch((err: BusinessError) => {
102  console.error('updateConfiguration fail');
103});
104```
105
106## getAbilityRunningInfos
107
108getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): void
109
110获取Ability运行相关信息。使用callback异步回调。
111
112**需要权限**: ohos.permission.GET_RUNNING_INFO
113
114**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
115
116**系统接口**: 此接口为系统接口。
117
118**参数**：
119
120| 参数名        | 类型                                       | 必填   | 说明             |
121| --------- | ---------------------------------------- | ---- | -------------- |
122| callback  | AsyncCallback\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo-sys.md)>>  | 是    | 回调函数，返回Ability运行相关信息      |
123
124**示例**：
125
126```ts
127import abilityManager from '@ohos.application.abilityManager';
128import { BusinessError } from '@ohos.base';
129
130abilityManager.getAbilityRunningInfos((err: BusinessError, data) => {
131    console.log(`getAbilityRunningInfos err: ${err}, data: ${JSON.stringify(data)}`);
132});
133```
134
135## getAbilityRunningInfos
136
137getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>>
138
139获取Ability运行相关信息。使用Promise异步回调。
140
141**需要权限**: ohos.permission.GET_RUNNING_INFO
142
143**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
144
145**系统接口**: 此接口为系统接口。
146
147**返回值：**
148
149| 类型                                       | 说明      |
150| ---------------------------------------- | ------- |
151| Promise\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo-sys.md)>> | Promise对象，返回Ability运行相关信息。 |
152
153**示例**：
154
155```ts
156import abilityManager from '@ohos.application.abilityManager';
157import { BusinessError } from '@ohos.base';
158
159abilityManager.getAbilityRunningInfos().then((data) => {
160    console.log(`getAbilityRunningInfos  data: ${JSON.stringify(data)}`);
161}).catch((err: BusinessError) => {
162  console.error(`getAbilityRunningInfos err: ${JSON.stringify(err)}`);
163});
164```