Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
34e4577b
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看板
未验证
提交
34e4577b
编写于
5月 12, 2023
作者:
O
openharmony_ci
提交者:
Gitee
5月 12, 2023
浏览文件
操作
浏览文件
下载
差异文件
!17872 kvstore可选参默认值doc修改
Merge pull request !17872 from zuojiangjiang/master
上级
2159178e
b2883755
变更
2
显示空白变更内容
内联
并排
Showing
2 changed file
with
39 addition
and
39 deletion
+39
-39
zh-cn/application-dev/reference/apis/js-apis-distributed-data.md
...pplication-dev/reference/apis/js-apis-distributed-data.md
+24
-24
zh-cn/application-dev/reference/apis/js-apis-distributedKVStore.md
...lication-dev/reference/apis/js-apis-distributedKVStore.md
+15
-15
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-distributed-data.md
浏览文件 @
34e4577b
...
...
@@ -128,8 +128,8 @@ try {
| 名称 | 类型 | 必填 | 说明 |
| ----- | ------ |------ | ------ |
| userId | string | 否 | 指示要设置的用户ID。 |
| userType |
[
UserType
](
#usertype
)
| 否 | 指示要设置的用户类型。 |
| userId | string | 否 | 指示要设置的用户ID
,默认为'0'
。 |
| userType |
[
UserType
](
#usertype
)
| 否 | 指示要设置的用户类型
,默认为0
。 |
## UserType
...
...
@@ -267,7 +267,7 @@ const options = {
backup
:
false
,
autoSync
:
true
,
kvStoreType
:
distributedData
.
KVStoreType
.
SINGLE_VERSION
,
schema
:
''
,
schema
:
undefined
,
securityLevel
:
distributedData
.
SecurityLevel
.
S2
,
}
try
{
...
...
@@ -317,7 +317,7 @@ const options = {
backup
:
false
,
autoSync
:
true
,
kvStoreType
:
distributedData
.
KVStoreType
.
SINGLE_VERSION
,
schema
:
''
,
schema
:
undefined
,
securityLevel
:
distributedData
.
SecurityLevel
.
S2
,
}
try
{
...
...
@@ -365,7 +365,7 @@ const options = {
backup
:
false
,
autoSync
:
true
,
kvStoreType
:
distributedData
.
KVStoreType
.
SINGLE_VERSION
,
schema
:
''
,
schema
:
undefined
,
securityLevel
:
distributedData
.
SecurityLevel
.
S2
,
}
try
{
...
...
@@ -414,7 +414,7 @@ const options = {
backup
:
false
,
autoSync
:
true
,
kvStoreType
:
distributedData
.
KVStoreType
.
SINGLE_VERSION
,
schema
:
''
,
schema
:
undefined
,
securityLevel
:
distributedData
.
SecurityLevel
.
S2
,
}
try
{
...
...
@@ -548,7 +548,7 @@ off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): v
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| event | string | 是 | 取消订阅的事件名,固定为'distributedDataServiceDie',即服务状态变更事件。 |
| deathCallback | Callback
<
void
>
| 否 |
回调
函数。 |
| deathCallback | Callback
<
void
>
| 否 |
取消订阅的函数。如不设置callback,则取消所有已订阅的
函数。 |
**示例:**
...
...
@@ -574,13 +574,13 @@ try {
| 名称 | 类型 | 必填 | 说明 |
| ----- | ------ | ------ | -------------------|
| createIfMissing | boolean | 否 | 当数据库文件不存在时是否创建数据库,默认创建。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| encrypt | boolean | 否 |设置数据库文件是否加密,默认不加密。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| backup | boolean | 否 |设置数据库文件是否备份,默认备份。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| autoSync | boolean | 否 |设置数据库文件是否自动同步。默认为false,即手动同步
;设置为true时,表示自动同步
。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
<br>
**需要权限**
: ohos.permission.DISTRIBUTED_DATASYNC |
| kvStoreType |
[
KVStoreType
](
#kvstoretype
)
| 否 |设置要创建的数据库类型,默认为多设备协同数据库。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| securityLevel |
[
SecurityLevel
](
#securitylevel
)
|
否 |设置数据库安全级别,默认不设置安全级别
。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| schema
<sup>
8+
</sup>
|
[
Schema
](
#schema8
)
| 否 | 设置定义存储在数据库中的值。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.DistributedKVStore |
| createIfMissing | boolean | 否 | 当数据库文件不存在时是否创建数据库,默认
为true,即
创建。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| encrypt | boolean | 否 |设置数据库文件是否加密,默认
为false, 即
不加密。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| backup | boolean | 否 |设置数据库文件是否备份,默认
为true,即
备份。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| autoSync | boolean | 否 |设置数据库文件是否自动同步。默认为false,即手动同步。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
<br>
**需要权限**
: ohos.permission.DISTRIBUTED_DATASYNC |
| kvStoreType |
[
KVStoreType
](
#kvstoretype
)
| 否 |设置要创建的数据库类型,默认为
DEVICE_COLLABORATION,即
多设备协同数据库。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| securityLevel |
[
SecurityLevel
](
#securitylevel
)
|
是 |设置数据库安全级别(S1-S4)
。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| schema
<sup>
8+
</sup>
|
[
Schema
](
#schema8
)
| 否 | 设置定义存储在数据库中的值
,默认为undefined, 即不使用schema
。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.DistributedKVStore |
## KVStoreType
...
...
@@ -601,8 +601,8 @@ KVStore数据库类型枚举。
| 名称 | 值 | 说明 |
| --- | ---- | ----------------------- |
| NO_LEVEL | 0 | 表示数据库不设置安全级别。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.DistributedKVStore |
| S0 | 1 | 表示数据库的安全级别为公共级别。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| NO_LEVEL | 0 | 表示数据库不设置安全级别
(已废弃)
。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.DistributedKVStore |
| S0 | 1 | 表示数据库的安全级别为公共级别
(已废弃)
。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| S1 | 2 | 表示数据库的安全级别为低级别,当数据泄露时会产生较低影响。例如,包含壁纸等系统数据的数据库。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| S2 | 3 | 表示数据库的安全级别为中级别,当数据泄露时会产生较大影响。例如,包含录音、视频等用户生成数据或通话记录等信息的数据库。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| S3 | 5 | 表示数据库的安全级别为高级别,当数据泄露时会产生重大影响。例如,包含用户运动、健康、位置等信息的数据库。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
...
...
@@ -2295,7 +2295,7 @@ off(event:'dataChange', listener?: Callback<ChangeNotification>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | -------------------------------------------------------- |
| event | string | 是 | 取消订阅的事件名,固定为'dataChange',表示数据变更事件。 |
| listener | Callback
<
[ChangeNotification](#changenotification)
>
| 否 |
回调函数。
|
| listener | Callback
<
[ChangeNotification](#changenotification)
>
| 否 |
取消订阅的函数。如不设置callback,则取消所有订阅的函数。
|
...
...
@@ -2333,7 +2333,7 @@ off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]&
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------------------- | ---- | ---------------------------------------------------------- |
| event | string | 是 | 取消订阅的事件名,固定为'syncComplete',表示同步完成事件。 |
| syncCallback | Callback
<
Array
<
[string, number]
>>
| 否 |
回调函数。用于向调用方发送同步结果的回调。
|
| syncCallback | Callback
<
Array
<
[string, number]
>>
| 否 |
取消订阅的函数。如不设置callback,则取消所有订阅的函数。
|
**示例:**
...
...
@@ -3780,7 +3780,7 @@ sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void
| --------- | --------------------- | ---- | ---------------------------------------------- |
| deviceIds | string[] | 是 | 同一组网环境下,需要同步的设备的deviceId列表。 |
| mode |
[
SyncMode
](
#syncmode
)
| 是 | 同步模式。 |
| delayMs | number | 否 | 可选参数,允许延时时间,单位:ms(毫秒)。 |
| delayMs | number | 否 | 可选参数,允许延时时间,单位:ms(毫秒)
,默认为0
。 |
**示例:**
...
...
@@ -3895,7 +3895,7 @@ off(event:'dataChange', listener?: Callback<ChangeNotification>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | -------------------------------------------------------- |
| event | string | 是 | 取消订阅的事件名,固定为'dataChange',表示数据变更事件。 |
| listener | Callback
<
[ChangeNotification](#changenotification)
>
| 否 |
回调函数。
|
| listener | Callback
<
[ChangeNotification](#changenotification)
>
| 否 |
取消订阅的函数。如不设置callback,则取消所有订阅的函数。
|
**示例:**
...
...
@@ -3931,7 +3931,7 @@ off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]&
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------------------- | ---- | ---------------------------------------------------------- |
| event | string | 是 | 取消订阅的事件名,固定为'syncComplete',表示同步完成事件。 |
| syncCallback | Callback
<
Array
<
[string, number]
>>
| 否 |
回调函数。用于向调用方发送同步结果的回调。
|
| syncCallback | Callback
<
Array
<
[string, number]
>>
| 否 |
取消订阅的函数。如不设置callback,则取消所有订阅的函数。
|
**示例:**
...
...
@@ -5258,7 +5258,7 @@ sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void
| ----- | ------ | ---- | ----------------------- |
| deviceIds |string[] | 是 |需要同步DeviceKvStore数据库的设备ID列表。 |
| mode |
[
SyncMode
](
#syncmode
)
| 是 |同步模式。 |
| delayMs |number | 否 |可选参数,允许延时时间,单位:ms(毫秒)。 |
| delayMs |number | 否 |可选参数,允许延时时间,单位:ms(毫秒)
,默认为0
。 |
**示例:**
...
...
@@ -5373,7 +5373,7 @@ off(event:'dataChange', listener?: Callback<ChangeNotification>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | -------------------------------------------------------- |
| event | string | 是 | 取消订阅的事件名,固定为'dataChange',表示数据变更事件。 |
| listener | Callback
<
[ChangeNotification](#changenotification)
>
| 否 |
回调函数。
|
| listener | Callback
<
[ChangeNotification](#changenotification)
>
| 否 |
取消订阅的函数。如不设置callback,则取消所有订阅的函数。
|
**示例:**
...
...
@@ -5409,7 +5409,7 @@ off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]&
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------------------- | ---- | ---------------------------------------------------------- |
| event | string | 是 | 取消订阅的事件名,固定为'syncComplete',表示同步完成事件。 |
| syncCallback | Callback
<
Array
<
[string, number]
>>
| 否 |
回调函数。用于向调用方发送同步结果的回调。
|
| syncCallback | Callback
<
Array
<
[string, number]
>>
| 否 |
取消订阅的函数。如不设置callback,则取消所有订阅的函数。
|
**示例:**
...
...
zh-cn/application-dev/reference/apis/js-apis-distributedKVStore.md
浏览文件 @
34e4577b
...
...
@@ -149,13 +149,13 @@ import distributedKVStore from '@ohos.data.distributedKVStore';
| 名称 | 类型 | 必填 | 说明 |
| --------------- | -------------- | ---- | -------------------------|
| createIfMissing | boolean | 否 | 当数据库文件不存在时是否创建数据库,默认创建。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| encrypt | boolean | 否 | 设置数据库文件是否加密,默认不加密。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| backup | boolean | 否 | 设置数据库文件是否备份,默认备份。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| autoSync | boolean | 否 | 设置数据库文件是否自动同步。默认为false,即手动同步
;设置为true时,表示自动同步
。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
<br>
**需要权限**
: ohos.permission.DISTRIBUTED_DATASYNC |
| kvStoreType |
[
KVStoreType
](
#kvstoretype
)
| 否 | 设置要创建的数据库类型,默认为多设备协同数据库。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| securityLevel |
[
SecurityLevel
](
#securitylevel
)
| 是 |设置数据库安全级别。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| schema |
[
Schema
](
#schema
)
| 否 | 设置定义存储在数据库中的值,默认不使用Schema。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.DistributedKVStore |
| createIfMissing | boolean | 否 | 当数据库文件不存在时是否创建数据库,默认
为true,即
创建。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| encrypt | boolean | 否 | 设置数据库文件是否加密,默认
为false,即
不加密。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| backup | boolean | 否 | 设置数据库文件是否备份,默认
为true,即
备份。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| autoSync | boolean | 否 | 设置数据库文件是否自动同步。默认为false,即手动同步。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
<br>
**需要权限**
: ohos.permission.DISTRIBUTED_DATASYNC |
| kvStoreType |
[
KVStoreType
](
#kvstoretype
)
| 否 | 设置要创建的数据库类型,默认为
DEVICE_COLLABORATION,即
多设备协同数据库。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| securityLevel |
[
SecurityLevel
](
#securitylevel
)
| 是 |
设置数据库安全级别。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core |
| schema |
[
Schema
](
#schema
)
| 否 | 设置定义存储在数据库中的值,默认
为undefined,即
不使用Schema。
<br>
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.DistributedKVStore |
## Schema
...
...
@@ -444,7 +444,7 @@ const options = {
backup
:
false
,
autoSync
:
true
,
kvStoreType
:
distributedKVStore
.
KVStoreType
.
SINGLE_VERSION
,
schema
:
''
,
schema
:
undefined
,
securityLevel
:
distributedKVStore
.
SecurityLevel
.
S2
,
}
try
{
...
...
@@ -500,7 +500,7 @@ const options = {
backup
:
false
,
autoSync
:
true
,
kvStoreType
:
distributedKVStore
.
KVStoreType
.
SINGLE_VERSION
,
schema
:
''
,
schema
:
undefined
,
securityLevel
:
distributedKVStore
.
SecurityLevel
.
S2
,
}
try
{
...
...
@@ -555,7 +555,7 @@ const options = {
backup
:
false
,
autoSync
:
true
,
kvStoreType
:
distributedKVStore
.
KVStoreType
.
SINGLE_VERSION
,
schema
:
''
,
schema
:
undefined
,
securityLevel
:
distributedKVStore
.
SecurityLevel
.
S2
,
}
try
{
...
...
@@ -619,7 +619,7 @@ const options = {
backup
:
false
,
autoSync
:
true
,
kvStoreType
:
distributedKVStore
.
KVStoreType
.
SINGLE_VERSION
,
schema
:
''
,
schema
:
undefined
,
securityLevel
:
distributedKVStore
.
SecurityLevel
.
S2
,
}
try
{
...
...
@@ -4562,7 +4562,7 @@ sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void
| --------- | --------------------- | ---- | ---------------------------------------------- |
| deviceIds | string[] | 是 | 同一组网环境下,需要同步的设备的deviceId列表。 |
| mode |
[
SyncMode
](
#syncmode
)
| 是 | 同步模式。 |
| delayMs | number | 否 | 可选参数,允许延时时间,单位:ms(毫秒)。 |
| delayMs | number | 否 | 可选参数,允许延时时间,单位:ms(毫秒)
,默认为0
。 |
**错误码:**
...
...
@@ -4632,7 +4632,7 @@ sync(deviceIds: string[], query: Query, mode: SyncMode, delayMs?: number): void
| deviceIds | string[] | 是 | 同一组网环境下,需要同步的设备的deviceId列表。 |
| mode |
[
SyncMode
](
#syncmode
)
| 是 | 同步模式。 |
| query |
[
Query
](
#query
)
| 是 | 表示数据库的查询谓词条件 |
| delayMs | number | 否 | 可选参数,允许延时时间,单位:ms(毫秒)。 |
| delayMs | number | 否 | 可选参数,允许延时时间,单位:ms(毫秒)
,默认为0
。 |
**错误码:**
...
...
@@ -4769,7 +4769,7 @@ off(event:'dataChange', listener?: Callback<ChangeNotification>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | -------------------------------------------------------- |
| event | string | 是 | 取消订阅的事件名,固定为'dataChange',表示数据变更事件。 |
| listener | Callback
<
[ChangeNotification](#changenotification)
>
| 否 |
回调函数。
|
| listener | Callback
<
[ChangeNotification](#changenotification)
>
| 否 |
取消订阅的函数。如不设置callback,则取消所有已订阅的函数。
|
**错误码:**
...
...
@@ -4822,7 +4822,7 @@ off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]&
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------------------- | ---- | ---------------------------------------------------------- |
| event | string | 是 | 取消订阅的事件名,固定为'syncComplete',表示同步完成事件。 |
| syncCallback | Callback
<
Array
<
[string, number]
>>
| 否 |
回调函数。用于向调用方发送同步结果的回调。
|
| syncCallback | Callback
<
Array
<
[string, number]
>>
| 否 |
取消订阅的函数。如不设置callback,则取消所有已订阅的函数。
|
**示例:**
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录