Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
8f08f0fd
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
8f08f0fd
编写于
11月 03, 2022
作者:
O
openharmony_ci
提交者:
Gitee
11月 03, 2022
浏览文件
操作
浏览文件
下载
差异文件
!11237 添加appRecovery相关接口的reference
Merge pull request !11237 from Maplestory_zeng/monthly_20221018
上级
b435b18c
9e0b8a22
变更
3
显示空白变更内容
内联
并排
Showing
3 changed file
with
183 addition
and
0 deletion
+183
-0
zh-cn/application-dev/reference/apis/js-apis-appRecovery.md
zh-cn/application-dev/reference/apis/js-apis-appRecovery.md
+122
-0
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
...ication-dev/reference/apis/js-apis-application-ability.md
+34
-0
zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md
...dev/reference/apis/js-apis-application-abilityConstant.md
+27
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-appRecovery.md
0 → 100644
浏览文件 @
8f08f0fd
# appRecovery
appRecovery模块提供应用故障状态恢复能力。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。当前版本仅支持单进程中单Ability的应用恢复。
## 导入模块
```
import appRecovery from '@ohos.application.appRecovery'
```
## appRecovery.RestartFlag
[
enableAppRecovery
](
#apprecoveryenableapprecovery
)
接口重启选项参数。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| ALWAYS_RESTART | 0 | 总是重启应用。 |
| CPP_CRASH_NO_RESTART | 1 | 发生CPP_CRASH时不重启应用。 |
| JS_CRASH_NO_RESTART | 2 | 发生JS_CRASH时不重启应用。 |
| APP_FREEZE_NO_RESTART | 4 | 发生APP_FREEZE时不重启应用。 |
| NO_RESTART | 65535 | 总是不重启应用。 |
## appRecovery.SaveOccasionFlag
[
enableAppRecovery
](
#apprecoveryenableapprecovery
)
接口状态保存时机选项参数。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| SAVE_WHEN_ERROR | 1 | 当发生应用故障时保存。 |
| SAVE_WHEN_BACKGROUND | 2 | 当应用切入后台时保存。 |
## appRecovery.SaveModeFlag
[
enableAppRecovery
](
#apprecoveryenableapprecovery
)
接口状态保存方式的参数。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| SAVE_WITH_FILE | 1 | 每次状态保存都会写入到本地文件缓存。 |
| SAVE_WITH_SHARED_MEMORY | 2 | 状态先保存在内存中,应用故障退出时写入到本地文件缓存。 |
## appRecovery.enableAppRecovery
enableAppRecovery(restart?: RestartFlag, saveOccasion?: SaveOccasionFlag, saveMode?: SaveModeFlag) : void;
使能应用恢复功能,参数按顺序填入。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| restart |
[
RestartFlag
](
#apprecoveryrestartflag
)
| 否 | 发生对应故障时是否重启,默认为不重启 |
| saveOccasion |
[
SaveOccasionFlag
](
#apprecoverysaveoccasionflag
)
| 否 | 状态保存时机,默认为故障时保存 |
| saveMode |
[
SaveModeFlag
](
#apprecoverysavemodeflag
)
| 否 | 状态保存方式, 默认为文件缓存 |
**示例:**
```
js
export
default
class
MyAbilityStage
extends
AbilityStage
{
onCreate
()
{
appRecovery
.
enableAppRecovery
(
RestartFlag
::
ALWAYS_RESTART
,
SaveOccasionFlag
::
SAVE_WHEN_ERROR
,
SaveModeFlag
::
SAVE_WITH_FILE
);
}
}
```
## appRecovery.restartApp
restartApp(): void;
重启当前App进程,可以配合
[
errorManager
](
js-apis-errorManager.md#errorobserver
)
相关接口使用。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**示例:**
```
js
var
observer
=
{
onUnhandledException
(
errorMsg
)
{
console
.
log
(
'
onUnhandledException, errorMsg:
'
,
errorMsg
)
appRecovery
.
restartApp
();
}
}
```
## appRecovery.saveAppState
saveAppState(): boolean;
保存当前App状态,可以配合
[
errorManager
](
js-apis-errorManager.md#errorobserver
)
相关接口使用
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 保存成功与否。 |
**示例:**
```
js
var
observer
=
{
onUnhandledException
(
errorMsg
)
{
console
.
log
(
'
onUnhandledException, errorMsg:
'
,
errorMsg
)
appRecovery
.
saveAppState
();
}
}
```
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
浏览文件 @
8f08f0fd
...
...
@@ -315,6 +315,40 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void;
```
## Ability.onSaveState
onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any}): AbilityConstant.OnSaveResult;
该API配合
[
appRecovery
](
js-apis-appRecovery.md
)
使用。在应用故障时,如果使能了自动保存状态,框架将回调onSaveState保存Ability状态。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| reason |
[
AbilityConstant.StateType
](
js-apis-application-abilityConstant.md#abilityconstantstatetype
)
| 是 | 回调保存状态的原因 |
| wantParam | {[key:
string]:
any} | 是 | want相关参数。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| AbilityConstant.OnSaveResult | 是否同意保存当前Ability的状态 |
**示例:**
```
js
class
myAbility
extends
Ability
{
onSaveState
(
reason
,
wantParam
)
{
console
.
log
(
'
onSaveState
'
);
wantParams
[
"
myData
"
]
=
"
my1234567
"
;
return
AbilityConstant
.
StateType
.
RECOVERY_AGREE
;
}
}
```
## Caller
...
...
zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md
浏览文件 @
8f08f0fd
...
...
@@ -36,6 +36,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant';
| START_ABILITY | 1 | 启动能力。 |
| CALL | 2 | 呼叫。 |
| CONTINUATION | 3 | 继续。 |
| APP_RECOVERY | 4 | 状态恢复。 |
## AbilityConstant.LastExitReason
...
...
@@ -88,3 +89,29 @@ import AbilityConstant from '@ohos.application.AbilityConstant';
| MEMORY_LEVEL_MODERATE | 0 | 内存占用适中。 |
| MEMORY_LEVEL_LOW | 1 | 内存占用低。 |
| MEMORY_LEVEL_CRITICAL | 2 | 内存占用高。 |
## AbilityConstant.OnSaveResult
[
onSaveState
](
js-apis-application-ability.md#abilityonsavestate
)
接口的返回值。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| ALL_AGREE | 0 | 同意保存状态。 |
| CONTINUATION_REJECT | 1 | 拒绝迁移保存状态。 |
| CONTINUATION_MISMATCH | 2 | 迁移不匹配。|
| RECOVERY_AGREE | 3 | 同意恢复保存状态。 |
| RECOVERY_REJECT | 4 | 拒绝恢复保存状态。|
| ALL_REJECT | 5 | 拒绝保存状态。|
## AbilityConstant.StateType
[
onSaveState
](
js-apis-application-ability.md#abilityonsavestate
)
接口的原因入参
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| CONTINUATION | 0 | 迁移保存状态。 |
| APP_RECOVERY | 1 | 应用恢复保存状态。 |
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录