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

!20375 新增clean文档资料

Merge pull request !20375 from 杨青/master
# @ohos.data.cloudData (端云协同) # @ohos.data.cloudData (端云协同)
端云协同提供结构化数据(RDB Store)端云同步的能力。即:云作为数据的中心节点,通过与云的数据同步,实现数据云备份、同帐号设备间的数据一致性。 端云协同提供结构化数据(RDB Store端云同步的能力。即:云作为数据的中心节点,通过与云的数据同步,实现数据云备份、同帐号设备间的数据一致性。
该模块提供以下端云协同相关的常用功能: 该模块提供以下端云协同相关的常用功能:
...@@ -18,7 +18,7 @@ import cloudData from '@ohos.data.cloudData'; ...@@ -18,7 +18,7 @@ import cloudData from '@ohos.data.cloudData';
## Action ## Action
清除本地数据云信息的行为枚举。 清除本地下载的云端数据的行为枚举。
**系统接口:** 此接口为系统接口。 **系统接口:** 此接口为系统接口。
...@@ -26,8 +26,8 @@ import cloudData from '@ohos.data.cloudData'; ...@@ -26,8 +26,8 @@ import cloudData from '@ohos.data.cloudData';
| 名称 | 说明 | | 名称 | 说明 |
| --------- | ---------------------------- | | --------- | ---------------------------- |
| CLEAR_CLOUD_INFO | 清除云标识信息。 | | CLEAR_CLOUD_INFO | 清除从云端下载的数据的云标识,相关数据作为本地数据保存。 |
| CLEAR_CLOUD_DATA_AND_INFO |清除所有云相关数据,包括云标识信息以及从云端下载的数据(不包括本地已修改或生成的数据)。 | | CLEAR_CLOUD_DATA_AND_INFO |清除从云端下载的数据,不包括本地已修改的云端数据。 |
## Config ## Config
...@@ -49,7 +49,7 @@ static enableCloud(accountId: string, switches: {[bundleName: string]: boolean}, ...@@ -49,7 +49,7 @@ static enableCloud(accountId: string, switches: {[bundleName: string]: boolean},
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------- | ---- | ------------------------------------------------------------ | | --------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| accountId | string | 是 | 具体打开的云ID。 | | accountId | string | 是 | 具体打开的云帐号ID。 |
| switches | {[bundleName: string]: boolean} | 是 | 各应用的端云协同开关信息,true为打开该应用端云开关,false为关闭该应用端云开关。 | | switches | {[bundleName: string]: boolean} | 是 | 各应用的端云协同开关信息,true为打开该应用端云开关,false为关闭该应用端云开关。 |
| callback | AsyncCallback<void> | 是 | 回调函数。 | | callback | AsyncCallback<void> | 是 | 回调函数。 |
...@@ -87,7 +87,7 @@ static enableCloud(accountId: string, switches: {[bundleName: string]: boolean}) ...@@ -87,7 +87,7 @@ static enableCloud(accountId: string, switches: {[bundleName: string]: boolean})
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------- | ---- | ------------------------------------------------------------ | | --------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| accountId | string | 是 | 具体打开的云ID。 | | accountId | string | 是 | 具体打开的云帐号ID。 |
| switches | {[bundleName: string]: boolean} | 是 | 各应用的端云协同开关信息,true为打开该应用端云开关,false为关闭该应用端云开关。 | | switches | {[bundleName: string]: boolean} | 是 | 各应用的端云协同开关信息,true为打开该应用端云开关,false为关闭该应用端云开关。 |
**返回值:** **返回值:**
...@@ -126,10 +126,10 @@ static disableCloud(accountId: string, callback: AsyncCallback<void>):void ...@@ -126,10 +126,10 @@ static disableCloud(accountId: string, callback: AsyncCallback<void>):void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ---------------- | | --------- | ------------------------- | ---- | -------------------- |
| accountId | string | 是 | 具体打开的云ID。 | | accountId | string | 是 | 具体打开的云帐号ID。 |
| callback | AsyncCallback<void> | 是 | 回调函数。 | | callback | AsyncCallback<void> | 是 | 回调函数。 |
**示例:** **示例:**
...@@ -162,9 +162,9 @@ static disableCloud(accountId: string): Promise<void> ...@@ -162,9 +162,9 @@ static disableCloud(accountId: string): Promise<void>
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------------- | | --------- | ------ | ---- | -------------------- |
| accountId | string | 是 | 具体打开的云ID。 | | accountId | string | 是 | 具体打开的云帐号ID。 |
**返回值:** **返回值:**
...@@ -203,8 +203,8 @@ static changeAppCloudSwitch(accountId: string,bundleName:string,status:boolean, ...@@ -203,8 +203,8 @@ static changeAppCloudSwitch(accountId: string,bundleName:string,status:boolean,
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------- | ---- | ---------------------------- | | --------- | ------------------------------- | ---- | ---------------------------- |
| accountId | string | 是 | 具体打开的云ID。 | | accountId | string | 是 | 具体打开的云帐号ID。 |
| bundleName| string | 是 | 应用名 | | bundleName| string | 是 | 应用名 |
| status | boolean | 是 | 应用的端云协同开关信息,true为打开该应用端云开关,false为关闭该应用端云开关。 | | status | boolean | 是 | 应用的端云协同开关信息,true为打开该应用端云开关,false为关闭该应用端云开关。 |
| callback | AsyncCallback<void> | 是 | 回调函数。 | | callback | AsyncCallback<void> | 是 | 回调函数。 |
...@@ -242,8 +242,8 @@ static changeAppCloudSwitch(accountId: string,bundleName:string,status:boolean): ...@@ -242,8 +242,8 @@ static changeAppCloudSwitch(accountId: string,bundleName:string,status:boolean):
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------- | ---- | ---------------------------- | | --------- | ------------------------------- | ---- | ---------------------------- |
| accountId | string | 是 | 具体打开的云ID。 | | accountId | string | 是 | 具体打开的云帐号ID。 |
| bundleName| string | 是 | 应用名 | | bundleName| string | 是 | 应用名 |
| status | boolean | 是 | 应用的端云协同开关信息,true为打开该应用端云开关,false为关闭该应用端云开关。 | | status | boolean | 是 | 应用的端云协同开关信息,true为打开该应用端云开关,false为关闭该应用端云开关。 |
**返回值:** **返回值:**
...@@ -282,11 +282,11 @@ static notifyDataChange(accountId: string,bundleName:string, callback: AsyncCall ...@@ -282,11 +282,11 @@ static notifyDataChange(accountId: string,bundleName:string, callback: AsyncCall
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | ---------------- | | ---------- | ------------------------- | ---- | -------------------- |
| accountId | string | 是 | 具体打开的云ID。 | | accountId | string | 是 | 具体打开的云帐号ID。 |
| bundleName | string | 是 | 应用名 | | bundleName | string | 是 | 应用名 |
| callback | AsyncCallback<void> | 是 | 回调函数。 | | callback | AsyncCallback<void> | 是 | 回调函数。 |
**示例:** **示例:**
...@@ -320,10 +320,10 @@ static notifyDataChange(accountId: string,bundleName:string): Promise<void&gt ...@@ -320,10 +320,10 @@ static notifyDataChange(accountId: string,bundleName:string): Promise<void&gt
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---------------- | | ---------- | ------ | ---- | -------------------- |
| accountId | string | 是 | 具体打开的云ID。 | | accountId | string | 是 | 具体打开的云帐号ID。 |
| bundleName | string | 是 | 应用名 | | bundleName | string | 是 | 应用名 |
**返回值:** **返回值:**
...@@ -347,3 +347,87 @@ try { ...@@ -347,3 +347,87 @@ try {
} }
``` ```
### clean
static clean(accountId: string, appActions: {[bundleName: string]: Action}, callback: AsyncCallback<void>):void
清除本地下载的云端数据,使用callback异步回调。
**系统接口:** 此接口为系统接口。
**需要权限**:ohos.permission.CLOUDDATA_CONFIG
**系统能力:** SystemCapability.DistributedDataManager.CloudSync.Config
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ----------------------------------------- | ---- | -------------------------------- |
| accountId | string | 是 | 具体打开的云帐号ID。 |
| appActions | {[bundleName: string]: [Action](#action)} | 是 | 要清除数据的应用信息及清除规则。 |
| callback | AsyncCallback<void> | 是 | 回调函数。 |
**示例:**
```js
let action = cloudData.Action;
let account = "test_id";
let bundleName1 = "test_bundleName1";
let bundleName2 = "test_bundleName2";
let appActions = { [bundleName1]: action.CLEAR_CLOUD_INFO, [bundleName2]: action.CLEAR_CLOUD_DATA_AND_INFO };
try {
cloudData.Config.clean(account, appActions, function (err) {
if (err === undefined) {
console.info('Succeeding in cleaning cloud data');
} else {
console.error(`Failed to clean cloud data. Code: ${err.code}, message: ${err.message}`);
}
});
} catch (error) {
console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
}
```
### clean
static clean(accountId: string, appActions: {[bundleName: string]: Action}): Promise<void>
清除本地下载的云端数据,使用Promise异步回调。
**系统接口:** 此接口为系统接口。
**需要权限**:ohos.permission.CLOUDDATA_CONFIG
**系统能力:** SystemCapability.DistributedDataManager.CloudSync.Config
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ----------------------------------------- | ---- | -------------------------------- |
| accountId | string | 是 | 具体打开的云帐号ID。 |
| appActions | {[bundleName: string]: [Action](#action)} | 是 | 要清除数据的应用信息及清除规则。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise<void> | 无返回结果的Promise对象。 |
**示例:**
```js
let action = cloudData.Action;
let account = "test_id";
let bundleName1 = "test_bundleName1";
let bundleName2 = "test_bundleName2";
let appActions = { [bundleName1]: action.CLEAR_CLOUD_INFO, [bundleName2]: action.CLEAR_CLOUD_DATA_AND_INFO };
try {
cloudData.Config.clean(account, appActions).then(() => {
console.info('Succeeding in cleaning cloud data');
}).catch((err) => {
console.error(`Failed to clean cloud data. Code: ${err.code}, message: ${err.message}`);
});
} catch (error) {
console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
}
```
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册