• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# AbilityManager
2
3> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
4>
5> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
6>
7> API 9当前为Canary版本,仅供试用,不保证接口可稳定调用。
8
9# 导入模块
10
11```js
12import AbilityManager from '@ohos.application.abilityManager'
13```
14
15## AbilityState
16
17Ability的状态信息。
18
19**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
20
21| 名称 | 值 | 说明 |
22| -------- | -------- | -------- |
23| INITIAL | 0 | 表示ability为initial状态。|
24| FOREGROUND | 9 | 表示ability为foreground状态。  |
25| BACKGROUND | 10 | 表示ability为background状态。  |
26| FOREGROUNDING | 11 | 表示ability为foregrounding状态。  |
27| BACKGROUNDING | 12 | 表示ability为backgrounding状态。  |
28
29
30## updateConfiguration
31
32updateConfiguration(config: Configuration, callback: AsyncCallback\<void>): void
33
34通过修改配置来更新配置(callback形式)。
35
36**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
37
38**参数**:
39
40| 名称        | 类型                                       | 必填   | 描述             |
41| --------- | ---------------------------------------- | ---- | -------------- |
42| config    | Configuration                            | 是    | 新的配置项。 |
43| callback  | AsyncCallback\<void>                   | 是    | 被指定的回调方法。      |
44
45**示例**:
46
47```js
48import abilitymanager from '@ohos.application.abilityManager';
49
50var config = {
51  language: 'chinese'
52}
53
54abilitymanager.updateConfiguration(config, () => {
55    console.log('------------ updateConfiguration -----------');
56})
57```
58
59## updateConfiguration
60
61updateConfiguration(config: Configuration): Promise\<void>
62
63通过修改配置来更新配置(Promise形式)。
64
65**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
66
67**参数**:
68
69| 名称        | 类型                                       | 必填   | 描述             |
70| --------- | ---------------------------------------- | ---- | -------------- |
71| config    | Configuration                            | 是    | 新的配置项。 |
72
73**返回值:**
74
75| 类型                                       | 说明      |
76| ---------------------------------------- | ------- |
77| Promise\<void> | 返回执行结果。 |
78
79**示例**:
80
81```js
82import abilitymanager from '@ohos.application.abilityManager';
83
84var config = {
85  language: 'chinese'
86}
87
88abilitymanager.updateConfiguration(config).then(() => {
89  console.log('updateConfiguration success');
90}).catch((err) => {
91  console.log('updateConfiguration fail');
92})
93```
94
95## getAbilityRunningInfos
96
97getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): void
98
99获取Ability运行相关信息(callback形式)。
100
101**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
102
103**参数**:
104
105| 名称        | 类型                                       | 必填   | 描述             |
106| --------- | ---------------------------------------- | ---- | -------------- |
107| callback  | AsyncCallback\<Array\<AbilityRunningInfo>>  | 是    | 被指定的回调方法。      |
108
109**示例**:
110
111```js
112import abilitymanager from '@ohos.application.abilityManager';
113
114abilitymanager.getAbilityRunningInfos((err,data) => {
115    console.log("getAbilityRunningInfos err: "  + err + " data: " + JSON.stringify(data));
116});
117```
118
119## getAbilityRunningInfos
120
121getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>>
122
123获取Ability运行相关信息(Promise形式)。
124
125**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
126
127**返回值:**
128
129| 类型                                       | 说明      |
130| ---------------------------------------- | ------- |
131| Promise\<Array\<AbilityRunningInfo>> | 返回执行结果。 |
132
133**示例**:
134
135```js
136import abilitymanager from '@ohos.application.abilityManager';
137
138abilitymanager.getAbilityRunningInfos().then((data) => {
139    console.log("getAbilityRunningInfos  data: " + JSON.stringify(data))
140}).catch((err) => {
141  console.log("getAbilityRunningInfos err: "  + err)
142});
143```
144
145## getExtensionRunningInfos<sup>9+</sup>
146
147getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<ExtensionRunningInfo>>): void
148
149获取关于运行扩展能力的信息(callback形式)。
150
151**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
152
153**参数**:
154
155| 名称        | 类型                                       | 必填   | 描述             |
156| --------- | ---------------------------------------- | ---- | -------------- |
157| upperLimit | number                                   | 是 | 获取消息数量的最大限制。 |
158| callback  | AsyncCallback\<Array\<AbilityRunningInfo>>  | 是    | 被指定的回调方法。      |
159
160**示例**:
161
162```js
163import abilitymanager from '@ohos.application.abilityManager';
164
165var upperLimit = 0;
166
167abilitymanager.getExtensionRunningInfos(upperLimit, (err,data) => {
168    console.log("getExtensionRunningInfos err: "  + err + " data: " + JSON.stringify(data));
169});
170```
171
172## getExtensionRunningInfos<sup>9+</sup>
173
174getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningInfo>>
175
176获取关于运行扩展能力的信息(Promise形式)。
177
178**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
179
180**参数**:
181
182| 名称        | 类型                                       | 必填   | 描述             |
183| --------- | ---------------------------------------- | ---- | -------------- |
184| upperLimit | number                                   | 是 | 获取消息数量的最大限制。 |
185
186**返回值:**
187
188| 类型                                       | 说明      |
189| ---------------------------------------- | ------- |
190| Promise\<Array\<AbilityRunningInfo>> | 返回执行结果。 |
191
192**示例**:
193
194```js
195import abilitymanager from '@ohos.application.abilityManager';
196
197var upperLimit = 0;
198
199abilitymanager.getExtensionRunningInfos(upperLimit).then((data) => {
200  console.log("getAbilityRunningInfos data: " + JSON.stringify(data));
201}).catch((err) => {
202  console.log("getAbilityRunningInfos err: "  + err);
203})
204```