提交 56956d59 编写于 作者: 张文迪

add cloudsyncmanager api

Signed-off-by: N张文迪 <zhangwendi3@huawei.com>
上级 f514c00b
......@@ -233,6 +233,7 @@
- [@ohos.data.ValuesBucket (数据集)](js-apis-data-valuesBucket.md)
- 文件管理
- [@ohos.file.cloudSyncManager (端云同步管理)](js-apis-file-cloudsyncmanager.md)
- [@ohos.file.environment (目录环境能力)](js-apis-file-environment.md)
- [@ohos.file.fileAccess (公共文件访问与管理)](js-apis-fileAccess.md)
- [@ohos.file.fileExtensionInfo (公共文件访问与管理属性信息)](js-apis-fileExtensionInfo.md)
......
# @ohos.file.cloudSyncManager (端云同步管理能力)
该模块向云空间提供通知或更改端云服务状态的能力。
> **说明:**
> 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块接口为系统接口,三方应用不支持调用。
> 本模块支持对错误码进行处理,错误码及其适配方式[参考文档](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。
## 导入模块
```js
import cloudSyncManager from '@ohos.file.cloudSyncManager';
```
## cloudSyncManager.changeAppCloudSwitch
changeAppCloudSwitch(accountId: string, bundleName: string, status: boolean): Promise&lt;void&gt;;
异步方法修改应用的端云文件同步开关,以Promise形式返回结果。
**系统能力**:SystemCapability.FileManagement.DistributedFileService.CloudSyncManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---- |
| accountId | string | 是 | 帐号|
| bundleName | string | 是 | 应用包名|
| status | boolean | 是 | 修改的应用云同步开关状态,true为打开,false为关闭|
**返回值:**
| 类型 | 说明 |
| --------------------- | ---------------- |
| Promise&lt;void&gt; | 使用Promise形式返回修改应用的端云文件同步开关的结果 |
**示例:**
```js
let accountId = "testAccount";
let bundleName = "com.example.bundle";
cloudSyncManager.changeAppCloudSwitch(accountId, bundleName, true).then(function() {
console.info("changeAppCloudSwitch successfully");
}).catch(function(err) {
console.info("changeAppCloudSwitch failed with error message: " + err.message + ", error code: " + err.code);
});
```
## cloudSyncManager.changeAppCloudSwitch
changeAppCloudSwitch(accountId: string, bundleName: string, status: boolean, callback: AsyncCallback&lt;void&gt;): void;
异步方法修改应用的端云文件同步开关,以callback形式返回结果。
**系统能力**:SystemCapability.FileManagement.DistributedFileService.CloudSyncManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---- |
| accountId | string | 是 | 帐号|
| bundleName | string | 是 | 应用包名|
| status | boolean | 是 | 修改的应用云同步开关状态,true为打开,false为关闭|
| callback | AsyncCallback&lt;void&gt; | 是 | 异步修改应用的端云文件同步开关之后的回调 |
**示例:**
```js
let accountId = "testAccount";
let bundleName = "com.example.bundle";
cloudSyncManager.changeAppCloudSwitch(accountId, bundleName, true, (err) => {
if (err) {
console.info("changeAppCloudSwitch failed with error message: " + err.message + ", error code: " + err.code);
} else {
console.info("changeAppCloudSwitch successfully");
}
});
```
## cloudSyncManager.notifyDataChange
notifyDataChange(accountId: string, bundleName: string): Promise&lt;void&gt;;
异步方法通知端云服务应用的云数据变更,以Promise形式返回结果。
**系统能力**:SystemCapability.FileManagement.DistributedFileService.CloudSyncManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---- |
| accountId | string | 是 | 帐号|
| bundleName | string | 是 | 应用包名|
**返回值:**
| 类型 | 说明 |
| --------------------- | ---------------- |
| Promise&lt;void&gt; | 使用Promise形式返回通知端云服务应用的云数据变更的结果 |
**示例:**
```js
let accountId = "testAccount";
let bundleName = "com.example.bundle";
cloudSyncManager.notifyDataChange(accountId, bundleName).then(function() {
console.info("notifyDataChange successfully");
}).catch(function(err) {
console.info("notifyDataChange failed with error message: " + err.message + ", error code: " + err.code);
});
```
## cloudSyncManager.notifyDataChange
notifyDataChange(accountId: string, bundleName: string, callback: AsyncCallback&lt;void&gt;): void;
异步方法通知端云服务应用的云数据变更,以callback形式返回结果。
**系统能力**:SystemCapability.FileManagement.DistributedFileService.CloudSyncManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---- |
| accountId | string | 是 | 帐号|
| bundleName | string | 是 | 应用包名|
| callback | AsyncCallback&lt;void&gt; | 是 | 异步通知端云服务应用的云数据变更之后的回调 |
**示例:**
```js
let accountId = "testAccount";
let bundleName = "com.example.bundle";
cloudSyncManager.notifyDataChange(accountId, bundleName, (err) => {
if (err) {
console.info("notifyDataChange failed with error message: " + err.message + ", error code: " + err.code);
} else {
console.info("notifyDataChange successfully");
}
});
```
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册