js-apis-application-abilityManager.md 8.2 KB
Newer Older
Z
zengyawen 已提交
1
# @ohos.application.abilityManager (AbilityManager)
Y
yuyaozhi 已提交
2 3 4 5 6

AbilityManager模块提供对Ability相关信息和状态信息进行获取、新增、修改等能力。

> **说明:**
>
D
donglin 已提交
7
> 本模块首批接口从API version 8开始支持,从API version 9废弃,替换模块为[@ohos.app.ability.abilityManager](js-apis-app-ability-abilityManager.md)。后续版本的新增接口,采用上角标单独标记接口的起始版本。  
Y
yuyaozhi 已提交
8 9
> 本模块接口均为系统接口,三方应用不支持调用。

10
## 导入模块
Y
yuyaozhi 已提交
11

M
m00512953 已提交
12
```ts
D
donglin 已提交
13
import abilityManager from '@ohos.application.abilityManager'
Y
yuyaozhi 已提交
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
```

## AbilityState

Ability的状态信息。

**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

| 名称 | 值 | 说明 | 
| -------- | -------- | -------- |
| INITIAL | 0 | 表示ability为initial状态。| 
| FOREGROUND | 9 | 表示ability为foreground状态。  | 
| BACKGROUND | 10 | 表示ability为background状态。  | 
| FOREGROUNDING | 11 | 表示ability为foregrounding状态。  | 
| BACKGROUNDING | 12 | 表示ability为backgrounding状态。  | 

## updateConfiguration

updateConfiguration(config: Configuration, callback: AsyncCallback\<void>): void

通过修改配置来更新配置(callback形式)。

**需要权限**: ohos.permission.UPDATE_CONFIGURATION

**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
 
**参数**

D
fix  
donglin 已提交
44
| 参数名        | 类型                                       | 必填   | 说明             |
Y
yuyaozhi 已提交
45
| --------- | ---------------------------------------- | ---- | -------------- |
M
m00512953 已提交
46
| config    | [Configuration](js-apis-application-configuration.md)   | 是    | 新的配置项。 |
Y
yuyaozhi 已提交
47 48 49 50
| callback  | AsyncCallback\<void>                   | 是    | 被指定的回调方法。      |

**示例**

M
m00512953 已提交
51
```ts
Y
yuyaozhi 已提交
52 53 54 55
var config = {
  language: 'chinese' 
}

D
donglin 已提交
56
abilityManager.updateConfiguration(config, () => {
Y
yuyaozhi 已提交
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
    console.log('------------ updateConfiguration -----------');
})
```

## updateConfiguration

updateConfiguration(config: Configuration): Promise\<void>

通过修改配置来更新配置(Promise形式)。

**需要权限**: ohos.permission.UPDATE_CONFIGURATION

**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

**参数**

D
fix  
donglin 已提交
73
| 参数名        | 类型                                       | 必填   | 说明             |
Y
yuyaozhi 已提交
74
| --------- | ---------------------------------------- | ---- | -------------- |
M
m00512953 已提交
75
| config    | [Configuration](js-apis-application-configuration.md)   | 是    | 新的配置项。 |
Y
yuyaozhi 已提交
76 77 78 79 80 81 82 83 84

**返回值:**

| 类型                                       | 说明      |
| ---------------------------------------- | ------- |
| Promise\<void> | 返回执行结果。 |

**示例**

M
m00512953 已提交
85
```ts
Y
yuyaozhi 已提交
86 87 88 89
var config = {
  language: 'chinese' 
}

D
donglin 已提交
90
abilityManager.updateConfiguration(config).then(() => {
Y
yuyaozhi 已提交
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
  console.log('updateConfiguration success');
}).catch((err) => {
  console.log('updateConfiguration fail');
})
```

## getAbilityRunningInfos

getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): void

获取Ability运行相关信息(callback形式)。

**需要权限**: ohos.permission.GET_RUNNING_INFO

**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

**参数**

D
fix  
donglin 已提交
109
| 参数名        | 类型                                       | 必填   | 说明             |
Y
yuyaozhi 已提交
110
| --------- | ---------------------------------------- | ---- | -------------- |
M
m00512953 已提交
111
| callback  | AsyncCallback\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)>>  | 是    | 被指定的回调方法。      |
Y
yuyaozhi 已提交
112 113 114

**示例**

M
m00512953 已提交
115
```ts
D
donglin 已提交
116
abilityManager.getAbilityRunningInfos((err,data) => { 
Y
yuyaozhi 已提交
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
    console.log("getAbilityRunningInfos err: "  + err + " data: " + JSON.stringify(data));
});
```

## getAbilityRunningInfos

getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>>

获取Ability运行相关信息(Promise形式)。

**需要权限**: ohos.permission.GET_RUNNING_INFO

