Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
e7c9d51b
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看板
未验证
提交
e7c9d51b
编写于
7月 05, 2023
作者:
O
openharmony_ci
提交者:
Gitee
7月 05, 2023
浏览文件
操作
浏览文件
下载
差异文件
!20375 新增clean文档资料
Merge pull request !20375 from 杨青/master
上级
b1a524b6
792b9c7a
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
110 addition
and
26 deletion
+110
-26
zh-cn/application-dev/reference/apis/js-apis-data-cloudData.md
.../application-dev/reference/apis/js-apis-data-cloudData.md
+110
-26
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-data-cloudData.md
浏览文件 @
e7c9d51b
# @ohos.data.cloudData (端云协同)
端云协同提供结构化数据(RDB Store
)
端云同步的能力。即:云作为数据的中心节点,通过与云的数据同步,实现数据云备份、同帐号设备间的数据一致性。
端云协同提供结构化数据(RDB Store
)
端云同步的能力。即:云作为数据的中心节点,通过与云的数据同步,实现数据云备份、同帐号设备间的数据一致性。
该模块提供以下端云协同相关的常用功能:
...
...
@@ -18,7 +18,7 @@ import cloudData from '@ohos.data.cloudData';
## Action
清除本地
数据云信息
的行为枚举。
清除本地
下载的云端数据
的行为枚举。
**系统接口:**
此接口为系统接口。
...
...
@@ -26,8 +26,8 @@ import cloudData from '@ohos.data.cloudData';
| 名称 | 说明 |
| --------- | ---------------------------- |
| CLEAR_CLOUD_INFO | 清除
云标识信息
。 |
| CLEAR_CLOUD_DATA_AND_INFO |清除
所有云相关数据,包括云标识信息以及从云端下载的数据(不包括本地已修改或生成的数据)
。 |
| CLEAR_CLOUD_INFO | 清除
从云端下载的数据的云标识,相关数据作为本地数据保存
。 |
| CLEAR_CLOUD_DATA_AND_INFO |清除
从云端下载的数据,不包括本地已修改的云端数据
。 |
## Config
...
...
@@ -49,7 +49,7 @@ static enableCloud(accountId: string, switches: {[bundleName: string]: boolean},
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| accountId | string | 是 | 具体打开的云
ID。
|
| accountId | string | 是 | 具体打开的云
帐号ID。
|
| switches | {[bundleName: string]: boolean} | 是 | 各应用的端云协同开关信息,true为打开该应用端云开关,false为关闭该应用端云开关。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
...
...
@@ -87,7 +87,7 @@ static enableCloud(accountId: string, switches: {[bundleName: string]: boolean})
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| accountId | string | 是 | 具体打开的云
ID。
|
| accountId | string | 是 | 具体打开的云
帐号ID。
|
| switches | {[bundleName: string]: boolean} | 是 | 各应用的端云协同开关信息,true为打开该应用端云开关,false为关闭该应用端云开关。 |
**返回值:**
...
...
@@ -126,10 +126,10 @@ static disableCloud(accountId: string, callback: AsyncCallback<void>):void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ---------------- |
| accountId | string | 是 | 具体打开的云ID。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明
|
| --------- | ------------------------- | ---- | ----------------
----
|
| accountId | string | 是 | 具体打开的云
帐号
ID。 |
| callback | AsyncCallback
<
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,
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------- | ---- | ---------------------------- |
| accountId | string | 是 | 具体打开的云ID。 |
| bundleName| string | 是 | 应用名 |
| accountId | string | 是 | 具体打开的云
帐号
ID。 |
| bundleName| string | 是 | 应用名
。
|
| status | boolean | 是 | 应用的端云协同开关信息,true为打开该应用端云开关,false为关闭该应用端云开关。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
...
...
@@ -242,8 +242,8 @@ static changeAppCloudSwitch(accountId: string,bundleName:string,status:boolean):
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------- | ---- | ---------------------------- |
| accountId | string | 是 | 具体打开的云ID。 |
| bundleName| string | 是 | 应用名 |
| accountId | string | 是 | 具体打开的云
帐号
ID。 |
| bundleName| string | 是 | 应用名
。
|
| status | boolean | 是 | 应用的端云协同开关信息,true为打开该应用端云开关,false为关闭该应用端云开关。 |
**返回值:**
...
...
@@ -282,11 +282,11 @@ static notifyDataChange(accountId: string,bundleName:string, callback: AsyncCall
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | ---------------- |
| accountId | string | 是 | 具体打开的云ID。 |
| bundleName | string | 是 | 应用名 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明
|
| ---------- | ------------------------- | ---- | ----------------
----
|
| accountId | string | 是 | 具体打开的云
帐号
ID。 |
| bundleName | string | 是 | 应用名
。
|
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。
|
**示例:**
...
...
@@ -320,10 +320,10 @@ static notifyDataChange(accountId: string,bundleName:string): Promise<void>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---------------- |
| accountId | string | 是 | 具体打开的云ID。 |
| bundleName | string | 是 | 应用名 |
| 参数名 | 类型 | 必填 | 说明
|
| ---------- | ------ | ---- | ----------------
----
|
| accountId | string | 是 | 具体打开的云
帐号
ID。 |
| bundleName | string | 是 | 应用名
。
|
**返回值:**
...
...
@@ -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.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录