• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.application.BackupExtensionAbility (备份恢复扩展能力)
2
3BackupExtensionAbility模块提供备份恢复服务相关扩展能力,为应用提供扩展的备份恢复能力。
4
5> **说明:**
6>
7> 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8>
9> 本模块接口仅可在Stage模型下使用。
10
11## 导入模块
12
13```ts
14import BackupExtension from '@ohos.application.BackupExtensionAbility';
15```
16
17## BundleVersion
18
19恢复时所需要的版本信息,开发者可根据配置的版本号来判断本次恢复时的应用版本数据。
20
21**系统能力**:SystemCapability.FileManagement.StorageService.Backup
22
23| 名称 | 类型   | 必填 | 说明             |
24| ---- | ------ | ---- | ---------------- |
25| code | number | 是   | 应用的版本号。   |
26| name | string | 是   | 应用的版本名称。 |
27
28
29## BackupExtensionAbility.onBackup
30
31onBackup(): void;
32
33Extension生命周期回调,在执行备份数据时回调,由开发者提供扩展的备份数据的操作。
34
35**系统能力**:SystemCapability.FileManagement.StorageService.Backup
36
37**示例:**
38
39  ```ts
40  class BackupExt extends BackupExtension {
41    async onBackup() {
42      console.log('onBackup');
43    }
44  }
45  ```
46
47
48## BackupExtensionAbility.onRestore
49
50onRestore(bundleVersion: BundleVersion): void;
51
52Extension生命周期回调,在执行恢复数据时回调,由开发者提供扩展的恢复数据的操作。
53
54**系统能力**:SystemCapability.FileManagement.StorageService.Backup
55
56**参数:**
57
58| 参数名        | 类型                            | 必填 | 说明                           |
59| ------------- | ------------------------------- | ---- | ------------------------------ |
60| bundleVersion | [BundleVersion](#bundleversion) | 是   | 恢复时应用数据所在的版本信息。 |
61
62**示例:**
63
64  ```ts
65  import { BundleVersion } from '@ohos.application.BackupExtensionAbility';
66
67  class BackupExt extends BackupExtension {
68    async onRestore(bundleVersion : BundleVersion) {
69      console.log(`onRestore ok ${JSON.stringify(bundleVersion)}`);
70    }
71  }
72  ```