Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
f4fc4c6f
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看板
未验证
提交
f4fc4c6f
编写于
5月 06, 2022
作者:
O
openharmony_ci
提交者:
Gitee
5月 06, 2022
浏览文件
操作
浏览文件
下载
差异文件
!3723 分布式数据子系统-API样板话统一审视优化修改:需同步翻译
Merge pull request !3723 from 葛亚芳/master
上级
a3009801
6973367f
变更
7
展开全部
隐藏空白更改
内联
并排
Showing
7 changed file
with
410 addition
and
376 deletion
+410
-376
zh-cn/application-dev/reference/apis/js-apis-data-ability.md
zh-cn/application-dev/reference/apis/js-apis-data-ability.md
+61
-50
zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md
...tion-dev/reference/apis/js-apis-data-distributedobject.md
+6
-8
zh-cn/application-dev/reference/apis/js-apis-data-preferences.md
...pplication-dev/reference/apis/js-apis-data-preferences.md
+32
-17
zh-cn/application-dev/reference/apis/js-apis-data-rdb.md
zh-cn/application-dev/reference/apis/js-apis-data-rdb.md
+75
-75
zh-cn/application-dev/reference/apis/js-apis-data-resultset.md
.../application-dev/reference/apis/js-apis-data-resultset.md
+16
-19
zh-cn/application-dev/reference/apis/js-apis-data-storage.md
zh-cn/application-dev/reference/apis/js-apis-data-storage.md
+59
-47
zh-cn/application-dev/reference/apis/js-apis-distributed-data.md
...pplication-dev/reference/apis/js-apis-distributed-data.md
+161
-160
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-data-ability.md
浏览文件 @
f4fc4c6f
...
...
@@ -6,8 +6,8 @@
## 导入模块
```
import dataAbility from '@ohos.data.dataAbility'
```
js
import
dataAbility
from
'
@ohos.data.dataAbility
'
;
```
...
...
@@ -24,8 +24,8 @@ createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates):
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 数据库表中表名。 |
| dataAbilityPredicates |
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 是 |
d
ataAbility谓词。 |
| name | string | 是 | 数据库表中
的
表名。 |
| dataAbilityPredicates |
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 是 |
D
ataAbility谓词。 |
-
返回值:
| 类型 | 说明 |
...
...
@@ -33,7 +33,7 @@ createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates):
| rdb.
[
RdbPredicates
](
js-apis-data-rdb.md#rdbpredicates
)
| 返回RdbPredicates对象。 |
-
示例:
```
```
js
let
dataAbilityPredicates
=
new
dataAbility
.
DataAbilityPredicates
()
dataAbilityPredicates
.
equalTo
(
"
NAME
"
,
"
Rose
"
).
between
(
"
AGE
"
,
16
,
30
)
let
predicates
=
dataAbility
.
createRdbPredicates
(
"
EMPLOYEE
"
,
dataAbilityPredicates
)
...
...
@@ -59,7 +59,7 @@ equalTo(field: string, value: ValueType): DataAbilityPredicates
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value |
[
ValueType
](
js-apis-data-rdb.md
#valuetype
)
| 是 | 指示要与谓词匹配的值。 |
| value |
[
ValueType
](
#valuetype
)
| 是 | 指示要与谓词匹配的值。 |
-
返回值:
| 类型 | 说明 |
...
...
@@ -67,7 +67,7 @@ equalTo(field: string, value: ValueType): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
equalTo
(
"
NAME
"
,
"
lisi
"
)
```
...
...
@@ -87,7 +87,7 @@ notEqualTo(field: string, value: ValueType): DataAbilityPredicates
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value |
[
ValueType
](
js-apis-data-rdb.md
#valuetype
)
| 是 | 指示要与谓词匹配的值。 |
| value |
[
ValueType
](
#valuetype
)
| 是 | 指示要与谓词匹配的值。 |
-
返回值:
| 类型 | 说明 |
...
...
@@ -95,7 +95,7 @@ notEqualTo(field: string, value: ValueType): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
notEqualTo
(
"
NAME
"
,
"
lisi
"
)
```
...
...
@@ -117,7 +117,7 @@ beginWrap(): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回带有左括号的DataAbility谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbilitylity
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
equalTo
(
"
NAME
"
,
"
lisi
"
)
.
beginWrap
()
...
...
@@ -144,7 +144,7 @@ endWrap(): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回带有右括号的DataAbility谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
equalTo
(
"
NAME
"
,
"
lisi
"
)
.
beginWrap
()
...
...
@@ -171,7 +171,7 @@ or(): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回带有或条件的DataAbility谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
equalTo
(
"
NAME
"
,
"
Lisa
"
)
.
or
()
...
...
@@ -185,7 +185,7 @@ or(): DataAbilityPredicates
and(): DataAbilityPredicates
向谓词添加和条件
。
将和条件添加到谓词中
。
**系统能力**
:SystemCapability.DistributedDataManager.DataShare.Core。
...
...
@@ -195,7 +195,7 @@ and(): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回带有和条件的DataAbility谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
equalTo
(
"
NAME
"
,
"
Lisa
"
)
.
and
()
...
...
@@ -209,7 +209,7 @@ and(): DataAbilityPredicates
contains(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为
S
tring且value包含指定值的字段。
配置谓词以匹配数据类型为
s
tring且value包含指定值的字段。
**系统能力**
:SystemCapability.DistributedDataManager.DataShare.Core。
...
...
@@ -225,7 +225,7 @@ contains(field: string, value: string): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
contains
(
"
NAME
"
,
"
os
"
)
```
...
...
@@ -237,7 +237,7 @@ contains(field: string, value: string): DataAbilityPredicates
beginsWith(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为
S
tring且值以指定字符串开头的字段。
配置谓词以匹配数据类型为
s
tring且值以指定字符串开头的字段。
**系统能力**
:SystemCapability.DistributedDataManager.DataShare.Core。
...
...
@@ -253,7 +253,7 @@ beginsWith(field: string, value: string): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
beginsWith
(
"
NAME
"
,
"
os
"
)
```
...
...
@@ -265,7 +265,7 @@ beginsWith(field: string, value: string): DataAbilityPredicates
endsWith(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为
S
tring且值以指定字符串结尾的字段。
配置谓词以匹配数据类型为
s
tring且值以指定字符串结尾的字段。
**系统能力**
:SystemCapability.DistributedDataManager.DataShare.Core。
...
...
@@ -308,7 +308,7 @@ isNull(field: string): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
isNull
(
"
NAME
"
)
```
...
...
@@ -335,7 +335,7 @@ isNotNull(field: string): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
isNotNull
(
"
NAME
"
)
```
...
...
@@ -363,7 +363,7 @@ like(field: string, value: string): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
like
(
"
NAME
"
,
"
%os%
"
)
```
...
...
@@ -375,7 +375,7 @@ like(field: string, value: string): DataAbilityPredicates
glob(field: string, value: string): DataAbilityPredicates
配置谓词匹配数据类型为string的指定字段。
配置谓词
以
匹配数据类型为string的指定字段。
**系统能力**
:SystemCapability.DistributedDataManager.DataShare.Core。
...
...
@@ -391,7 +391,7 @@ glob(field: string, value: string): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
glob
(
"
NAME
"
,
"
?h*g
"
)
```
...
...
@@ -403,7 +403,7 @@ glob(field: string, value: string): DataAbilityPredicates
between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
将谓词配置为
匹配数据类型为ValueType且value在指定范围内的指定字段。
配置谓词以
匹配数据类型为ValueType且value在指定范围内的指定字段。
**系统能力**
:SystemCapability.DistributedDataManager.DataShare.Core。
...
...
@@ -411,8 +411,8 @@ between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| low |
[
ValueType
](
js-apis-data-rdb.md
#valuetype
)
| 是 | 指示与谓词匹配的最小值。 |
| high |
[
ValueType
](
js-apis-data-rdb.md
#valuetype
)
| 是 | 指示与谓词匹配的最大值。 |
| low |
[
ValueType
](
#valuetype
)
| 是 | 指示与谓词匹配的最小值。 |
| high |
[
ValueType
](
#valuetype
)
| 是 | 指示与谓词匹配的最大值。 |
-
返回值:
| 类型 | 说明 |
...
...
@@ -420,7 +420,7 @@ between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
between
(
"
AGE
"
,
10
,
50
)
```
...
...
@@ -440,8 +440,8 @@ notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicate
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| low |
[
ValueType
](
js-apis-data-rdb.md
#valuetype
)
| 是 | 指示与谓词匹配的最小值。 |
| high |
[
ValueType
](
js-apis-data-rdb.md
#valuetype
)
| 是 | 指示与谓词匹配的最大值。 |
| low |
[
ValueType
](
#valuetype
)
| 是 | 指示与谓词匹配的最小值。 |
| high |
[
ValueType
](
#valuetype
)
| 是 | 指示与谓词匹配的最大值。 |
-
返回值:
| 类型 | 说明 |
...
...
@@ -449,7 +449,7 @@ notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicate
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
notBetween
(
"
AGE
"
,
10
,
50
)
```
...
...
@@ -469,7 +469,7 @@ greaterThan(field: string, value: ValueType): DataAbilityPredicates
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value |
[
ValueType
](
js-apis-data-rdb.md
#valuetype
)
| 是 | 指示要与谓词匹配的值。 |
| value |
[
ValueType
](
#valuetype
)
| 是 | 指示要与谓词匹配的值。 |
-
返回值:
| 类型 | 说明 |
...
...
@@ -477,7 +477,7 @@ greaterThan(field: string, value: ValueType): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
greaterThan
(
"
AGE
"
,
18
)
```
...
...
@@ -497,7 +497,7 @@ lessThan(field: string, value: ValueType): DataAbilityPredicates
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value |
[
ValueType
](
js-apis-data-rdb.md
#valuetype
)
| 是 | 指示要与谓词匹配的值。 |
| value |
[
ValueType
](
#valuetype
)
| 是 | 指示要与谓词匹配的值。 |
-
返回值:
| 类型 | 说明 |
...
...
@@ -505,7 +505,7 @@ lessThan(field: string, value: ValueType): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
lessThan
(
"
AGE
"
,
20
)
```
...
...
@@ -525,7 +525,7 @@ greaterThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value |
[
ValueType
](
js-apis-data-rdb.md
#valuetype
)
| 是 | 指示要与谓词匹配的值。 |
| value |
[
ValueType
](
#valuetype
)
| 是 | 指示要与谓词匹配的值。 |
-
返回值:
| 类型 | 说明 |
...
...
@@ -533,7 +533,7 @@ greaterThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
greaterThanOrEqualTo
(
"
AGE
"
,
18
)
```
...
...
@@ -553,7 +553,7 @@ lessThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value |
[
ValueType
](
js-apis-data-rdb.md
#valuetype
)
| 是 | 指示要与谓词匹配的值。 |
| value |
[
ValueType
](
#valuetype
)
| 是 | 指示要与谓词匹配的值。 |
-
返回值:
| 类型 | 说明 |
...
...
@@ -561,7 +561,7 @@ lessThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
lessThanOrEqualTo
(
"
AGE
"
,
20
)
```
...
...
@@ -588,7 +588,7 @@ orderByAsc(field: string): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
orderByAsc
(
"
NAME
"
)
```
...
...
@@ -615,7 +615,7 @@ orderByDesc(field: string): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
orderByDesc
(
"
AGE
"
)
```
...
...
@@ -637,7 +637,7 @@ distinct(): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回可用于过滤重复记录的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
equalTo
(
"
NAME
"
,
"
Rose
"
).
distinct
(
"
NAME
"
)
let
promiseDistinct
=
rdbStore
.
query
(
predicates
,
[
"
NAME
"
])
...
...
@@ -670,7 +670,7 @@ limitAs(value: number): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回可用于设置最大数据记录数的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
equalTo
(
"
NAME
"
,
"
Rose
"
).
limitAs
(
3
)
```
...
...
@@ -697,7 +697,7 @@ offsetAs(rowOffset: number): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回具有指定返回结果起始位置的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
equalTo
(
"
NAME
"
,
"
Rose
"
).
offsetAs
(
3
)
```
...
...
@@ -724,7 +724,7 @@ groupBy(fields: Array<string>): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回分组查询列的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
groupBy
([
"
AGE
"
,
"
NAME
"
])
```
...
...
@@ -749,7 +749,7 @@ indexedBy(field: string): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回具有指定索引列的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
indexedBy
(
"
SALARY_INDEX
"
)
```
...
...
@@ -769,7 +769,7 @@ in(field: string, value: Array<ValueType>): DataAbilityPredicates
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | Array
<
[ValueType](
js-apis-data-rdb.md#valuetype)
>
| 是 | 以ValueType
型数组形式指定的要匹配的值。 |
| value | Array
<
[ValueType](
#valuetype)
>
| 是 | 以ValueType类
型数组形式指定的要匹配的值。 |
-
返回值:
...
...
@@ -778,7 +778,7 @@ in(field: string, value: Array<ValueType>): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
in
(
"
AGE
"
,
[
18
,
20
])
```
...
...
@@ -798,7 +798,7 @@ notIn(field: string, value: Array<ValueType>): DataAbilityPredicates
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | Array
<
[ValueType](
js-apis-data-rdb.md#valuetype)
>
| 是 | 以ValueType
型数组形式指定的要匹配的值。 |
| value | Array
<
[ValueType](
#valuetype)
>
| 是 | 以ValueType类
型数组形式指定的要匹配的值。 |
-
返回值:
...
...
@@ -807,8 +807,19 @@ notIn(field: string, value: Array<ValueType>): DataAbilityPredicates
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
-
示例:
```
```
js
let
predicates
=
new
dataAbility
.
DataAbilityPredicates
(
"
EMPLOYEE
"
)
predicates
.
notIn
(
"
NAME
"
,
[
"
Lisa
"
,
"
Rose
"
])
```
## ValueType
用于表示允许的数据字段类型。
**系统能力**
:SystemCapability.DistributedDataManager.DataShare.Core。
| 名称 | 说明 |
| ------- | -------------------- |
| number | 表示值类型为数字。 |
| string | 表示值类型为字符。 |
| boolean | 表示值类型为布尔值。 |
zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md
浏览文件 @
f4fc4c6f
...
...
@@ -7,7 +7,7 @@
## 导入模块
```
js
import
distributedObject
from
'
@ohos.data.distributedDataObject
'
import
distributedObject
from
'
@ohos.data.distributedDataObject
'
;
```
...
...
@@ -25,11 +25,11 @@ createDistributedObject(source: object): DistributedObject
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| source | object | 是 | 设置distributedObject的属性。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DistributedObject
](
#distributedobject
)
| 创建好
的分布式对象。 |
| 类型 | 说明 |
| -------- | -------- |
|
[
DistributedObject
](
#distributedobject
)
| 创建完成
的分布式对象。 |
**示例:**
```
js
...
...
@@ -83,7 +83,7 @@ setSessionId(sessionId?: string): boolean
| 类型 | 说明 |
| -------- | -------- |
| boolean | true:标识设置sessionId成功;
<br>
false:标识设置sessionId失败。 |
**示例:**
```
js
...
...
@@ -171,8 +171,6 @@ on(type: 'status', callback: Callback<{ sessionId: string, networkId: string, st
| type | string | 是 | 事件类型,固定为'status',表示对象上下线。 |
| callback | Callback
<
{
sessionId:
string
,
networkId:
string
,
status:
'
online
'
\|
'
offline
'
}
>
| 是 | 监听上下线回调实例。
<br>
sessionId:标识变更对象的sessionId;
<br>
networkId:标识对象设备的networkId;
<br>
status:标识对象为'online'(上线)或'offline'(下线)的状态。 |
**示例:**
```
js
import
distributedObject
from
'
@ohos.data.distributedDataObject
'
...
...
zh-cn/application-dev/reference/apis/js-apis-data-preferences.md
浏览文件 @
f4fc4c6f
...
...
@@ -10,18 +10,17 @@
## 导入模块
```
ts
import
data_preferences
from
'
@ohos.data.preferences
'
import
data_preferences
from
'
@ohos.data.preferences
'
;
```
##
属性
##
常量
**系统能力**
:以下各项对应的系统能力均为SystemCapability.DistributedDataManager.Preferences.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| MAX_KEY_LENGTH | string | 是 | 否 | key的最大长度限制,大小为80字节。 |
| MAX_VALUE_LENGTH | string | 是 | 否 | string类型value的最大长度限制,大小为8192字节。 |
| ValueType | number丨string丨boolean | 是 | 否 | 默认返回值,支持number、string、boolean。 |
| MAX_VALUE_LENGTH | string | 是 | 否 | value的最大长度限制,大小为8192字节。 |
## data_preferences.getPreferences
...
...
@@ -45,7 +44,7 @@ getPreferences(context: Context, name: string, callback: AsyncCallback<Prefer
import
Ability
from
'
@ohos.application.Ability
'
import
data_preferences
from
'
@ohos.data.preferences
'
export
default
class
MainAbility
extends
Ability
{
data_preferences
.
getPreferences
(
this
.
context
,
'
mystore
'
,
function
(
err
,
preferences
)
{
if
(
err
)
{
console
.
info
(
"
Get the preferences failed
"
)
...
...
@@ -94,7 +93,7 @@ getPreferences(context: Context, name: string): Promise<Preferences>
import
Ability
from
'
@ohos.application.Ability
'
import
data_preferences
from
'
@ohos.data.preferences
'
export
default
class
MainAbility
extends
Ability
{
let
promise
=
data_preferences
.
getPreferences
(
this
.
context
,
'
mystore
'
)
promise
.
then
((
preferences
)
=>
{
preferences
.
put
(
'
startup
'
,
'
auto
'
,
function
(
err
)
{
...
...
@@ -139,7 +138,7 @@ deletePreferences(context: Context, name: string, callback: AsyncCallback<voi
import
Ability
from
'
@ohos.application.Ability
'
import
data_preferences
from
'
@ohos.data.preferences
'
export
default
class
MainAbility
extends
Ability
{
data_preferences
.
deletePreferences
(
this
.
context
,
'
mystore
'
,
function
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Deleted failed, err:
"
+
err
)
...
...
@@ -176,7 +175,7 @@ deletePreferences(context: Context, name: string): Promise<void>
import
Ability
from
'
@ohos.application.Ability
'
import
data_preferences
from
'
@ohos.data.preferences
'
export
default
class
MainAbility
extends
Ability
{
let
promise
=
data_preferences
.
deletePreferences
(
this
.
context
,
'
mystore
'
)
promise
.
then
(()
=>
{
console
.
info
(
"
Deleted successfully.
"
)
...
...
@@ -191,7 +190,9 @@ deletePreferences(context: Context, name: string): Promise<void>
removePreferencesFromCache(context: Context, name: string, callback: AsyncCallback
<
void
>
): void
从内存中移除指定首选项持久化文件对应的Preferences单实例。移除Preferences单实例时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题,该方法使用callback方式作为异步方法。
从内存中移除指定首选项持久化文件对应的Preferences单实例。
移除Preferences单实例时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题,该方法使用callback方式作为异步方法。
**系统能力**
:SystemCapability.DistributedDataManager.Preferences.Core
...
...
@@ -207,7 +208,7 @@ removePreferencesFromCache(context: Context, name: string, callback: AsyncCallba
import
Ability
from
'
@ohos.application.Ability
'
import
data_preferences
from
'
@ohos.data.preferences
'
export
default
class
MainAbility
extends
Ability
{
data_preferences
.
removePreferencesFromCache
(
this
.
context
,
'
mystore
'
,
function
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Removed preferences from cache failed, err:
"
+
err
)
...
...
@@ -223,7 +224,9 @@ removePreferencesFromCache(context: Context, name: string, callback: AsyncCallba
removePreferencesFromCache(context: Context, name: string): Promise
<
void
>
从内存中移除指定首选项持久化文件对应的Preferences单实例。移除Preferences单实例时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题,该方法使用Promise方式作为异步方法。
从内存中移除指定首选项持久化文件对应的Preferences单实例。
移除Preferences单实例时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题,该方法使用Promise方式作为异步方法。
**系统能力**
:SystemCapability.DistributedDataManager.Preferences.Core
...
...
@@ -243,7 +246,7 @@ removePreferencesFromCache(context: Context, name: string): Promise<void>
import
Ability
from
'
@ohos.application.Ability
'
import
data_preferences
from
'
@ohos.data.preferences
'
export
default
class
MainAbility
extends
Ability
{
let
promise
=
data_preferences
.
removePreferencesFromCache
(
this
.
context
,
'
mystore
'
)
promise
.
then
(()
=>
{
console
.
info
(
"
Removed preferences from cache successfully.
"
)
...
...
@@ -271,7 +274,7 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>):
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称,不能为空。 |
| defValue |
[
ValueType
](
#
属性
)
| 是 | 默认返回值。支持number、string、boolean。 |
| defValue |
[
ValueType
](
#
valuetype
)
| 是 | 默认返回值。支持number、string、boolean。 |
| callback | AsyncCallback
<
ValueType
>
| 是 | 回调函数。 |
-
示例:
...
...
@@ -309,7 +312,7 @@ get(key: string, defValue: ValueType): Promise<ValueType>
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称,不能为空。 |
| defValue |
[
ValueType
](
#
属性
)
| 是 | 默认返回值。支持number、string、boolean。 |
| defValue |
[
ValueType
](
#
valuetype
)
| 是 | 默认返回值。支持number、string、boolean。 |
-
返回值:
| 类型 | 说明 |
...
...
@@ -349,7 +352,7 @@ put(key: string, value: ValueType, callback: AsyncCallback<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要修改的存储的key,不能为空。 |
| value |
[
ValueType
](
#
属性
)
| 是 | 存储的新值。支持number、string、boolean。 |
| value |
[
ValueType
](
#
valuetype
)
| 是 | 存储的新值。支持number、string、boolean。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
-
示例:
...
...
@@ -387,7 +390,7 @@ put(key: string, value: ValueType): Promise<void>
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要修改的存储的key,不能为空。 |
| value |
[
ValueType
](
#
属性
)
| 是 | 存储的新值。支持number、string、boolean。 |
| value |
[
ValueType
](
#
valuetype
)
| 是 | 存储的新值。支持number、string、boolean。 |
-
返回值:
| 类型 | 说明 |
...
...
@@ -484,7 +487,7 @@ has(key: string): Promise<boolean>
import
Ability
from
'
@ohos.application.Ability
'
import
data_preferences
from
'
@ohos.data.preferences
'
export
default
class
MainAbility
extends
Ability
{
let
promise
=
data_preferences
.
getPreferences
(
this
.
context
,
'
mystore
'
)
promise
.
then
((
preferences
)
=>
{
let
promiseHas
=
preferences
.
has
(
'
startup
'
)
...
...
@@ -814,3 +817,15 @@ off(type: 'change', callback: Callback<{ key : string }>): void
})
}
```
## ValueType
用于表示允许的数据字段类型。
**系统能力**
:SystemCapability.DistributedDataManager.Preferences.Core
| 名称 | 说明 |
| ------- | -------------------- |
| number | 表示值类型为数字。 |
| string | 表示值类型为字符。 |
| boolean | 表示值类型为布尔值。 |
zh-cn/application-dev/reference/apis/js-apis-data-rdb.md
浏览文件 @
f4fc4c6f
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-data-resultset.md
浏览文件 @
f4fc4c6f
...
...
@@ -8,7 +8,7 @@
需要通过
[
RdbStore.query()
](
js-apis-data-rdb.md#query
)
获取resultSet对象。
```
```
js
import
dataRdb
from
'
@ohos.data.rdb
'
;
let
predicates
=
new
dataRdb
.
RdbPredicates
(
"
EMPLOYEE
"
)
predicates
.
equalTo
(
"
AGE
"
,
18
)
...
...
@@ -18,10 +18,6 @@ promise.then((resultSet) => {
console
.
log
(
TAG
+
"
resultSet columnCount:
"
+
resultSet
.
columnCount
);})
```
## ResultSet
提供通过查询数据库生成的数据库结果集的访问方法。
...
...
@@ -63,7 +59,7 @@ getColumnIndex(columnName: string): number
| number | 返回指定列的索引。 |
-
示例:
```
```
js
resultSet
.
goToFirstRow
()
const
id
=
resultSet
.
getLong
(
resultSet
.
getColumnIndex
(
"
ID
"
))
const
name
=
resultSet
.
getString
(
resultSet
.
getColumnIndex
(
"
NAME
"
))
...
...
@@ -91,7 +87,7 @@ getColumnName(columnIndex: number): string
| string | 返回指定列的名称。 |
-
示例:
```
```
js
const
id
=
resultSet
.
getColumnName
(
0
)
const
name
=
resultSet
.
getColumnName
(
1
)
const
age
=
resultSet
.
getColumnName
(
2
)
...
...
@@ -117,7 +113,7 @@ goTo(offset:number): boolean
| boolean | 如果成功移动结果集,则为true;否则返回false。 |
-
示例:
```
```
js
let
predicatesgoto
=
new
dataRdb
.
RdbPredicates
(
"
EMPLOYEE
"
)
let
promisequerygoto
=
rdbStore
.
query
(
predicatesgoto
,
[
"
ID
"
,
"
NAME
"
,
"
AGE
"
,
"
SALARY
"
,
"
CODES
"
])
promisequerygoto
.
then
((
resultSet
)
{
...
...
@@ -148,7 +144,7 @@ goToRow(position: number): boolean
| boolean | 如果成功移动结果集,则为true;否则返回false。 |
-
示例:
```
```
js
let
predicatesgotorow
=
new
dataRdb
.
RdbPredicates
(
"
EMPLOYEE
"
)
let
promisequerygotorow
=
rdbStore
.
query
(
predicatesgotorow
,
[
"
ID
"
,
"
NAME
"
,
"
AGE
"
,
"
SALARY
"
,
"
CODES
"
])
promisequerygotorow
.
then
((
resultSet
)
{
...
...
@@ -175,7 +171,7 @@ goToFirstRow(): boolean
| boolean | 如果成功移动结果集,则为true;否则返回false。 |
-
示例:
```
```
js
let
predicatesgoFirst
=
new
dataRdb
.
RdbPredicates
(
"
EMPLOYEE
"
)
let
promisequerygoFirst
=
rdbStore
.
query
(
predicatesgoFirst
,
[
"
ID
"
,
"
NAME
"
,
"
AGE
"
,
"
SALARY
"
,
"
CODES
"
])
promisequerygoFirst
.
then
((
resultSet
)
{
...
...
@@ -201,7 +197,7 @@ goToLastRow(): boolean
| boolean | 如果成功移动结果集,则为true;否则返回false。 |
-
示例:
```
```
js
let
predicatesgoLast
=
new
dataRdb
.
RdbPredicates
(
"
EMPLOYEE
"
)
let
promisequerygoLast
=
rdbStore
.
query
(
predicatesgoLast
,
[
"
ID
"
,
"
NAME
"
,
"
AGE
"
,
"
SALARY
"
,
"
CODES
"
])
promisequerygoLast
.
then
((
resultSet
)
{
...
...
@@ -227,7 +223,7 @@ goToNextRow(): boolean
| boolean | 如果成功移动结果集,则为true;否则返回false。 |
-
示例:
```
```
js
let
predicatesgoNext
=
new
dataRdb
.
RdbPredicates
(
"
EMPLOYEE
"
)
let
promisequerygoNext
=
rdbStore
.
query
(
predicatesgoNext
,
[
"
ID
"
,
"
NAME
"
,
"
AGE
"
,
"
SALARY
"
,
"
CODES
"
])
promisequerygoNext
.
then
((
resultSet
)
{
...
...
@@ -253,7 +249,7 @@ goToPreviousRow(): boolean
| boolean | 如果成功移动结果集,则为true;否则返回false。 |
-
示例:
```
```
js
let
predicatesgoPrev
=
new
dataRdb
.
RdbPredicates
(
"
EMPLOYEE
"
)
let
promisequerygoPrev
=
rdbStore
.
query
(
predicatesgoPrev
,
[
"
ID
"
,
"
NAME
"
,
"
AGE
"
,
"
SALARY
"
,
"
CODES
"
])
promisequerygoPrev
.
then
((
resultSet
)
{
...
...
@@ -284,7 +280,7 @@ getBlob(columnIndex: number): Uint8Array
| Uint8Array | 以字节数组的形式返回指定列的值。 |
-
示例:
```
```
js
const
codes
=
resultSet
.
getBlob
(
resultSet
.
getColumnIndex
(
"
CODES
"
))
```
...
...
@@ -308,7 +304,7 @@ getString(columnIndex: number): string
| string | 以字符串形式返回指定列的值。 |
-
示例:
```
```
js
const
name
=
resultSet
.
getString
(
resultSet
.
getColumnIndex
(
"
NAME
"
))
```
...
...
@@ -332,7 +328,7 @@ getLong(columnIndex: number): number
| number | 以Long形式返回指定列的值。 |
-
示例:
```
```
js
const
age
=
resultSet
.
getLong
(
resultSet
.
getColumnIndex
(
"
AGE
"
))
```
...
...
@@ -356,7 +352,7 @@ getDouble(columnIndex: number): number
| number | 以double形式返回指定列的值。 |
-
示例:
```
```
js
const
salary
=
resultSet
.
getDouble
(
resultSet
.
getColumnIndex
(
"
SALARY
"
))
```
...
...
@@ -380,7 +376,7 @@ isColumnNull(columnIndex: number): boolean
| boolean | 如果当前行中指定列的值为null,则返回true,否则返回false。 |
-
示例:
```
```
js
const
isColumnNull
=
resultSet
.
isColumnNull
(
resultSet
.
getColumnIndex
(
"
CODES
"
))
```
...
...
@@ -394,7 +390,7 @@ close(): void
**系统能力**
:SystemCapability.DistributedDataManager.RelationalStore.Core。
-
示例:
```
```
js
let
predicatesclose
=
new
dataRdb
.
RdbPredicates
(
"
EMPLOYEE
"
)
let
predicatesclose
=
rdbStore
.
query
(
predicatesclose
,
[
"
ID
"
,
"
NAME
"
,
"
AGE
"
,
"
SALARY
"
,
"
CODES
"
])
promisequerygoPrev
.
then
((
resultSet
)
{
...
...
@@ -403,3 +399,4 @@ close(): void
console
.
log
(
'
query failed
'
)
})
```
zh-cn/application-dev/reference/apis/js-apis-data-storage.md
浏览文件 @
f4fc4c6f
...
...
@@ -12,18 +12,18 @@
## 导入模块
```
import dataStorage from '@ohos.data.storage'
```
js
import
dataStorage
from
'
@ohos.data.storage
'
;
```
##
属性
##
常量
**系统能力**
:以下各项对应的系统能力均为SystemCapability.DistributedDataManager.Preferences.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| MAX_KEY_LENGTH | string | 是 | 否 | key的最大长度限制,大小为80字节。 |
| MAX_VALUE_LENGTH | string | 是 | 否 |
string类型
value的最大长度限制,大小为8192字节。 |
| MAX_VALUE_LENGTH | string | 是 | 否 | value的最大长度限制,大小为8192字节。 |
## dataStorage.getStorageSync
...
...
@@ -45,7 +45,7 @@ getStorageSync(path: string): Storage
|
[
Storage
](
#storage
)
| 获取到要操作的Storage实例,用于进行数据存储操作。 |
-
示例:
```
```
js
import
dataStorage
from
'
@ohos.data.storage
'
import
featureAbility
from
'
@ohos.ability.featureAbility
'
...
...
@@ -78,7 +78,7 @@ getStorage(path: string, callback: AsyncCallback<Storage>): void
| callback | AsyncCallback
<
[Storage](#storage)
>
| 是 | 回调函数。 |
-
示例:
```
```
js
import
dataStorage
from
'
@ohos.data.storage
'
import
featureAbility
from
'
@ohos.ability.featureAbility
'
...
...
@@ -120,7 +120,7 @@ getStorage(path: string): Promise<Storage>
| Promise
<
[Storage](#storage)
>
| Promise实例,用于异步获取结果。 |
-
示例:
```
```
js
import
dataStorage
from
'
@ohos.data.storage
'
import
featureAbility
from
'
@ohos.ability.featureAbility
'
...
...
@@ -176,7 +176,7 @@ deleteStorage(path: string, callback: AsyncCallback<void>): void
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
-
示例:
```
```
js
dataStorage
.
deleteStorage
(
path
+
'
/mystore
'
,
function
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Deleted failed with err:
"
+
err
)
...
...
@@ -206,7 +206,7 @@ deleteStorage(path: string): Promise<void>
| Promise
<
void
>
| Promise实例,用于异步获取结果。 |
-
示例:
```
```
js
let
promisedelSt
=
dataStorage
.
deleteStorage
(
path
+
'
/mystore
'
)
promisedelSt
.
then
(()
=>
{
console
.
info
(
"
Deleted successfully.
"
)
...
...
@@ -232,7 +232,7 @@ removeStorageFromCacheSync(path: string): void
| path | string | 是 | 应用程序内部数据存储路径。 |
-
示例:
```
```
js
dataStorage
.
removeStorageFromCacheSync
(
path
+
'
/mystore
'
)
```
...
...
@@ -254,7 +254,7 @@ removeStorageFromCache(path: string, callback: AsyncCallback<void>): void
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
-
示例:
```
```
js
dataStorage
.
removeStorageFromCache
(
path
+
'
/mystore
'
,
function
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Removed storage from cache failed with err:
"
+
err
)
...
...
@@ -286,7 +286,7 @@ removeStorageFromCache(path: string): Promise<void>
| Promise
<
void
>
| Promise实例,用于异步获取结果。 |
-
示例:
```
```
js
let
promiserevSt
=
dataStorage
.
removeStorageFromCache
(
path
+
'
/mystore
'
)
promiserevSt
.
then
(()
=>
{
console
.
info
(
"
Removed storage from cache successfully.
"
)
...
...
@@ -314,8 +314,8 @@ getSync(key: string, defValue: ValueType): ValueType
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称
。它
不能为空。 |
| defValue |
ValueType
| 是 | 给定key的存储不存在,则要返回的默认值。支持number、string、boolean。 |
| key | string | 是 | 要获取的存储key名称
,
不能为空。 |
| defValue |
[
ValueType
](
#valuetype
)
| 是 | 给定key的存储不存在,则要返回的默认值。支持number、string、boolean。 |
-
返回值:
| 类型 | 说明 |
...
...
@@ -323,7 +323,7 @@ getSync(key: string, defValue: ValueType): ValueType
| ValueType | 键对应的值,如果值为null或者非默认值类型,返回默认数据。 |
-
示例:
```
```
js
let
value
=
storage
.
getSync
(
'
startup
'
,
'
default
'
)
console
.
info
(
"
The value of startup is
"
+
value
)
```
...
...
@@ -342,12 +342,12 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>):
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称
。它
不能为空。 |
| defValue |
ValueType
| 是 | 默认返回值。支持number、string、boolean。 |
| key | string | 是 | 要获取的存储key名称
,
不能为空。 |
| defValue |
[
ValueType
](
#valuetype
)
| 是 | 默认返回值。支持number、string、boolean。 |
| callback | AsyncCallback
<
ValueType
>
| 是 | 回调函数。 |
-
示例:
```
```
js
storage
.
get
(
'
startup
'
,
'
default
'
,
function
(
err
,
value
)
{
if
(
err
)
{
console
.
info
(
"
Get the value of startup failed with err:
"
+
err
)
...
...
@@ -371,8 +371,8 @@ get(key: string, defValue: ValueType): Promise<ValueType>
-
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称
。它
不能为空。 |
| defValue |
ValueType
| 是 | 默认返回值。支持number、string、boolean。 |
| key | string | 是 | 要获取的存储key名称
,
不能为空。 |
| defValue |
[
ValueType
](
#valuetype
)
| 是 | 默认返回值。支持number、string、boolean。 |
-
返回值:
| 类型 | 说明 |
...
...
@@ -380,7 +380,7 @@ get(key: string, defValue: ValueType): Promise<ValueType>
| Promise
<
ValueType
>
| Promise实例,用于异步获取结果。 |
-
示例:
```
```
js
let
promiseget
=
storage
.
get
(
'
startup
'
,
'
default
'
)
promiseget
.
then
((
value
)
=>
{
console
.
info
(
"
The value of startup is
"
+
value
)
...
...
@@ -403,11 +403,11 @@ putSync(key: string, value: ValueType): void
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要修改的存储的key
。它
不能为空。 |
| value |
ValueType
| 是 | 存储的新值。支持number、string、boolean。 |
| key | string | 是 | 要修改的存储的key
,
不能为空。 |
| value |
[
ValueType
](
#valuetype
)
| 是 | 存储的新值。支持number、string、boolean。 |
-
示例:
```
```
js
storage
.
putSync
(
'
startup
'
,
'
auto
'
)
```
...
...
@@ -425,12 +425,12 @@ put(key: string, value: ValueType, callback: AsyncCallback<void>): void
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要修改的存储的key
。它
不能为空。 |
| value |
ValueType
| 是 | 存储的新值。支持number、string、boolean。 |
| key | string | 是 | 要修改的存储的key
,
不能为空。 |
| value |
[
ValueType
](
#valuetype
)
| 是 | 存储的新值。支持number、string、boolean。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
-
示例:
```
```
js
storage
.
put
(
'
startup
'
,
'
auto
'
,
function
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Put the value of startup failed with err:
"
+
err
)
...
...
@@ -454,8 +454,8 @@ put(key: string, value: ValueType): Promise<void>
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要修改的存储的key
。它
不能为空。 |
| value |
ValueType
| 是 | 存储的新值。支持number、string、boolean。 |
| key | string | 是 | 要修改的存储的key
,
不能为空。 |
| value |
[
ValueType
](
#valuetype
)
| 是 | 存储的新值。支持number、string、boolean。 |
-
返回值:
| 类型 | 说明 |
...
...
@@ -463,7 +463,7 @@ put(key: string, value: ValueType): Promise<void>
| Promise
<
void
>
| Promise实例,用于异步处理。 |
-
示例:
```
```
js
let
promiseput
=
storage
.
put
(
'
startup
'
,
'
auto
'
)
promiseput
.
then
(()
=>
{
console
.
info
(
"
Put the value of startup successfully.
"
)
...
...
@@ -486,7 +486,7 @@ hasSync(key: string): boolean
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称
。它
不能为空。 |
| key | string | 是 | 要获取的存储key名称
,
不能为空。 |
-
返回值:
| 类型 | 说明 |
...
...
@@ -494,7 +494,7 @@ hasSync(key: string): boolean
| boolean | true
表示存在,false表示不存在。 |
-
示例:
```
```
js
let
isExist
=
storage
.
hasSync
(
'
startup
'
)
if
(
isExist
)
{
console
.
info
(
"
The key of startup is contained.
"
)
...
...
@@ -524,7 +524,7 @@ has(key: string, callback: AsyncCallback<boolean>): boolean
| boolean | true表示存在,false表示不存在。 |
-
示例:
```
```
js
storage
.
has
(
'
startup
'
,
function
(
err
,
isExist
)
{
if
(
err
)
{
console
.
info
(
"
Check the key of startup failed with err:
"
+
err
)
...
...
@@ -550,7 +550,7 @@ has(key: string): Promise<boolean>
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称
。它
不能为空。 |
| key | string | 是 | 要获取的存储key名称
,
不能为空。 |
-
返回值:
| 类型 | 说明 |
...
...
@@ -558,7 +558,7 @@ has(key: string): Promise<boolean>
| Promise
<
boolean
>
| Promise实例,用于异步处理。 |
-
示例:
```
```
js
let
promisehas
=
storage
.
has
(
'
startup
'
)
promisehas
.
then
((
isExist
)
=>
{
if
(
isExist
)
{
...
...
@@ -586,12 +586,12 @@ deleteSync(key: string): void
| key | string | 是 | 要获取的存储key名称。它不能为空。 |
-
示例:
```
```
js
storage
.
deleteSync
(
'
startup
'
)
```
### delete
### delete
j
delete(key: string, callback: AsyncCallback
<
void
>
): void
...
...
@@ -608,7 +608,7 @@ delete(key: string, callback: AsyncCallback<void>): void
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
-
示例:
```
```
js
storage
.
delete
(
'
startup
'
,
function
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Delete startup key failed with err:
"
+
err
)
...
...
@@ -640,7 +640,7 @@ delete(key: string): Promise<void>
| Promise
<
void
>
| Promise实例,用于异步处理。 |
-
示例:
```
```
js
let
promisedel
=
storage
.
delete
(
'
startup
'
)
promisedel
.
then
(()
=>
{
console
.
info
(
"
Deleted startup key successfully.
"
)
...
...
@@ -661,7 +661,7 @@ flushSync(): void
**系统能力**
:SystemCapability.DistributedDataManager.Preferences.Core
-
示例:
```
```
js
storage
.
flushSync
()
```
...
...
@@ -682,7 +682,7 @@ flush(callback: AsyncCallback<void>): void
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
-
示例:
```
```
js
storage
.
flush
(
function
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Flush to file failed with err:
"
+
err
)
...
...
@@ -709,7 +709,7 @@ flush(): Promise<void>
| Promise
<
void
>
| Promise实例,用于异步处理。 |
-
示例:
```
```
js
let
promiseflush
=
storage
.
flush
()
promiseflush
.
then
(()
=>
{
console
.
info
(
"
Flushed to file successfully.
"
)
...
...
@@ -730,7 +730,7 @@ clearSync(): void
**系统能力**
:SystemCapability.DistributedDataManager.Preferences.Core
-
示例:
```
```
js
storage
.
clearSync
()
```
...
...
@@ -751,7 +751,7 @@ clear(callback: AsyncCallback<void>): void
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
-
示例:
```
```
js
storage
.
clear
(
function
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Clear to file failed with err:
"
+
err
)
...
...
@@ -778,7 +778,7 @@ clear(): Promise<void>
| Promise
<
void
>
| Promise实例,用于异步处理。 |
-
示例:
```
```
js
let
promiseclear
=
storage
.
clear
()
promiseclear
.
then
(()
=>
{
console
.
info
(
"
Cleared to file successfully.
"
)
...
...
@@ -803,7 +803,7 @@ on(type: 'change', callback: Callback<StorageObserver>): void
| callback | Callback
<
[StorageObserver](#storageobserver)
>
| 回调对象实例。 |
-
示例:
```
```
js
var
observer
=
function
(
key
)
{
console
.
info
(
"
The key of
"
+
key
+
"
changed.
"
)
}
...
...
@@ -828,7 +828,7 @@ off(type: 'change', callback: Callback<StorageObserver>): void
| callback | Callback
<
[StorageObserver](#storageobserver)
>
| 需要取消的回调对象实例。 |
-
示例:
```
```
js
var
observer
=
function
(
key
)
{
console
.
info
(
"
The key of
"
+
key
+
"
changed.
"
)
}
...
...
@@ -843,3 +843,15 @@ off(type: 'change', callback: Callback<StorageObserver>): void
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 否 | 变更的数据内容。 |
## ValueType
用于表示允许的数据字段类型。
**系统能力**
:SystemCapability.DistributedDataManager.Preferences.Core
| 名称 | 说明 |
| ------- | -------------------- |
| number | 表示值类型为数字。 |
| string | 表示值类型为字符。 |
| boolean | 表示值类型为布尔值。 |
zh-cn/application-dev/reference/apis/js-apis-distributed-data.md
浏览文件 @
f4fc4c6f
此差异已折叠。
点击以展开。
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录