Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
46dc8e2b
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看板
体验新版 GitCode,发现更多精彩内容 >>
提交
46dc8e2b
编写于
6月 15, 2022
作者:
L
li_juntao
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
修改preferences描述及示例代码
Signed-off-by:
N
li_juntao
<
lijuntao9@huawei.com
>
上级
dca5036f
变更
3
隐藏空白更改
内联
并排
Showing
3 changed file
with
99 addition
and
117 deletion
+99
-117
zh-cn/application-dev/database/database-preference-guidelines.md
...pplication-dev/database/database-preference-guidelines.md
+15
-15
zh-cn/application-dev/reference/apis/js-apis-data-preferences.md
...pplication-dev/reference/apis/js-apis-data-preferences.md
+48
-44
zh-cn/application-dev/reference/apis/js-apis-data-storage.md
zh-cn/application-dev/reference/apis/js-apis-data-storage.md
+36
-58
未找到文件。
zh-cn/application-dev/database/database-preference-guidelines.md
浏览文件 @
46dc8e2b
...
@@ -26,7 +26,7 @@
...
@@ -26,7 +26,7 @@
| 类名 | 接口名 | 描述 |
| 类名 | 接口名 | 描述 |
| ------- | -------------------------------------------------- | ----------------------------------------------- |
| ------- | -------------------------------------------------- | ----------------------------------------------- |
| Preferences | put(key: string, value: ValueType): Promise
\<
void> | 支持值为number、string、boolean
类型的数据存入,同时也支持Array
<number>
、Array
<string>
、Array
<boolean>
三种类型的数组的
存入。 |
| Preferences | put(key: string, value: ValueType): Promise
\<
void> | 支持值为number、string、boolean
、Array
\<
number>、Array
\<
string>、Array
\<
boolean>类型的数据
存入。 |
### 读取数据
### 读取数据
...
@@ -36,7 +36,7 @@
...
@@ -36,7 +36,7 @@
| 类名 | 接口名 | 描述 |
| 类名 | 接口名 | 描述 |
| ------- | ---------------------------------------------------------- | ----------------------------------------------- |
| ------- | ---------------------------------------------------------- | ----------------------------------------------- |
| Preferences | get(key: string, defValue: ValueType): Promise
\<
ValueType> | 支持获取值为number、string、boolean
类型的数据,同时也支持获取值为Array
<number>
、Array
<string>
、Array
<boolean>
三种数组
类型的数据。 |
| Preferences | get(key: string, defValue: ValueType): Promise
\<
ValueType> | 支持获取值为number、string、boolean
、Array
\<
number>、Array
\<
string>、Array
\<
boolean>
类型的数据。 |
### 数据持久化
### 数据持久化
...
@@ -67,7 +67,7 @@
...
@@ -67,7 +67,7 @@
| 包名 | 接口名 | 描述 |
| 包名 | 接口名 | 描述 |
| ----------------- | ---------------------------------------------------- | ------------------------------------------------------------ |
| ----------------- | ---------------------------------------------------- | ------------------------------------------------------------ |
| ohos.data.preferences | deletePreferences(context: Context, name: string): Promise
<void>
; | 从缓存中移除已加载的Preferences对象,同时从设备上删除对应的文件。 |
| ohos.data.preferences | deletePreferences(context: Context, name: string): Promise
\
<
void>; | 从缓存中移除已加载的Preferences对象,同时从设备上删除对应的文件。 |
| ohos.data.preferences | removePreferencesFromCache(context: Context, name: string): Promise
\<
void>; | 仅从缓存中移除已加载的Preferences对象,主要用于释放内存。
| ohos.data.preferences | removePreferencesFromCache(context: Context, name: string): Promise
\<
void>; | 仅从缓存中移除已加载的Preferences对象,主要用于释放内存。
## 开发步骤
## 开发步骤
...
@@ -75,14 +75,14 @@
...
@@ -75,14 +75,14 @@
1.
准备工作,导入@ohos.data.preferences以及相关的模块到开发环境。
1.
准备工作,导入@ohos.data.preferences以及相关的模块到开发环境。
```
js
```
js
import
preferences
from
'
@ohos.data.preferences
'
import
data_
preferences
from
'
@ohos.data.preferences
'
```
```
2.
获取Preferences实例。
2.
获取Preferences实例。
读取指定文件,将数据加载到Preferences实例,用于数据操作。
读取指定文件,将数据加载到Preferences实例,用于数据操作。
```
js
```
js
let
promise
=
preferences
.
getPreferences
(
this
.
context
,
'
mystore
'
)
let
promise
=
data_
preferences
.
getPreferences
(
this
.
context
,
'
mystore
'
)
```
```
3.
存入数据。
3.
存入数据。
...
@@ -90,8 +90,8 @@
...
@@ -90,8 +90,8 @@
使用Preferences put方法保存数据到缓存的实例中。
使用Preferences put方法保存数据到缓存的实例中。
```
js
```
js
promise
.
then
((
pref
)
=>
{
promise
.
then
((
pref
erences
)
=>
{
let
putPromise
=
pref
.
put
(
'
startup
'
,
'
auto
'
)
let
putPromise
=
pref
erences
.
put
(
'
startup
'
,
'
auto
'
)
putPromise
.
then
(()
=>
{
putPromise
.
then
(()
=>
{
console
.
info
(
"
Put the value of startup successfully.
"
)
console
.
info
(
"
Put the value of startup successfully.
"
)
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
...
@@ -107,8 +107,8 @@
...
@@ -107,8 +107,8 @@
使用Preferences get方法读取数据。
使用Preferences get方法读取数据。
```
js
```
js
promise
.
then
((
pref
)
=>
{
promise
.
then
((
pref
erences
)
=>
{
let
getPromise
=
pref
.
get
(
'
startup
'
,
'
default
'
)
let
getPromise
=
pref
erences
.
get
(
'
startup
'
,
'
default
'
)
getPromise
.
then
((
value
)
=>
{
getPromise
.
then
((
value
)
=>
{
console
.
info
(
"
The value of startup is
"
+
value
)
console
.
info
(
"
The value of startup is
"
+
value
)
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
...
@@ -123,7 +123,7 @@
...
@@ -123,7 +123,7 @@
应用存入数据到Preferences实例后,可以通过flush方法将Preferences实例回写到文件中。
应用存入数据到Preferences实例后,可以通过flush方法将Preferences实例回写到文件中。
```
js
```
js
pref
.
flush
();
pref
erences
.
flush
();
```
```
6.
订阅数据变化。
6.
订阅数据变化。
...
@@ -134,14 +134,14 @@
...
@@ -134,14 +134,14 @@
var
observer
=
function
(
key
)
{
var
observer
=
function
(
key
)
{
console
.
info
(
"
The key of
"
+
key
+
"
changed.
"
)
console
.
info
(
"
The key of
"
+
key
+
"
changed.
"
)
}
}
pref
.
on
(
'
change
'
,
observer
)
pref
erences
.
on
(
'
change
'
,
observer
)
pref
.
put
(
'
startup
'
,
'
auto
'
,
function
(
err
)
{
pref
erences
.
put
(
'
startup
'
,
'
auto
'
,
function
(
err
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Put the value of startup failed with err:
"
+
err
)
console
.
info
(
"
Put the value of startup failed with err:
"
+
err
)
return
return
}
}
console
.
info
(
"
Put the value of startup successfully.
"
)
console
.
info
(
"
Put the value of startup successfully.
"
)
pref
.
flush
(
function
(
err
)
{
pref
erences
.
flush
(
function
(
err
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Flush to file failed with err:
"
+
err
)
console
.
info
(
"
Flush to file failed with err:
"
+
err
)
return
return
...
@@ -156,8 +156,8 @@
...
@@ -156,8 +156,8 @@
使用deletePreferences方法从内存中移除指定文件对应的Preferences单实例,并删除指定文件及其备份文件、损坏文件。删除指定文件时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题。删除后,数据及文件将不可恢复。
使用deletePreferences方法从内存中移除指定文件对应的Preferences单实例,并删除指定文件及其备份文件、损坏文件。删除指定文件时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题。删除后,数据及文件将不可恢复。
```
js
```
js
let
deletePromise
=
preferences
.
deletePreferences
(
context
,
'
mystore
'
)
let
proDelete
=
data_
preferences
.
deletePreferences
(
context
,
'
mystore
'
)
deletePromis
e
.
then
(()
=>
{
proDelet
e
.
then
(()
=>
{
console
.
info
(
"
Deleted successfully.
"
)
console
.
info
(
"
Deleted successfully.
"
)
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
console
.
info
(
"
Deleted failed with err:
"
+
err
)
console
.
info
(
"
Deleted failed with err:
"
+
err
)
...
...
zh-cn/application-dev/reference/apis/js-apis-data-preferences.md
浏览文件 @
46dc8e2b
# 首选项
# 首选项
首选项为应用提供key-value键值型的数据处理能力,支持应用持久化轻量级数据,并对其修改和查询。数据存储形式为键值对,键的类型为字符串型,值的存储数据类型包括数字型、字符型、布尔型。
首选项为应用提供key-value键值型的数据处理能力,支持应用持久化轻量级数据,并对其修改和查询。数据存储形式为键值对,键的类型为字符串型,值的存储数据类型包括数字型、字符型、布尔型
以及这3种类型的数组类型
。
> **说明:**
> **说明:**
...
@@ -10,7 +10,7 @@
...
@@ -10,7 +10,7 @@
## 导入模块
## 导入模块
```
ts
```
ts
import
preferences
from
'
@ohos.data.preferences
'
;
import
data_
preferences
from
'
@ohos.data.preferences
'
;
```
```
## 常量
## 常量
...
@@ -23,7 +23,7 @@ import preferences from '@ohos.data.preferences';
...
@@ -23,7 +23,7 @@ import preferences from '@ohos.data.preferences';
| MAX_VALUE_LENGTH | string | 是 | 否 | value的最大长度限制,需小于8192字节。 |
| MAX_VALUE_LENGTH | string | 是 | 否 | value的最大长度限制,需小于8192字节。 |
## preferences.getPreferences
##
data_
preferences.getPreferences
getPreferences(context: Context, name: string, callback: AsyncCallback
<
Preferences
>
): void
getPreferences(context: Context, name: string, callback: AsyncCallback
<
Preferences
>
): void
...
@@ -41,7 +41,7 @@ getPreferences(context: Context, name: string, callback: AsyncCallback<Prefer
...
@@ -41,7 +41,7 @@ getPreferences(context: Context, name: string, callback: AsyncCallback<Prefer
**示例:**
**示例:**
```
ts
```
ts
preferences
.
getPreferences
(
this
.
context
,
'
mystore
'
,
function
(
err
,
pref
)
{
data_preferences
.
getPreferences
(
this
.
context
,
'
mystore
'
,
function
(
err
,
preferences
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Get preferences failed.
"
)
console
.
info
(
"
Get preferences failed.
"
)
return
;
return
;
...
@@ -51,7 +51,7 @@ preferences.getPreferences(this.context, 'mystore', function (err, pref) {
...
@@ -51,7 +51,7 @@ preferences.getPreferences(this.context, 'mystore', function (err, pref) {
```
```
## preferences.getPreferences
##
data_
preferences.getPreferences
getPreferences(context: Context, name: string): Promise
<
Preferences
>
getPreferences(context: Context, name: string): Promise
<
Preferences
>
...
@@ -72,8 +72,8 @@ getPreferences(context: Context, name: string): Promise<Preferences>
...
@@ -72,8 +72,8 @@ getPreferences(context: Context, name: string): Promise<Preferences>
**示例:**
**示例:**
```
ts
```
ts
let
promise
=
preferences
.
getPreferences
(
this
.
context
,
'
mystore
'
)
let
promise
=
data_
preferences
.
getPreferences
(
this
.
context
,
'
mystore
'
)
promise
.
then
((
pref
)
=>
{
promise
.
then
((
pref
erences
)
=>
{
console
.
info
(
"
Get preferences successfully.
"
)
console
.
info
(
"
Get preferences successfully.
"
)
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
console
.
info
(
"
Get preferences failed.
"
)
console
.
info
(
"
Get preferences failed.
"
)
...
@@ -81,7 +81,7 @@ promise.then((pref) => {
...
@@ -81,7 +81,7 @@ promise.then((pref) => {
```
```
## preferences.deletePreferences
##
data_
preferences.deletePreferences
deletePreferences(context: Context, name: string, callback: AsyncCallback
<
void
>
): void
deletePreferences(context: Context, name: string, callback: AsyncCallback
<
void
>
): void
...
@@ -99,7 +99,7 @@ deletePreferences(context: Context, name: string, callback: AsyncCallback<voi
...
@@ -99,7 +99,7 @@ deletePreferences(context: Context, name: string, callback: AsyncCallback<voi
**示例:**
**示例:**
```
ts
```
ts
preferences
.
deletePreferences
(
this
.
context
,
'
mystore
'
,
function
(
err
)
{
data_
preferences
.
deletePreferences
(
this
.
context
,
'
mystore
'
,
function
(
err
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Deleted preferences failed, err:
"
+
err
)
console
.
info
(
"
Deleted preferences failed, err:
"
+
err
)
return
return
...
@@ -109,7 +109,7 @@ preferences.deletePreferences(this.context, 'mystore', function (err) {
...
@@ -109,7 +109,7 @@ preferences.deletePreferences(this.context, 'mystore', function (err) {
```
```
## preferences.deletePreferences
##
data_
preferences.deletePreferences
deletePreferences(context: Context, name: string): Promise
<
void
>
deletePreferences(context: Context, name: string): Promise
<
void
>
...
@@ -131,7 +131,7 @@ deletePreferences(context: Context, name: string): Promise<void>
...
@@ -131,7 +131,7 @@ deletePreferences(context: Context, name: string): Promise<void>
**示例:**
**示例:**
```
ts
```
ts
let
promise
=
preferences
.
deletePreferences
(
this
.
context
,
'
mystore
'
)
let
promise
=
data_
preferences
.
deletePreferences
(
this
.
context
,
'
mystore
'
)
promise
.
then
(()
=>
{
promise
.
then
(()
=>
{
console
.
info
(
"
Deleted preferences successfully.
"
)
console
.
info
(
"
Deleted preferences successfully.
"
)
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
...
@@ -140,7 +140,7 @@ promise.then(() => {
...
@@ -140,7 +140,7 @@ promise.then(() => {
```
```
## preferences.removePreferencesFromCache
##
data_
preferences.removePreferencesFromCache
removePreferencesFromCache(context: Context, name: string, callback: AsyncCallback
<
void
>
): void
removePreferencesFromCache(context: Context, name: string, callback: AsyncCallback
<
void
>
): void
...
@@ -159,7 +159,7 @@ removePreferencesFromCache(context: Context, name: string, callback: AsyncCallba
...
@@ -159,7 +159,7 @@ removePreferencesFromCache(context: Context, name: string, callback: AsyncCallba
**示例:**
**示例:**
```
ts
```
ts
preferences
.
removePreferencesFromCache
(
this
.
context
,
'
mystore
'
,
function
(
err
)
{
data_
preferences
.
removePreferencesFromCache
(
this
.
context
,
'
mystore
'
,
function
(
err
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Removed preferences from cache failed, err:
"
+
err
)
console
.
info
(
"
Removed preferences from cache failed, err:
"
+
err
)
return
return
...
@@ -169,7 +169,7 @@ preferences.removePreferencesFromCache(this.context, 'mystore', function (err) {
...
@@ -169,7 +169,7 @@ preferences.removePreferencesFromCache(this.context, 'mystore', function (err) {
```
```
## preferences.removePreferencesFromCache
##
data_
preferences.removePreferencesFromCache
removePreferencesFromCache(context: Context, name: string): Promise
<
void
>
removePreferencesFromCache(context: Context, name: string): Promise
<
void
>
...
@@ -192,7 +192,7 @@ removePreferencesFromCache(context: Context, name: string): Promise<void>
...
@@ -192,7 +192,7 @@ removePreferencesFromCache(context: Context, name: string): Promise<void>
**示例:**
**示例:**
```
ts
```
ts
let
promise
=
preferences
.
removePreferencesFromCache
(
this
.
context
,
'
mystore
'
)
let
promise
=
data_
preferences
.
removePreferencesFromCache
(
this
.
context
,
'
mystore
'
)
promise
.
then
(()
=>
{
promise
.
then
(()
=>
{
console
.
info
(
"
Removed preferences from cache successfully.
"
)
console
.
info
(
"
Removed preferences from cache successfully.
"
)
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
...
@@ -223,7 +223,7 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>):
...
@@ -223,7 +223,7 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>):
**示例:**
**示例:**
```
ts
```
ts
pref
.
get
(
'
startup
'
,
'
default
'
,
function
(
err
,
value
)
{
pref
erences
.
get
(
'
startup
'
,
'
default
'
,
function
(
err
,
value
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Get value of startup failed, err:
"
+
err
)
console
.
info
(
"
Get value of startup failed, err:
"
+
err
)
return
return
...
@@ -254,7 +254,7 @@ get(key: string, defValue: ValueType): Promise<ValueType>
...
@@ -254,7 +254,7 @@ get(key: string, defValue: ValueType): Promise<ValueType>
**示例:**
**示例:**
```
ts
```
ts
let
promise
=
pref
.
get
(
'
startup
'
,
'
default
'
)
let
promise
=
pref
erences
.
get
(
'
startup
'
,
'
default
'
)
promise
.
then
((
value
)
=>
{
promise
.
then
((
value
)
=>
{
console
.
info
(
"
Get value of startup is
"
+
value
)
console
.
info
(
"
Get value of startup is
"
+
value
)
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
...
@@ -277,7 +277,7 @@ getAll(callback: AsyncCallback<Object>): void;
...
@@ -277,7 +277,7 @@ getAll(callback: AsyncCallback<Object>): void;
**示例:**
**示例:**
```
ts
```
ts
pref
.
getAll
(
function
(
err
,
value
)
{
pref
erences
.
get
.
getAll
(
function
(
err
,
value
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
"
getAll failed, err:
"
+
err
)
console
.
info
(
"
getAll failed, err:
"
+
err
)
return
return
...
@@ -304,7 +304,7 @@ getAll(): Promise<Object>
...
@@ -304,7 +304,7 @@ getAll(): Promise<Object>
**示例:**
**示例:**
```
ts
```
ts
let
promise
=
pref
.
getAll
()
let
promise
=
pref
erences
.
getAll
()
promise
.
then
((
value
)
=>
{
promise
.
then
((
value
)
=>
{
let
keys
=
Object
.
keys
(
value
)
let
keys
=
Object
.
keys
(
value
)
console
.
info
(
'
getAll keys =
'
+
keys
)
console
.
info
(
'
getAll keys =
'
+
keys
)
...
@@ -331,7 +331,7 @@ put(key: string, value: ValueType, callback: AsyncCallback<void>): void
...
@@ -331,7 +331,7 @@ put(key: string, value: ValueType, callback: AsyncCallback<void>): void
**示例:**
**示例:**
```
ts
```
ts
pref
.
put
(
'
startup
'
,
'
auto
'
,
function
(
err
)
{
pref
erences
.
put
(
'
startup
'
,
'
auto
'
,
function
(
err
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Put value of startup failed, err:
"
+
err
)
console
.
info
(
"
Put value of startup failed, err:
"
+
err
)
return
return
...
@@ -362,7 +362,7 @@ put(key: string, value: ValueType): Promise<void>
...
@@ -362,7 +362,7 @@ put(key: string, value: ValueType): Promise<void>
**示例:**
**示例:**
```
ts
```
ts
let
promise
=
pref
.
put
(
'
startup
'
,
'
auto
'
)
let
promise
=
pref
erences
.
put
(
'
startup
'
,
'
auto
'
)
promise
.
then
(()
=>
{
promise
.
then
(()
=>
{
console
.
info
(
"
Put value of startup successfully.
"
)
console
.
info
(
"
Put value of startup successfully.
"
)
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
...
@@ -387,7 +387,7 @@ has(key: string, callback: AsyncCallback<boolean>): void
...
@@ -387,7 +387,7 @@ has(key: string, callback: AsyncCallback<boolean>): void
**示例:**
**示例:**
```
ts
```
ts
pref
.
has
(
'
startup
'
,
function
(
err
,
isExist
)
{
pref
erences
.
has
(
'
startup
'
,
function
(
err
,
isExist
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Check the key of startup failed, err:
"
+
err
)
console
.
info
(
"
Check the key of startup failed, err:
"
+
err
)
return
return
...
@@ -421,7 +421,7 @@ has(key: string): Promise<boolean>
...
@@ -421,7 +421,7 @@ has(key: string): Promise<boolean>
**示例:**
**示例:**
```
ts
```
ts
let
promise
=
pref
.
has
(
'
startup
'
)
let
promise
=
pref
erences
.
has
(
'
startup
'
)
promise
.
then
((
isExist
)
=>
{
promise
.
then
((
isExist
)
=>
{
if
(
isExist
)
{
if
(
isExist
)
{
console
.
info
(
"
The key of startup is contained.
"
)
console
.
info
(
"
The key of startup is contained.
"
)
...
@@ -450,7 +450,7 @@ delete(key: string, callback: AsyncCallback<void>): void
...
@@ -450,7 +450,7 @@ delete(key: string, callback: AsyncCallback<void>): void
**示例:**
**示例:**
```
ts
```
ts
pref
.
delete
(
'
startup
'
,
function
(
err
)
{
pref
erences
.
delete
(
'
startup
'
,
function
(
err
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Delete startup key failed, err:
"
+
err
)
console
.
info
(
"
Delete startup key failed, err:
"
+
err
)
return
return
...
@@ -480,7 +480,7 @@ delete(key: string): Promise<void>
...
@@ -480,7 +480,7 @@ delete(key: string): Promise<void>
**示例:**
**示例:**
```
ts
```
ts
let
promise
=
pref
.
delete
(
'
startup
'
)
let
promise
=
pref
erences
.
delete
(
'
startup
'
)
promise
.
then
(()
=>
{
promise
.
then
(()
=>
{
console
.
info
(
"
Deleted startup key successfully.
"
)
console
.
info
(
"
Deleted startup key successfully.
"
)
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
...
@@ -504,7 +504,7 @@ flush(callback: AsyncCallback<void>): void
...
@@ -504,7 +504,7 @@ flush(callback: AsyncCallback<void>): void
**示例:**
**示例:**
```
ts
```
ts
pref
.
flush
(
function
(
err
)
{
pref
erences
.
flush
(
function
(
err
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Flush to file failed, err:
"
+
err
)
console
.
info
(
"
Flush to file failed, err:
"
+
err
)
return
return
...
@@ -529,7 +529,7 @@ flush(): Promise<void>
...
@@ -529,7 +529,7 @@ flush(): Promise<void>
**示例:**
**示例:**
```
ts
```
ts
let
promise
=
pref
.
flush
()
let
promise
=
pref
erences
.
flush
()
promise
.
then
(()
=>
{
promise
.
then
(()
=>
{
console
.
info
(
"
Flushed to file successfully.
"
)
console
.
info
(
"
Flushed to file successfully.
"
)
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
...
@@ -553,7 +553,7 @@ clear(callback: AsyncCallback<void>): void
...
@@ -553,7 +553,7 @@ clear(callback: AsyncCallback<void>): void
**示例:**
**示例:**
```
ts
```
ts
pref
.
clear
(
function
(
err
)
{
pref
erences
.
clear
(
function
(
err
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Clear to file failed, err:
"
+
err
)
console
.
info
(
"
Clear to file failed, err:
"
+
err
)
return
return
...
@@ -578,7 +578,7 @@ clear(): Promise<void>
...
@@ -578,7 +578,7 @@ clear(): Promise<void>
**示例:**
**示例:**
```
ts
```
ts
let
promise
=
pref
.
clear
()
let
promise
=
pref
erences
.
clear
()
promise
.
then
(()
=>
{
promise
.
then
(()
=>
{
console
.
info
(
"
Cleared to file successfully.
"
)
console
.
info
(
"
Cleared to file successfully.
"
)
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
...
@@ -607,15 +607,17 @@ var observer = function (key) {
...
@@ -607,15 +607,17 @@ var observer = function (key) {
console
.
info
(
"
The key of
"
+
key
+
"
changed.
"
)
console
.
info
(
"
The key of
"
+
key
+
"
changed.
"
)
}
}
pref
.
on
(
'
change
'
,
observer
)
...
pref
.
put
(
'
startup
'
,
'
auto
'
,
function
(
err
)
{
preferences
.
on
(
'
change
'
,
observer
)
preferences
.
put
(
'
startup
'
,
'
auto
'
,
function
(
err
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Put the value of startup failed, err:
"
+
err
)
console
.
info
(
"
Put the value of startup failed, err:
"
+
err
)
return
return
}
}
console
.
info
(
"
Put the value of startup successfully.
"
)
console
.
info
(
"
Put the value of startup successfully.
"
)
pref
.
flush
(
function
(
err
)
{
pref
erences
.
flush
(
function
(
err
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Flush to file failed, err:
"
+
err
)
console
.
info
(
"
Flush to file failed, err:
"
+
err
)
return
return
...
@@ -646,21 +648,23 @@ var observer = function (key) {
...
@@ -646,21 +648,23 @@ var observer = function (key) {
console
.
info
(
"
The key of
"
+
key
+
"
changed.
"
)
console
.
info
(
"
The key of
"
+
key
+
"
changed.
"
)
}
}
pref
.
on
(
'
change
'
,
observer
)
...
pref
.
put
(
'
startup
'
,
'
auto
'
,
function
(
err
)
{
preferences
.
on
(
'
change
'
,
observer
)
preferences
.
put
(
'
startup
'
,
'
auto
'
,
function
(
err
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Put the value of startup failed, err:
"
+
err
)
console
.
info
(
"
Put the value of startup failed, err:
"
+
err
)
return
return
}
}
console
.
info
(
"
Put the value of startup successfully.
"
)
console
.
info
(
"
Put the value of startup successfully.
"
)
pref
.
flush
(
function
(
err
)
{
pref
erences
.
flush
(
function
(
err
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Flush to file failed, err:
"
+
err
)
console
.
info
(
"
Flush to file failed, err:
"
+
err
)
return
return
}
}
console
.
info
(
"
Flushed to file successfully.
"
)
// observer will be called.
console
.
info
(
"
Flushed to file successfully.
"
)
// observer will be called.
pref
.
off
(
'
change
'
,
observer
)
pref
erences
.
off
(
'
change
'
,
observer
)
})
})
})
})
```
```
...
@@ -671,11 +675,11 @@ pref.put('startup', 'auto', function (err) {
...
@@ -671,11 +675,11 @@ pref.put('startup', 'auto', function (err) {
**系统能力:**
SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:**
SystemCapability.DistributedDataManager.Preferences.Core
| 名称
| 说明
|
| 名称
| 说明
|
| -------------
|
---------------------- |
| -------------
- | --------
---------------------- |
| number
| 表示值类型为数字。
|
| number
| 表示值类型为数字。
|
| string
| 表示值类型为字符。
|
| string
| 表示值类型为字符串。
|
| boolean
| 表示值类型为布尔值。
|
| boolean
| 表示值类型为布尔值。
|
| Array
<number>
| 表示值类型为数字数组。
|
| Array
\<
number> | 表示值类型为数字类型的数组。
|
| Array
<string>
| 表示值类型为字符数组。
|
| Array
\<
boolean> | 表示值类型为布尔类型的数组。
|
| Array
<bool>
| 表示值类型为布尔
数组。 |
| Array
\<
string> | 表示值类型为字符串类型的
数组。 |
zh-cn/application-dev/reference/apis/js-apis-data-storage.md
浏览文件 @
46dc8e2b
...
@@ -13,7 +13,7 @@
...
@@ -13,7 +13,7 @@
## 导入模块
## 导入模块
```
js
```
js
import
data
S
torage
from
'
@ohos.data.storage
'
;
import
data
_s
torage
from
'
@ohos.data.storage
'
;
```
```
## 常量
## 常量
...
@@ -26,7 +26,7 @@ import dataStorage from '@ohos.data.storage';
...
@@ -26,7 +26,7 @@ import dataStorage from '@ohos.data.storage';
| MAX_VALUE_LENGTH | string | 是 | 否 | value的最大长度限制,需小于8192字节。 |
| MAX_VALUE_LENGTH | string | 是 | 否 | value的最大长度限制,需小于8192字节。 |
## data
S
torage.getStorageSync
## data
_s
torage.getStorageSync
getStorageSync(path: string): Storage
getStorageSync(path: string): Storage
...
@@ -46,24 +46,17 @@ getStorageSync(path: string): Storage
...
@@ -46,24 +46,17 @@ getStorageSync(path: string): Storage
**示例:**
**示例:**
```
js
```
js
import
dataStorage
from
'
@ohos.data.storage
'
import
data_storage
from
'
@ohos.data.storage
'
import
featureAbility
from
'
@ohos.ability.featureAbility
'
var
path
=
'
/data/storage/el2/database/test_storage
'
var
path
=
'
/data/storage/el2/database/test_storage
'
context
.
getFilesDir
((
err
,
path
)
=>
{
let
storage
=
data_storage
.
getStorageSync
(
path
+
'
/mystore
'
)
if
(
err
)
{
storage
.
putSync
(
'
startup
'
,
'
auto
'
)
console
.
error
(
'
getFilesDir failed. err:
'
+
JSON
.
stringify
(
err
));
storage
.
flushSync
()
return
;
}
console
.
info
(
'
getFilesDir successful. path:
'
+
JSON
.
stringify
(
path
));
let
storage
=
dataStorage
.
getStorageSync
(
path
+
'
/mystore
'
)
storage
.
putSync
(
'
startup
'
,
'
auto
'
)
storage
.
flushSync
()
});
```
```
## data
S
torage.getStorage
## data
_s
torage.getStorage
getStorage(path: string, callback: AsyncCallback
<
Storage
>
): void
getStorage(path: string, callback: AsyncCallback
<
Storage
>
): void
...
@@ -79,29 +72,21 @@ getStorage(path: string, callback: AsyncCallback<Storage>): void
...
@@ -79,29 +72,21 @@ getStorage(path: string, callback: AsyncCallback<Storage>): void
**示例:**
**示例:**
```
js
```
js
import
dataStorage
from
'
@ohos.data.storage
'
import
data_storage
from
'
@ohos.data.storage
'
import
featureAbility
from
'
@ohos.ability.featureAbility
'
var
path
=
'
/data/storage/el2/database/test_storage
'
var
path
=
'
/data/storage/el2/database/test_storage
'
context
.
getFilesDir
((
err
,
path
)
=>
{
data_storage
.
getStorage
(
path
+
'
/mystore
'
,
function
(
err
,
storage
)
{
if
(
err
)
{
if
(
err
)
{
console
.
error
(
'
getFilesDir failed. err:
'
+
JSON
.
stringify
(
err
));
console
.
info
(
"
Get the storage failed, path:
"
+
path
+
'
/mystore
'
)
return
;
return
;
}
}
console
.
info
(
'
getFilesDir successful. path:
'
+
JSON
.
stringify
(
path
));
storage
.
putSync
(
'
startup
'
,
'
auto
'
)
dataStorage
.
getStorage
(
path
+
'
/mystore
'
,
function
(
err
,
storage
)
{
storage
.
flushSync
()
if
(
err
)
{
})
console
.
info
(
"
Get the storage failed, path:
"
+
path
+
'
/mystore
'
)
return
;
}
storage
.
putSync
(
'
startup
'
,
'
auto
'
)
storage
.
flushSync
()
})
});
```
```
## data
S
torage.getStorage
## data
_s
torage.getStorage
getStorage(path: string): Promise
<
Storage
>
getStorage(path: string): Promise
<
Storage
>
...
@@ -121,28 +106,21 @@ getStorage(path: string): Promise<Storage>
...
@@ -121,28 +106,21 @@ getStorage(path: string): Promise<Storage>
**示例:**
**示例:**
```
js
```
js
import
dataStorage
from
'
@ohos.data.storage
'
import
data_storage
from
'
@ohos.data.storage
'
import
featureAbility
from
'
@ohos.ability.featureAbility
'
var
path
=
'
/data/storage/el2/database/test_storage
'
var
path
=
'
/data/storage/el2/database/test_storage
'
context
.
getFilesDir
((
err
,
path
)
=>
{
if
(
err
)
{
let
getPromise
=
data_storage
.
getStorage
(
path
+
'
/mystore
'
)
console
.
info
(
"
Get the storage failed, path:
"
+
path
+
'
/mystore
'
)
getPromise
.
then
((
storage
)
=>
{
return
;
storage
.
putSync
(
'
startup
'
,
'
auto
'
)
}
storage
.
flushSync
()
console
.
info
(
'
getFilesDir successful. path:
'
+
JSON
.
stringify
(
path
));
}).
catch
((
err
)
=>
{
let
promisegetSt
=
dataStorage
.
getStorage
(
path
+
'
/mystore
'
)
console
.
info
(
"
Get the storage failed, path:
"
+
path
+
'
/mystore
'
)
promisegetSt
.
then
((
storage
)
=>
{
})
storage
.
putSync
(
'
startup
'
,
'
auto
'
)
storage
.
flushSync
()
}).
catch
((
err
)
=>
{
console
.
info
(
"
Get the storage failed, path:
"
+
path
+
'
/mystore
'
)
})
});
```
```
## data
S
torage.deleteStorageSync
## data
_s
torage.deleteStorageSync
deleteStorageSync(path: string): void
deleteStorageSync(path: string): void
...
@@ -157,11 +135,11 @@ deleteStorageSync(path: string): void
...
@@ -157,11 +135,11 @@ deleteStorageSync(path: string): void
**示例:**
**示例:**
```
js
```
js
data
S
torage
.
deleteStorageSync
(
path
+
'
/mystore
'
)
data
_s
torage
.
deleteStorageSync
(
path
+
'
/mystore
'
)
```
```
## data
S
torage.deleteStorage
## data
_s
torage.deleteStorage
deleteStorage(path: string, callback: AsyncCallback
<
void
>
): void
deleteStorage(path: string, callback: AsyncCallback
<
void
>
): void
...
@@ -177,7 +155,7 @@ deleteStorage(path: string, callback: AsyncCallback<void>): void
...
@@ -177,7 +155,7 @@ deleteStorage(path: string, callback: AsyncCallback<void>): void
**示例:**
**示例:**
```
js
```
js
data
S
torage
.
deleteStorage
(
path
+
'
/mystore
'
,
function
(
err
)
{
data
_s
torage
.
deleteStorage
(
path
+
'
/mystore
'
,
function
(
err
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Deleted failed with err:
"
+
err
)
console
.
info
(
"
Deleted failed with err:
"
+
err
)
return
return
...
@@ -187,7 +165,7 @@ deleteStorage(path: string, callback: AsyncCallback<void>): void
...
@@ -187,7 +165,7 @@ deleteStorage(path: string, callback: AsyncCallback<void>): void
```
```
## data
S
torage.deleteStorage
## data
_s
torage.deleteStorage
deleteStorage(path: string): Promise
<
void
>
deleteStorage(path: string): Promise
<
void
>
...
@@ -207,7 +185,7 @@ deleteStorage(path: string): Promise<void>
...
@@ -207,7 +185,7 @@ deleteStorage(path: string): Promise<void>
**示例:**
**示例:**
```
js
```
js
let
promisedelSt
=
data
S
torage
.
deleteStorage
(
path
+
'
/mystore
'
)
let
promisedelSt
=
data
_s
torage
.
deleteStorage
(
path
+
'
/mystore
'
)
promisedelSt
.
then
(()
=>
{
promisedelSt
.
then
(()
=>
{
console
.
info
(
"
Deleted successfully.
"
)
console
.
info
(
"
Deleted successfully.
"
)
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
...
@@ -216,7 +194,7 @@ deleteStorage(path: string): Promise<void>
...
@@ -216,7 +194,7 @@ deleteStorage(path: string): Promise<void>
```
```
## data
S
torage.removeStorageFromCacheSync
## data
_s
torage.removeStorageFromCacheSync
removeStorageFromCacheSync(path: string): void
removeStorageFromCacheSync(path: string): void
...
@@ -231,11 +209,11 @@ removeStorageFromCacheSync(path: string): void
...
@@ -231,11 +209,11 @@ removeStorageFromCacheSync(path: string): void
**示例:**
**示例:**
```
js
```
js
data
S
torage
.
removeStorageFromCacheSync
(
path
+
'
/mystore
'
)
data
_s
torage
.
removeStorageFromCacheSync
(
path
+
'
/mystore
'
)
```
```
## data
S
torage.removeStorageFromCache
## data
_s
torage.removeStorageFromCache
removeStorageFromCache(path: string, callback: AsyncCallback
<
void
>
): void
removeStorageFromCache(path: string, callback: AsyncCallback
<
void
>
): void
...
@@ -251,7 +229,7 @@ removeStorageFromCache(path: string, callback: AsyncCallback<void>): void
...
@@ -251,7 +229,7 @@ removeStorageFromCache(path: string, callback: AsyncCallback<void>): void
**示例:**
**示例:**
```
js
```
js
data
S
torage
.
removeStorageFromCache
(
path
+
'
/mystore
'
,
function
(
err
)
{
data
_s
torage
.
removeStorageFromCache
(
path
+
'
/mystore
'
,
function
(
err
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Removed storage from cache failed with err:
"
+
err
)
console
.
info
(
"
Removed storage from cache failed with err:
"
+
err
)
return
return
...
@@ -261,7 +239,7 @@ removeStorageFromCache(path: string, callback: AsyncCallback<void>): void
...
@@ -261,7 +239,7 @@ removeStorageFromCache(path: string, callback: AsyncCallback<void>): void
```
```
## data
S
torage.removeStorageFromCache
## data
_s
torage.removeStorageFromCache
removeStorageFromCache(path: string): Promise
<
void
>
removeStorageFromCache(path: string): Promise
<
void
>
...
@@ -281,7 +259,7 @@ removeStorageFromCache(path: string): Promise<void>
...
@@ -281,7 +259,7 @@ removeStorageFromCache(path: string): Promise<void>
**示例:**
**示例:**
```
js
```
js
let
promiserevSt
=
data
S
torage
.
removeStorageFromCache
(
path
+
'
/mystore
'
)
let
promiserevSt
=
data
_s
torage
.
removeStorageFromCache
(
path
+
'
/mystore
'
)
promiserevSt
.
then
(()
=>
{
promiserevSt
.
then
(()
=>
{
console
.
info
(
"
Removed storage from cache successfully.
"
)
console
.
info
(
"
Removed storage from cache successfully.
"
)
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录