harmony 鸿蒙@ohos.app.ability.AbilityConstant (AbilityConstant)
@ohos.app.ability.AbilityConstant (AbilityConstant)
AbilityConstant提供Ability相关的枚举,包括设置初次启动原因、上次退出原因、迁移结果、窗口类型等。
说明:
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
本模块接口仅可在Stage模型下使用。
导入模块
import AbilityConstant from '@ohos.app.ability.AbilityConstant';
属性
AbilityConstant.LaunchParam
启动参数。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 | 
|---|---|---|---|---|
| launchReason | LaunchReason | 是 | 是 | 枚举类型,表示启动原因。 | 
| lastExitReason | LastExitReason | 是 | 是 | 枚举类型,表示最后退出原因。 | 
AbilityConstant.LaunchReason
Ability初次启动原因,该类型为枚举,可配合Ability的onCreate(want, launchParam)方法根据launchParam.launchReason的不同类型执行相应操作。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 | 
|---|---|---|
| UNKNOWN | 0 | 未知原因。 | 
| START_ABILITY | 1 | 通过startAbility接口启动ability。 | 
| CALL | 2 | 通过startAbilityByCall接口启动ability。 | 
| CONTINUATION | 3 | 跨端设备迁移启动ability。 | 
| APP_RECOVERY | 4 | 设置应用恢复后,应用故障时自动恢复启动ability。 | 
| SHARE10+ | 5 | 通过原子化服务分享启动ability。 | 
| AUTO_STARTUP11+ | 8 | 通过设置开机自启动来启动Ability。 | 
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
import Want from '@ohos.app.ability.Want';
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.');
        }
    }
}
AbilityConstant.LastExitReason
Ability上次退出原因,该类型为枚举,可配合Ability的onCreate(want, launchParam)方法根据launchParam.lastExitReason的不同类型执行相应操作。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 | 
|---|---|---|
| UNKNOWN | 0 | 未知原因。 | 
| ABILITY_NOT_RESPONDING | 1 | ability未响应。从API version 9 开始支持,从API version 10 开始废弃,建议使用APP_FREEZE替代。 | 
| NORMAL | 2 | 用户主动关闭,应用程序正常退出。 | 
| CPP_CRASH10+ | 3 | 本机异常信号,导致应用程序退出。 | 
| JS_ERROR10+ | 4 | 当应用存在JS语法错误并未被开发者捕获时,触发JS_ERROR故障,导致应用程序退出。 | 
| APP_FREEZE10+ | 5 | 由于watchdog检测出应用Freeze故障,导致应用程序退出。 | 
| PERFORMANCE_CONTROL10+ | 6 | 由于系统性能问题(如设备内存不足),导致应用程序退出。 | 
| RESOURCE_CONTROL10+ | 7 | 由于系统资源违规使用(超过CPU、I/O、内存的使用量),导致应用程序退出。 | 
| UPGRADE10+ | 8 | 应用程序因升级而退出。 | 
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
import Want from '@ohos.app.ability.Want';
class MyAbility extends UIAbility {
    onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
        if (launchParam.lastExitReason === AbilityConstant.LastExitReason.ABILITY_NOT_RESPONDING) {
            console.log('The ability has exit last because the ability was not responding.');
        }
    }
}
AbilityConstant.OnContinueResult
Ability迁移结果,该类型为枚举,可配合Ability的onContinue(wantParam)方法进完成相应的返回。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 | 
|---|---|---|
| AGREE | 0 | 表示同意。 | 
| REJECT | 1 | 表示拒绝:如应用在onContinue中异常会导致迁移以后数据恢复时显示异常,则可以建议REJECT。 | 
| MISMATCH | 2 | 表示版本不匹配:迁移发起端应用可以在onContinue中获取到迁移目标端应用的版本号,进行协商后,如果版本不匹配导致无法迁移,可以返回该错误。 | 
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
class MyAbility extends UIAbility {
    onContinue(wantParam: Record<string, Object>) {
        return AbilityConstant.OnContinueResult.AGREE;
    }
}
AbilityConstant.WindowMode
启动Ability时的窗口模式,该类型为枚举,可配合startAbility使用指定启动Ability的窗口模式。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
系统API: 此接口为系统接口,三方应用不支持调用。
| 名称 | 值 | 说明 | 
|---|---|---|
| WINDOW_MODE_UNDEFINED | 0 | 未定义窗口模式。 | 
| WINDOW_MODE_FULLSCREEN | 1 | 全屏模式。 | 
| WINDOW_MODE_SPLIT_PRIMARY | 100 | 屏幕如果是水平方向表示左分屏,屏幕如果是竖直方向表示上分屏。 | 
| WINDOW_MODE_SPLIT_SECONDARY | 101 | 屏幕如果是水平方向表示右分屏,屏幕如果是竖直方向表示下分屏。 | 
| WINDOW_MODE_FLOATING | 102 | 自由悬浮形式窗口模式。 | 
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
import StartOptions from '@ohos.app.ability.StartOptions';
import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let want: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility'
};
let option: StartOptions = {
  windowMode: AbilityConstant.WindowMode.WINDOW_MODE_FULLSCREEN
};
// 确保从上下文获取到context
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)}');
    });
  }
}
AbilityConstant.MemoryLevel
内存级别,该类型为枚举,可配合Ability的onMemoryLevel(level)方法根据level执行不同内存级别的相应操作。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 | 
|---|---|---|
| MEMORY_LEVEL_MODERATE | 0 | 内存占用适中。 | 
| MEMORY_LEVEL_LOW | 1 | 内存占用低。 | 
| MEMORY_LEVEL_CRITICAL | 2 | 内存占用高。 | 
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
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.');
        }
    }
}
AbilityConstant.OnSaveResult
保存应用数据的结果,该类型为枚举,可配合Ability的onSaveState(reason, wantParam)方法完成相应的返回。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 | 
|---|---|---|
| ALL_AGREE | 0 | 总是同意保存状态。 | 
| CONTINUATION_REJECT | 1 | 拒绝迁移保存状态。 | 
| CONTINUATION_MISMATCH | 2 | 迁移不匹配。 | 
| RECOVERY_AGREE | 3 | 同意恢复保存状态。 | 
| RECOVERY_REJECT | 4 | 拒绝恢复保存状态。 | 
| ALL_REJECT | 5 | 总是拒绝保存状态。 | 
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
class MyAbility extends UIAbility {
    onSaveState(reason: AbilityConstant.StateType, wantParam: Record<string, Object>) {
        return AbilityConstant.OnSaveResult.ALL_AGREE;
    }
}
AbilityConstant.StateType
保存应用数据场景原因,该类型为枚举,可配合Ability的onSaveState(reason, wantParam)方法根据reason的不同类型执行相应操作。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 | 
|---|---|---|
| CONTINUATION | 0 | 迁移保存状态。 | 
| APP_RECOVERY | 1 | 应用恢复保存状态。 | 
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
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;
    }
}
AbilityConstant.ContinueState10+
ContinueState说明枚举值。用于表示当前应用任务流转的状态。可配合UIAbilityContext的setMissionContinueState方法进行设置。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 | 
|---|---|---|
| ACTIVE | 0 | 指示当前应用任务流转处于激活状态。 | 
| INACTIVE | 1 | 指示当前应用任务流转处于未激活状态。 | 
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
import StartOptions from '@ohos.app.ability.StartOptions';
import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
class MyAbility extends UIAbility {
    onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
        this.context.setMissionContinueState(AbilityConstant.ContinueState.INACTIVE, (result: BusinessError) => {
        console.info(`setMissionContinueState: ${JSON.stringify(result)}`);
        });
    }
}
你可能感兴趣的鸿蒙文章
harmony 鸿蒙BundleStatusCallback
harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)
harmony 鸿蒙@ohos.distributedBundle (分布式包管理)
harmony 鸿蒙@ohos.bundle (Bundle模块)
harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)
- 所属分类: 后端技术
- 本文标签:
热门推荐
- 
                        2、 - 优质文章
- 
                        3、 gate.io
- 
                        8、 openharmony
- 
                        9、 golang