未验证 提交 ed705245 编写于 作者: O openharmony_ci 提交者: Gitee

!17706 修改file.backup 备份恢复接口说明

Merge pull request !17706 from 花轻似梦/master
......@@ -19,9 +19,9 @@ import backup from '@ohos.file.backup';
**系统能力**:SystemCapability.FileManagement.StorageService.Backup
| 名称 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ------------------------------------------------------------------------------------------------------ |
| bundleName | string | 是 | 应用名称,可通过[bundle.BundleInfo](js-apis-bundle-BundleInfo.md)提供的获取方式获取。 |
| 名称 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---------------------------------------------------------------------------------------------- |
| bundleName | string | 是 | 应用名称,可通过[bundle.BundleInfo](js-apis-bundle-BundleInfo.md)提供的获取方式获取。 |
| uri | string | 是 | 应用沙箱内待传输文件的名称,当前uri尚未升级为标准格式,仅接受0-9a-zA-Z下划线(_)点(.)组成的名称 |
## FileData
......@@ -93,7 +93,7 @@ onBundleBegin : AsyncCallback<string>
```js
onBundleBegin: (err, bundleName) => {
if (err) {
console.error('onBundleBegin failed with err: ' + err);]
console.error('onBundleBegin failed with err: ' + err);
}
console.info('onBundleBegin success with bundleName: ' + bundleName);
}
......@@ -168,24 +168,6 @@ getLocalCapabilities(callback: AsyncCallback<FileData>): void;
| -------- | ------------------------------------------ | ---- | ------------------------------------------------------ |
| callback | AsyncCallback<[FileData](#filedata)> | 是 | 回调函数。当获取成功,err为undefined,否则为错误对象。 |
**json configuration example**
```json
{
"bundleInfos" :[{
"allToBackup" : true,
"extensionName" : "BackupExtensionAbility",
"name" : "com.example.hiworld",
"needToInstall" : false,
"spaceOccupied" : 0,
"versionCode" : 1000000,
"versionName" : "1.0.0"
}],
"deviceType" : "phone",
"systemFullName" : "OpenHarmony-4.0.0.0"
}
```
**示例:**
```js
......@@ -203,6 +185,25 @@ getLocalCapabilities(callback: AsyncCallback<FileData>): void;
}
```
**返回的能力文件内容示例:**
```json
{
"bundleInfos" :[{
"allToBackup" : true,
"extensionName" : "BackupExtensionAbility",
"name" : "com.example.hiworld",
"needToInstall" : false,
"spaceOccupied" : 0,
"versionCode" : 1000000,
"versionName" : "1.0.0"
}],
"deviceType" : "phone",
"systemFullName" : "OpenHarmony-4.0.0.0"
}
```
## getLocalCapabilities
getLocalCapabilities(): Promise<FileData>;
......@@ -219,7 +220,20 @@ getLocalCapabilities(): Promise<FileData>;
| ------------------------------------ | --------------------------------------------------- |
| Promise<[FileData](#filedata)> | Promise对象,返回描述本地能力的Json文件的FileData。 |
**json configuration example**
**示例:**
```js
import fs from '@ohos.file.fs';
try {
let fileData = await backup.getLocalCapabilities();
console.info('getLocalCapabilities success');
fs.closeSync(fileData.fd);
} catch (err) {
console.error('getLocalCapabilities failed with err: ' + err);
}
```
**返回的能力文件内容示例:**
```json
{
......@@ -237,19 +251,6 @@ getLocalCapabilities(): Promise<FileData>;
}
```
**示例:**
```js
try {
import fs from '@ohos.file.fs';
let fileData = await backup.getLocalCapabilities();
console.info('getLocalCapabilities success');
fs.closeSync(fileData.fd);
} catch (err) {
console.error('getLocalCapabilities failed with err: ' + err);
}
```
## SessionBackup
备份流程对象,用来支撑应用备份的流程。在使用前,需要先创建SessionBackup实例。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册