openharmony 鸿蒙 js-apis-app-ability-abilityConstant

2025-06-12 浏览 (1)

@ohos.app.ability.AbilityConstant (Ability相关常量)

AbilityConstant提供Ability相关的枚举，包括应用启动原因LaunchReason、上次退出原因LastExitReason、迁移结果OnContinueResult等。

说明：

  • 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

  • 本模块接口仅可在Stage模型下使用。

导入模块

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

LaunchParam

启动参数。Ability启动时由系统自动传入，开发者无需修改。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

名称类型只读可选说明
launchReasonLaunchReason否否枚举类型，表示应用启动原因（如故障恢复拉起、意图调用拉起、原子化服务分享拉起等），详见LaunchReason。
原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
launchReasonMessage18+string否是表示应用启动的详细原因。
原子化服务API：从API version 18开始，该接口支持在原子化服务中使用。
lastExitReasonLastExitReason否否枚举类型，表示应用上次退出原因。
原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
lastExitMessage12+string否否表示最后退出详细原因。
原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
lastExitDetailInfo18+LastExitDetailInfo否是表示应用上次退出的关键运行时状态（含进程ID、退出时间戳、RSS内存值等）。
原子化服务API：从API version 18开始，该接口支持在原子化服务中使用。

LaunchReason

应用启动原因，该类型为枚举，可配合UIAbility的onCreate(want, launchParam)方法根据launchParam.launchReason的不同类型执行相应操作。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

名称值说明
UNKNOWN0未知原因。
原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
START_ABILITY1通过startAbility接口启动Ability。
原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
CALL2通过startAbilityByCall接口启动Ability。
原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
CONTINUATION3跨端迁移启动Ability。
原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
APP_RECOVERY4设置应用恢复后，应用故障时自动恢复启动Ability。
原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
SHARE10+5通过原子化服务分享启动Ability。
原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
AUTO_STARTUP11+8通过设置开机自启动来启动Ability。
INSIGHT_INTENT11+9通过洞察意图来启动Ability。
原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
PREPARE_CONTINUATION12+10跨端迁移提前启动Ability。
原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。

示例：

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

export default 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

Ability上次退出原因，该类型为枚举，可配合UIAbility的onCreate()方法根据launchParam.lastExitReason的不同类型执行相应操作。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

名称值说明
UNKNOWN0未知原因。
原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
ABILITY_NOT_RESPONDING(deprecated)1Ability未响应。
说明: 从API version 9开始支持，从API version 10开始废弃，请使用APP_FREEZE替代。
NORMAL2用户主动关闭，应用程序正常退出。
原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
说明：如果调用process.exit()、kill命令等非Ability Kit提供的能力退出应用进程，也会返回NORMAL。
CPP_CRASH10+3本机异常信号，导致应用程序退出。
原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
JS_ERROR10+4当应用存在JS语法错误并未被开发者捕获时，触发JS_ERROR故障，导致应用程序退出。
原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
APP_FREEZE10+5由于watchdog检测出应用Freeze故障，导致应用程序退出。
原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
PERFORMANCE_CONTROL10+6由于系统性能问题（如设备内存不足），导致应用程序退出。
原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
说明：该接口即将废弃，建议使用RESOURCE_CONTROL替代。
RESOURCE_CONTROL10+7系统资源使用不当，导致应用程序退出。具体错误原因可以通过LaunchParam.lastExitMessage获取，可能原因如下:
- CPU Highload，CPU高负载。
- CPU_EXT Highload，快速CPU负载检测。
- IO Manage Control，I/O管控。
- App Memory Deterioration，应用内存超限劣化。
- Temperature Control，温度管控。
- Memory Pressure，整机低内存触发按优先级由低到高查杀。
原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
UPGRADE10+8应用程序因升级而退出。
原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
USER_REQUEST18+9应用程序因多任务中心请求而退出，例如用户在多任务管理界面执行上划、一键清理等操作。
原子化服务API：从API version 18开始，该接口支持在原子化服务中使用。
SIGNAL18+10应用程序因收到系统kill指令信号而退出。
原子化服务API：从API version 18开始，该接口支持在原子化服务中使用。

示例：

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

export default 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);
    }
  }
}

LastExitDetailInfo18+

记录Ability所在进程上次退出的详细信息。

原子化服务API：从API version 18开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

名称类型只读可选说明
pidnumber否否Ability上次退出所在进程的进程号。
processNamestring否否Ability上次退出所在进程的名称。
uidnumber否否Ability上次退出所在应用的UID。
exitSubReasonnumber否否Ability上次退出的子原因。
exitMsgstring否否Ability上次退出时所在进程被kill的描述信息。
rssnumber否否Ability上次退出时所在进程的rss值。
pssnumber否否Ability上次退出时所在进程的pss值。
timestampnumber否否Ability上次退出时的时间戳。
processState20+appManager.ProcessState否是Ability上次退出时的进程状态。

示例:

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

