harmony 鸿蒙@ohos.app.ability.appRecovery (appRecovery)
@ohos.app.ability.appRecovery (appRecovery)
appRecovery模块提供了应用在故障状态下的恢复能力。
说明:
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。API9仅支持单进程中单Ability的应用恢复。API10支持进程中包含多个Ability的场景。
导入模块
import appRecovery from '@ohos.app.ability.appRecovery';
appRecovery.RestartFlag
应用重启标志,enableAppRecovery接口重启选项参数,该类型为枚举。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
名称 | 值 | 说明 |
---|---|---|
ALWAYS_RESTART | 0 | 总是重启应用。 |
RESTART_WHEN_JS_CRASH | 0x0001 | 发生JS_CRASH时重启应用。 |
RESTART_WHEN_APP_FREEZE | 0x0002 | 发生APP_FREEZE时重启应用。 |
NO_RESTART | 0xFFFF | 总是不重启应用。 |
appRecovery.SaveOccasionFlag
保存条件标志,enableAppRecovery接口状态保存时的选项参数,该类型为枚举。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
名称 | 值 | 说明 |
---|---|---|
SAVE_WHEN_ERROR | 0x0001 | 当发生应用故障时保存。 |
SAVE_WHEN_BACKGROUND | 0x0002 | 当应用切入后台时保存。 |
appRecovery.SaveModeFlag
状态保存标志,enableAppRecovery接口状态保存方式的参数,该类型为枚举。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
名称 | 值 | 说明 |
---|---|---|
SAVE_WITH_FILE | 0x0001 | 每次状态保存都会写入到本地文件缓存。 |
SAVE_WITH_SHARED_MEMORY | 0x0002 | 状态先保存在内存中,应用故障退出时写入到本地文件缓存。 |
appRecovery.enableAppRecovery
enableAppRecovery(restart?: RestartFlag, saveOccasion?: SaveOccasionFlag, saveMode?: SaveModeFlag) : void;
使能应用恢复功能,参数按顺序填入。该接口调用后,应用从启动器启动时第一个Ability支持恢复。
模型约束:此接口仅可在Stage模型下使用。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
restart | RestartFlag | 否 | 枚举类型,发生对应故障时是否重启,默认为不重启。 |
saveOccasion | SaveOccasionFlag | 否 | 枚举类型,状态保存时机,默认为故障时保存。 |
saveMode | SaveModeFlag | 否 | 枚举类型,状态保存方式, 默认为文件缓存。 |
示例:
import appRecovery from '@ohos.app.ability.appRecovery';
import AbilityStage from '@ohos.app.ability.AbilityStage';
export default class MyAbilityStage extends AbilityStage {
onCreate() {
appRecovery.enableAppRecovery(
appRecovery.RestartFlag.ALWAYS_RESTART,
appRecovery.SaveOccasionFlag.SAVE_WHEN_ERROR,
appRecovery.SaveModeFlag.SAVE_WITH_FILE
);
}
}
appRecovery.restartApp
restartApp(): void;
重启当前进程,并拉起应用启动时第一个Ability,如果该Ability存在已经保存的状态,这些状态数据会在Ability的OnCreate生命周期回调的want参数中作为wantParam属性传入。
API10时将启动由setRestartWant指定的Ability。如果没有指定则按以下规则启动:
如果当前应用前台的Ability支持恢复,则重新拉起该Ability。
如果存在多个支持恢复的Ability处于前台,则只拉起最后一个。
如果没有Ability处于前台,则不拉起。
可以配合errorManager相关接口使用。
模型约束:此接口仅可在Stage模型下使用。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
示例:
import appRecovery from '@ohos.app.ability.appRecovery';
import errorManager from '@ohos.app.ability.errorManager';
let observer: errorManager.ErrorObserver = {
onUnhandledException(errorMsg) {
console.log('onUnhandledException, errorMsg: ', errorMsg);
appRecovery.restartApp();
}
};
try {
errorManager.on('error', observer);
} catch (paramError) {
console.error(`error: ${paramError.code}, ${paramError.message}`);
}
appRecovery.saveAppState
saveAppState(): boolean;
保存当前App状态,可以配合errorManager相关接口使用
模型约束:此接口仅可在Stage模型下使用。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
返回值:
类型 | 说明 |
---|---|
boolean | 保存成功与否。true:保存成功,false:保存失败。 |
示例:
import appRecovery from '@ohos.app.ability.appRecovery';
import errorManager from '@ohos.app.ability.errorManager';
let observer: errorManager.ErrorObserver = {
onUnhandledException(errorMsg) {
console.log('onUnhandledException, errorMsg: ', errorMsg);
appRecovery.saveAppState();
}
};
try {
errorManager.on('error', observer);
} catch (paramError) {
console.error(`error: ${paramError.code}, ${paramError.message}`);
}
appRecovery.saveAppState10+
saveAppState(context?: UIAbilityContext): boolean;
主动保存Ability的状态,这个状态将在下次恢复启动时使用。可以配合errorManager相关接口使用
模型约束:此接口仅可在Stage模型下使用。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
context | UIAbilityContext | 否 | UIAbility上下文环境。 |
返回值:
类型 | 说明 |
---|---|
boolean | 保存成功与否。true:保存成功,false:保存失败。 |
示例:
import appRecovery from '@ohos.app.ability.appRecovery';
import errorManager from '@ohos.app.ability.errorManager';
let observer: errorManager.ErrorObserver = {
onUnhandledException(errorMsg) {
console.log('onUnhandledException, errorMsg: ', errorMsg);
appRecovery.saveAppState(this.context);
}
};
try {
errorManager.on('error', observer);
} catch (paramError) {
console.error(`error: ${paramError.code}, ${paramError.message}`);
}
appRecovery.setRestartWant10+
setRestartWant(want: Want): void;
设置下次恢复主动拉起场景下的Ability。该Ability必须为当前包下的UIAbility。
模型约束:此接口仅可在Stage模型下使用。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
want | Want | 是 | 通过设置Want中”bundleName”和”abilityName”字段来指定恢复重启的Ability。 |
示例:
import appRecovery from '@ohos.app.ability.appRecovery';
import Want from '@ohos.app.ability.Want';
Button("启动到恢复Ability")
.fontSize(40)
.fontWeight(FontWeight.Bold)
.onClick(()=> {
// set restart want
let want: Want = {
bundleName: "ohos.samples.recovery",
abilityName: "RecoveryAbility"
};
appRecovery.setRestartWant(want);
})
你可能感兴趣的鸿蒙文章
harmony 鸿蒙BundleStatusCallback
harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)
harmony 鸿蒙@ohos.distributedBundle (分布式包管理)
harmony 鸿蒙@ohos.bundle (Bundle模块)
harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)
- 所属分类: 后端技术
- 本文标签:
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