@ohos.app.ability.AbilityConstant (AbilityConstant)

The AbilityConstant module defines the UIAbility-related enums, including the initial launch reasons, reasons for the last exit, ability continuation results, and window modes.

NOTE

• The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

• The APIs of this module can be used only in the stage model.

Modules to Import

import { AbilityConstant } from '@kit.AbilityKit';

LaunchParam

Defines the parameters for starting an ability. The parameter values are automatically passed in by the system when the ability is started. You do not need to change the values.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Name	Type	Read-only	Optional	Description
launchReason	LaunchReason	No	No	Ability launch reason, which is an enumerated type. Atomic service API: This API can be used in atomic services since API version 11.
lastExitReason	LastExitReason	No	No	Reason for the last exit, which is an enumerated type. Atomic service API: This API can be used in atomic services since API version 11.
lastExitMessage12+	string	No	No	Reason for the last exit. Atomic service API: This API can be used in atomic services since API version 12.

LaunchReason

Enumerates the initial ability launch reasons. You can use it together with the value of launchParam.launchReason in onCreate(want, launchParam) of the UIAbility to complete different operations.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Name	Value	Description
UNKNOWN	0	Unknown reason. Atomic service API: This API can be used in atomic services since API version 11.
START_ABILITY	1	The ability is started by calling startAbility. Atomic service API: This API can be used in atomic services since API version 11.
CALL	2	The ability is started by calling startAbilityByCall. Atomic service API: This API can be used in atomic services since API version 11.
CONTINUATION	3	The ability is started by means of cross-device migration. Atomic service API: This API can be used in atomic services since API version 11.
APP_RECOVERY	4	The ability is automatically started when the application is restored from a fault. Atomic service API: This API can be used in atomic services since API version 11.
SHARE10+	5	The ability is started by means of atomic service sharing. Atomic service API: This API can be used in atomic services since API version 11.
AUTO_STARTUP11+	8	The ability is automatically started upon system boot.
INSIGHT_INTENT11+	9	The ability is started by the InsightIntent framework. Atomic service API: This API can be used in atomic services since API version 11.
PREPARE_CONTINUATION12+	10	The ability is started in advance during cross-device migration. Atomic service API: This API can be used in atomic services since API version 12.

Example

import { UIAbility, Want, AbilityConstant } from '@kit.AbilityKit';

class MyAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
    if (launchParam.launchReason === AbilityConstant.LaunchReason.START_ABILITY) {
      console.log('The ability has been started by the way of startAbility.');
    }
  }
}

LastExitReason

Enumerates the reasons for the last exit. You can use it together with the value of launchParam.lastExitReason in onCreate(want, launchParam) of the UIAbility to complete different operations.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Name	Value	Description
UNKNOWN	0	Unknown reason. Atomic service API: This API can be used in atomic services since API version 11.
ABILITY_NOT_RESPONDING(deprecated)	1	The ability does not respond. NOTE This enum is supported since API version 9 and deprecated since API version 10. You are advised to use APP_FREEZE.
NORMAL	2	The ability exits normally because the user closes the application. Atomic service API: This API can be used in atomic services since API version 11.
CPP_CRASH10+	3	The ability exits due to abnormal signals on the local host. Atomic service API: This API can be used in atomic services since API version 11.
JS_ERROR10+	4	The ability exits due to a JS_ERROR fault triggered when an application has a JS syntax error that is not captured by developers. Atomic service API: This API can be used in atomic services since API version 11.
APP_FREEZE10+	5	The ability exits because watchdog detects that the application is frozen. Atomic service API: This API can be used in atomic services since API version 11.
PERFORMANCE_CONTROL10+	6	The ability exits due to system performance problems, for example, insufficient device memory. Atomic service API: This API can be used in atomic services since API version 11. NOTE: This API will be deprecated. You are advised to use RESOURCE_CONTROL instead.
RESOURCE_CONTROL10+	7	The ability exits due to improper use of system resources. The specific error cause can be obtained through LaunchParam.lastExitMessage. The possible causes are as follows: - CPU Highload: The CPU load is high. - CPU_EXT Highload: A fast CPU load detection is carried out. - IO Manage Control: An I/O management and control operation is carried out. -** App Memory Deterioration**: The application memory usage exceeds the threshold. - Temperature Control: The temperature is too high or too low. - Memory Pressure: The system is low on memory, triggering ability exiting in ascending order of priority. Atomic service API: This API can be used in atomic services since API version 11.
UPGRADE10+	8	The ability exits due to an update. Atomic service API: This API can be used in atomic services since API version 11.

Example

import { UIAbility, Want, AbilityConstant } from '@kit.AbilityKit';

class MyAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
    if (launchParam.lastExitReason === AbilityConstant.LastExitReason.APP_FREEZE) {
      console.log('The ability has exit last because the ability was not responding.');
    }
    if (launchParam.lastExitReason === AbilityConstant.LastExitReason.RESOURCE_CONTROL) {
      console.log('The ability has exit last because the rss control, the lastExitReason is '+ launchParam.lastExitReason + ', the lastExitMessage is ' + launchParam.lastExitMessage);
    }
  }
}

