AbilityManager
NOTE
The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
API version 9 is a canary version for trial use. The APIs of this version may be unstable.
Modules to Import
import AbilityManager from '@ohos.application.abilityManager'
AbilityState
Enumerates the ability states.
System capability: SystemCapability.Ability.AbilityRuntime.Core
Name | Value | Description |
---|---|---|
INITIAL | 0 | The ability is in the initial state. |
FOREGROUND | 9 | The ability is in the foreground state. |
BACKGROUND | 10 | The ability is in the background state. |
FOREGROUNDING | 11 | The ability is in the foregrounding state. |
BACKGROUNDING | 12 | The ability is in the backgrounding state. |
updateConfiguration
updateConfiguration(config: Configuration, callback: AsyncCallback<void>): void
Updates the configuration. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Ability.AbilityRuntime.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
config | Configuration | Yes | New configuration. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import abilitymanager from '@ohos.application.abilityManager';
var config = {
language: 'chinese'
}
abilitymanager.updateConfiguration(config, () => {
console.log('------------ updateConfiguration -----------');
})
updateConfiguration
updateConfiguration(config: Configuration): Promise<void>
Updates the configuration. This API uses a promise to return the result.
System capability: SystemCapability.Ability.AbilityRuntime.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
config | Configuration | Yes | New configuration. |
Return value
Type | Description |
---|---|
Promise<void> | Promised used to return the result. |
Example
import abilitymanager from '@ohos.application.abilityManager';
var config = {
language: 'chinese'
}
abilitymanager.updateConfiguration(config).then(() => {
console.log('updateConfiguration success');
}).catch((err) => {
console.log('updateConfiguration fail');
})
getAbilityRunningInfos
getAbilityRunningInfos(callback: AsyncCallback<Array<AbilityRunningInfo>>): void
Obtains the ability running information. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Ability.AbilityRuntime.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<Array<AbilityRunningInfo>> | Yes | Callback used to return the result. |
Example
import abilitymanager from '@ohos.application.abilityManager';
abilitymanager.getAbilityRunningInfos((err,data) => {
console.log("getAbilityRunningInfos err: " + err + " data: " + JSON.stringify(data));
});
getAbilityRunningInfos
getAbilityRunningInfos(): Promise<Array<AbilityRunningInfo>>
Obtains the ability running information. This API uses a promise to return the result.
System capability: SystemCapability.Ability.AbilityRuntime.Core
Return value
Type | Description |
---|---|
Promise<Array<AbilityRunningInfo>> | Promised used to return the result. |
Example
import abilitymanager from '@ohos.application.abilityManager';
abilitymanager.getAbilityRunningInfos().then((data) => {
console.log("getAbilityRunningInfos data: " + JSON.stringify(data))
}).catch((err) => {
console.log("getAbilityRunningInfos err: " + err)
});
getExtensionRunningInfos9+
getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback<Array<ExtensionRunningInfo>>): void
Obtains the extension running information. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Ability.AbilityRuntime.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
upperLimit | number | Yes | Maximum number of messages that can be obtained. |
callback | AsyncCallback<Array<AbilityRunningInfo>> | Yes | Callback used to return the result. |
Example
import abilitymanager from '@ohos.application.abilityManager';
var upperLimit = 0;
abilitymanager.getExtensionRunningInfos(upperLimit, (err,data) => {
console.log("getExtensionRunningInfos err: " + err + " data: " + JSON.stringify(data));
});
getExtensionRunningInfos9+
getExtensionRunningInfos(upperLimit: number): Promise<Array<ExtensionRunningInfo>>
Obtains the extension running information. This API uses a promise to return the result.
System capability: SystemCapability.Ability.AbilityRuntime.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
upperLimit | number | Yes | Maximum number of messages that can be obtained. |
Return value
Type | Description |
---|---|
Promise<Array<AbilityRunningInfo>> | Promised used to return the result. |
Example
import abilitymanager from '@ohos.application.abilityManager';
var upperLimit = 0;
abilitymanager.getExtensionRunningInfos(upperLimit).then((data) => {
console.log("getAbilityRunningInfos data: " + JSON.stringify(data));
}).catch((err) => {
console.log("getAbilityRunningInfos err: " + err);
})