**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

**返回值:**

| 类型                                       | 说明      |
| ---------------------------------------- | ------- |
M
m00512953 已提交
135
| Promise\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)>> | 返回执行结果。 |
Y
yuyaozhi 已提交
136 137 138

**示例**

M
m00512953 已提交
139
```ts
D
donglin 已提交
140
abilityManager.getAbilityRunningInfos().then((data) => {
Y
yuyaozhi 已提交
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
    console.log("getAbilityRunningInfos  data: " + JSON.stringify(data))
}).catch((err) => {
  console.log("getAbilityRunningInfos err: "  + err)
});
```

## getExtensionRunningInfos<sup>9+</sup>

getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<ExtensionRunningInfo>>): void

获取关于运行扩展能力的信息(callback形式)。

**需要权限**: ohos.permission.GET_RUNNING_INFO

**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

**参数**

D
fix  
donglin 已提交
159
| 参数名        | 类型                                       | 必填   | 说明             |
Y
yuyaozhi 已提交
160 161
| --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number                                   | 是 | 获取消息数量的最大限制。 |
M
m00512953 已提交
162
| callback  | AsyncCallback\<Array\<[ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)>>  | 是    | 被指定的回调方法。      |
Y
yuyaozhi 已提交
163 164 165

**示例**

M
m00512953 已提交
166
```ts
Y
yuyaozhi 已提交
167 168
var upperLimit = 0;

D
donglin 已提交
169
abilityManager.getExtensionRunningInfos(upperLimit, (err,data) => { 
Y
yuyaozhi 已提交
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
    console.log("getExtensionRunningInfos err: "  + err + " data: " + JSON.stringify(data));
});
```

## getExtensionRunningInfos<sup>9+</sup>

getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningInfo>>

获取关于运行扩展能力的信息(Promise形式)。
 
**需要权限**: ohos.permission.GET_RUNNING_INFO

**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

**参数**

D
fix  
donglin 已提交
186
| 参数名        | 类型                                       | 必填   | 说明             |
Y
yuyaozhi 已提交
187 188 189 190 191 192 193
| --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number                                   | 是 | 获取消息数量的最大限制。 |

**返回值:**

| 类型                                       | 说明      |
| ---------------------------------------- | ------- |
M
m00512953 已提交
194
| Promise\<Array\<[ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)>> | 返回执行结果。 |
Y
yuyaozhi 已提交
195 196 197

**示例**

M
m00512953 已提交
198
```ts
Y
yuyaozhi 已提交
199 200
var upperLimit = 0;

D
donglin 已提交
201
abilityManager.getExtensionRunningInfos(upperLimit).then((data) => {
Y
yuyaozhi 已提交
202 203 204 205 206 207 208 209 210 211
  console.log("getAbilityRunningInfos data: " + JSON.stringify(data));
}).catch((err) => {
  console.log("getAbilityRunningInfos err: "  + err);
})
```

## getTopAbility<sup>9+</sup>

getTopAbility(callback: AsyncCallback\<ElementName>): void;

212
获取窗口焦点的ability接口(callback形式)。
Y
yuyaozhi 已提交
213 214 215 216 217

**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

**参数**

D
fix  
donglin 已提交
218
| 参数名        | 类型                                       | 必填   | 说明             |
Y
yuyaozhi 已提交
219
| --------- | ---------------------------------------- | ---- | -------------- |
M
m00512953 已提交
220
| callback  | AsyncCallback\<[ElementName](js-apis-bundleManager-elementName.md)>  | 是    | 被指定的回调方法。      |
Y
yuyaozhi 已提交
221 222 223

**示例**

M
m00512953 已提交
224
```ts
D
donglin 已提交
225
abilityManager.getTopAbility((err,data) => { 
Y
yuyaozhi 已提交
226 227 228 229 230 231 232 233
    console.log("getTopAbility err: "  + err + " data: " + JSON.stringify(data));
});
```

## getTopAbility<sup>9+</sup>

getTopAbility(): Promise\<ElementName>;

234
获取窗口焦点的ability接口(Promise形式)。
Y
yuyaozhi 已提交
235 236 237 238 239 240 241
 
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

**返回值:**

| 类型                                       | 说明      |
| ---------------------------------------- | ------- |
M
m00512953 已提交
242
| Promise\<[ElementName](js-apis-bundleManager-elementName.md)>| 返回执行结果。 |
Y
yuyaozhi 已提交
243 244 245

**示例**

M
m00512953 已提交
246
```ts
D
donglin 已提交
247
abilityManager.getTopAbility().then((data) => {
Y
yuyaozhi 已提交
248 249 250 251 252
  console.log("getTopAbility data: " + JSON.stringify(data));
}).catch((err) => {
  console.log("getTopAbility err: "  + err);
})
```