OnContinueResult

Enumerates the ability continuation results. You can use it together with onContinue(wantParam) of the UIAbility to complete different operations.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Name	Value	Description
AGREE	0	The ability continuation is accepted.
REJECT	1	The ability continuation is rejected. If the application is abnormal in onContinue, which results in abnormal display during data restoration, this error code is returned.
MISMATCH	2	The version does not match. The application on the initiator can obtain the version of the target application from onContinue. If the ability continuation cannot be performed due to version mismatch, this error code is returned.

Example

import { UIAbility, AbilityConstant } from '@kit.AbilityKit';

class MyAbility extends UIAbility {
  onContinue(wantParam: Record<string, Object>) {
    return AbilityConstant.OnContinueResult.AGREE;
  }
}

MemoryLevel

Enumerates the memory levels. You can use it in onMemoryLevel(level) of the UIAbility to complete different operations.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Name	Value	Description
MEMORY_LEVEL_MODERATE	0	Moderate memory usage.
MEMORY_LEVEL_LOW	1	Low memory usage.
MEMORY_LEVEL_CRITICAL	2	High memory usage.

Example

import { UIAbility, AbilityConstant } from '@kit.AbilityKit';

class MyAbility extends UIAbility {
  onMemoryLevel(level: AbilityConstant.MemoryLevel) {
    if (level === AbilityConstant.MemoryLevel.MEMORY_LEVEL_CRITICAL) {
      console.log('The memory of device is critical, please release some memory.');
    }
  }
}

WindowMode¹²⁺

Enumerates the window mode when the ability is started. It can be used together with startAbility to specify the window mode for starting the ability.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Name	Value	Description
WINDOW_MODE_FULLSCREEN	1	Full screen mode. It takes effect only on 2-in-1 devices and tablets.
WINDOW_MODE_SPLIT_PRIMARY	100	Primary screen (left screen in the case of horizontal orientation) in split-screen mode. It is valid only in intra-app redirection scenarios. It takes effect only on foldable devices and tablets.
WINDOW_MODE_SPLIT_SECONDARY	101	Secondary screen (right screen in the case of horizontal orientation) in split-screen mode. It is valid only in intra-app redirection scenarios. It takes effect only on foldable devices and tablets.

Example

import { UIAbility, StartOptions, Want, AbilityConstant } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let want: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility'
};
let option: StartOptions = {
  windowMode: AbilityConstant.WindowMode.WINDOW_MODE_SPLIT_PRIMARY
};

// Ensure that the context is obtained.
class MyAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
    this.context.startAbility(want, option).then(() => {
      console.log('Succeed to start ability.');
    }).catch((error: BusinessError) => {
      console.error(`Failed to start ability with error: ${JSON.stringify(error)}`);
    });
  }
}

OnSaveResult

Enumerates the result types for the operation of saving application data. You can use it in onSaveState(reason, wantParam) of the UIAbility to complete different operations.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Name	Value	Description
ALL_AGREE	0	Always agreed to save the status.
CONTINUATION_REJECT	1	Rejected to save the status in continuation.
CONTINUATION_MISMATCH	2	Continuation mismatch.
RECOVERY_AGREE	3	Agreed to restore the saved status.
RECOVERY_REJECT	4	Rejected to restore the saved status.
ALL_REJECT	5	Always rejected to save the status.

Example

import { UIAbility, AbilityConstant } from '@kit.AbilityKit';

class MyAbility extends UIAbility {
  onSaveState(reason: AbilityConstant.StateType, wantParam: Record<string, Object>) {
    return AbilityConstant.OnSaveResult.ALL_AGREE;
  }
}

StateType

Enumerates the scenarios for saving application data. You can use it in onSaveState(reason, wantParam) of the UIAbility to complete different operations.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Name	Value	Description
CONTINUATION	0	Saving the status in continuation.
APP_RECOVERY	1	Saving the status in application recovery.

Example

import { UIAbility, AbilityConstant } from '@kit.AbilityKit';

class MyAbility extends UIAbility {
  onSaveState(reason: AbilityConstant.StateType, wantParam: Record<string, Object>) {
    if (reason === AbilityConstant.StateType.CONTINUATION) {
      console.log('Save the ability data when the ability continuation.');
    }
    return AbilityConstant.OnSaveResult.ALL_AGREE;
  }
}

ContinueState¹⁰⁺

Enumerates the mission continuation states of the application. It is used in the setMissionContinueState API of UIAbilityContext.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Name	Value	Description
ACTIVE	0	Mission continuation is activated for the current application.
INACTIVE	1	Mission continuation is not activated for the current application.

Example

import { UIAbility, Want, AbilityConstant } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

class MyAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
    this.context.setMissionContinueState(AbilityConstant.ContinueState.INACTIVE, (result: BusinessError) => {
      console.info(`setMissionContinueState: ${JSON.stringify(result)}`);
    });
  }
}