harmony 鸿蒙@ohos.application.abilityManager (AbilityManager)

2022-08-09
浏览 (647)

@ohos.application.abilityManager (AbilityManager)

The AbilityManager module provides APIs for obtaining, adding, and modifying ability running information and state information.

NOTE

The APIs of this module are supported since API version 8 and deprecated since API version 9. You are advised to use @ohos.app.ability.abilityManager instead. Newly added APIs will be marked with a superscript to indicate their earliest API version. The APIs of this module are system APIs and cannot be called by third-party applications.

Modules to Import

import abilityManager from '@ohos.application.abilityManager';

AbilityState

Enumerates the ability states.

System capability: SystemCapability.Ability.AbilityRuntime.Core

System API: This is a system API and cannot be called by third-party applications.

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 state of being switched to the foreground.
BACKGROUNDING	12	The ability is in the state of being switched to the background.

updateConfiguration

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

Updates the configuration. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.UPDATE_CONFIGURATION

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';
import { Configuration } from '@ohos.application.Configuration';

let config: Configuration = {
  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.

Permission required: ohos.permission.UPDATE_CONFIGURATION

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
config	Configuration	Yes	New configuration.

Return value

Type	Description
Promise<void>	Promise used to return the result.

Example

import abilityManager from '@ohos.application.abilityManager';
import { Configuration } from '@ohos.application.Configuration';
import { BusinessError } from '@ohos.base';

let config: Configuration = {
  language: 'chinese' 
};

abilityManager.updateConfiguration(config).then(() => {
  console.log('updateConfiguration success');
}).catch((err: BusinessError) => {
  console.error('updateConfiguration fail');
});

getAbilityRunningInfos

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

Obtains the ability running information. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.GET_RUNNING_INFO

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.

Required permissions: ohos.permission.GET_RUNNING_INFO

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<Array<AbilityRunningInfo>>	Promise used to return the result.

Example

import abilityManager from '@ohos.application.abilityManager';
import { BusinessError } from '@ohos.base';

abilityManager.getAbilityRunningInfos().then((data) => {
    console.log(`getAbilityRunningInfos  data: ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`getAbilityRunningInfos err: ${JSON.stringify(err)}`);
});