export default class MyAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
    if (launchParam.lastExitDetailInfo) {
      console.log('pid: ' + launchParam.lastExitDetailInfo.pid +
        '\n processName: ' + launchParam.lastExitDetailInfo.processName +
        '\n uid: ' + launchParam.lastExitDetailInfo.uid +
        '\n exitSubReason: ' + launchParam.lastExitDetailInfo.exitSubReason +
        '\n exitMsg: ' + launchParam.lastExitDetailInfo.exitMsg +
        '\n rss: ' + launchParam.lastExitDetailInfo.rss +
        '\n pss: ' + launchParam.lastExitDetailInfo.pss +
        '\n timestamp: ' + launchParam.lastExitDetailInfo.timestamp +
        '\n processState: ' + launchParam.lastExitDetailInfo.processState
      );
    }
  }
}

OnContinueResult

Ability迁移结果，该类型为枚举，可配合UIAbility的onContinue()方法完成相应的返回。

原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

名称值说明
AGREE0表示同意。
REJECT1表示拒绝：如应用在onContinue中异常会导致迁移以后数据恢复时显示异常，则可以返回REJECT。
MISMATCH2表示版本不匹配：迁移发起端应用可以在onContinue中获取到迁移目标端应用的版本号，进行协商后，如果版本不匹配导致无法迁移，可以返回该结果。

示例：

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

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

MemoryLevel

内存级别，该类型为枚举，可配合UIAbility的onMemoryLevel()方法根据level执行不同内存级别的相应操作。

原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

名称值说明
MEMORY_LEVEL_MODERATE0内存占用适中。
MEMORY_LEVEL_LOW1内存占用低。
MEMORY_LEVEL_CRITICAL2内存占用高。

说明：

不同产品的触发条件可能存在差异。以12G内存的标准设备为例：

  • 当可用内存下降至1700M~1800M时，会触发取值为0的onMemoryLevel回调。
  • 当可用内存下降至1600M~1700M时，会触发取值为1的onMemoryLevel回调。
  • 当可用内存下降至1600M以下时，会触发取值为2的onMemoryLevel回调。

示例：

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

export default 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.');
    }
  }
}

WindowMode12+

启动Ability时的窗口模式，类型为枚举。可配合startAbility使用，指定启动Ability的窗口模式。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

名称值说明
WINDOW_MODE_FULLSCREEN1全屏模式。仅在2in1和tablet设备上生效。
WINDOW_MODE_SPLIT_PRIMARY100支持应用内拉起Ability时设置为分屏，左侧分屏。仅在折叠屏和tablet设备上生效。
WINDOW_MODE_SPLIT_SECONDARY101支持应用内拉起Ability时设置为分屏，右侧分屏。仅在折叠屏和tablet设备上生效。

示例：

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
};

// 确保从上下文获取到context
export default 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

保存应用数据的结果，该类型为枚举，可配合UIAbility的onSaveState()方法完成相应的返回。

原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

名称值说明
ALL_AGREE0总是同意保存状态。
CONTINUATION_REJECT1拒绝迁移保存状态。
CONTINUATION_MISMATCH2迁移不匹配。
RECOVERY_AGREE3同意恢复保存状态。
RECOVERY_REJECT4拒绝恢复保存状态。
ALL_REJECT5总是拒绝保存状态。

示例：

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

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

StateType

保存应用数据场景原因，该类型为枚举，可配合UIAbility的onSaveState()方法根据reason的不同类型执行相应操作。

原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

名称值说明
CONTINUATION0应用迁移场景。
APP_RECOVERY1应用故障恢复场景。

示例：

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

export default 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;
  }
}

ContinueState10+

流转状态枚举值。用于表示当前应用任务流转的状态。可配合UIAbilityContext的setMissionContinueState方法进行设置。

原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

名称值说明
ACTIVE0指示当前应用任务流转处于激活状态。
INACTIVE1指示当前应用任务流转处于未激活状态。

示例：

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

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

CollaborateResult18+

协同状态枚举值，用于表示多设备场景下，调用方应用拉起协同方应用时，协同方应用是否接受协同。配合UIAbility的onCollaborate()方法进行设置。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

名称值说明
ACCEPT0接受协同。
REJECT1拒绝协同。

示例：

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

export default class MyAbility extends UIAbility {
  onCollaborate(wantParam: Record<string, Object>) {
    return AbilityConstant.CollaborateResult.ACCEPT;
  }
}

PrepareTermination15+

应用被用户关闭时的动作枚举值，需要配合AbilityStage的onPrepareTermination或者onPrepareTerminationAsync方法使用。

原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

名称值说明
TERMINATE_IMMEDIATELY0表示立即执行结束动作，默认值。
CANCEL1表示取消结束动作。

示例：

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

export default class MyAbilityStage extends AbilityStage {
  onPrepareTermination(): AbilityConstant.PrepareTermination {
    console.info('MyAbilityStage.onPrepareTermination is called');
    return AbilityConstant.PrepareTermination.CANCEL;
  }
}

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Ability Kit（程序框架服务）

harmony 鸿蒙AbilityBase

harmony 鸿蒙AbilityBase_Element

harmony 鸿蒙AbilityRuntime

harmony 鸿蒙bundle

harmony 鸿蒙OH_NativeBundle_ApplicationInfo

harmony 鸿蒙OH_NativeBundle_ElementName

harmony 鸿蒙ability_base_common.h

harmony 鸿蒙ability_runtime_common.h

harmony 鸿蒙application_context.h

  • 所属分类： 后端技术
  • 本文标签： 软件 鸿蒙
  • 版权声明： 本文链接 https://seaxiang.com/blog/ZlsXsL