Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
6f7f8f08
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
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看板
提交
6f7f8f08
编写于
10月 20, 2022
作者:
D
duanweiling
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
首选项错误码文档
Signed-off-by:
N
duanweiling
<
duanweiling@huawei.com
>
上级
b9c90d02
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
392 addition
and
237 deletion
+392
-237
zh-cn/application-dev/reference/apis/js-apis-data-preferences.md
...pplication-dev/reference/apis/js-apis-data-preferences.md
+378
-237
zh-cn/application-dev/reference/errorcodes/errorcode-preferences.md
...ication-dev/reference/errorcodes/errorcode-preferences.md
+14
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-data-preferences.md
浏览文件 @
6f7f8f08
...
@@ -52,14 +52,19 @@ import featureAbility from '@ohos.ability.featureAbility';
...
@@ -52,14 +52,19 @@ import featureAbility from '@ohos.ability.featureAbility';
let
context
=
featureAbility
.
getContext
();
let
context
=
featureAbility
.
getContext
();
let
preferences
=
null
;
let
preferences
=
null
;
data_preferences
.
getPreferences
(
context
,
'
mystore
'
,
function
(
err
,
object
)
{
try
{
if
(
err
)
{
mPreference
.
getPreferences
(
context
,
123
,
function
(
err
,
val
)
{
console
.
info
(
"
Failed to get preferences. Cause:
"
+
err
);
if
(
err
)
{
return
;
console
.
log
(
"
get err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
}
expect
(
false
).
assertTrue
()
preferences
=
object
;
}
console
.
info
(
"
Succeeded in getting preferences.
"
);
expect
(
true
).
assertEqual
(
val
)
})
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
done
()
console
.
log
(
"
testPreferencesCallback0000 end.
"
)
}
```
```
Stage模型示例:
Stage模型示例:
...
@@ -75,14 +80,19 @@ class MainAbility extends Ability{
...
@@ -75,14 +80,19 @@ class MainAbility extends Ability{
}
}
let
preferences
=
null
;
let
preferences
=
null
;
data_preferences
.
getPreferences
(
context
,
'
mystore
'
,
function
(
err
,
object
)
{
try
{
if
(
err
)
{
mPreference
.
getPreferences
(
context
,
123
,
function
(
err
,
val
)
{
console
.
info
(
"
Failed to get preferences. Cause:
"
+
err
);
if
(
err
)
{
return
;
console
.
log
(
"
get err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
}
expect
(
false
).
assertTrue
()
preferences
=
object
;
}
console
.
info
(
"
Succeeded in getting preferences.
"
);
expect
(
true
).
assertEqual
(
val
)
})
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
done
()
console
.
log
(
"
testPreferencesCallback0000 end.
"
)
}
```
```
## data_preferences.getPreferences
## data_preferences.getPreferences
...
@@ -115,14 +125,19 @@ FA模型示例:
...
@@ -115,14 +125,19 @@ FA模型示例:
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
let
context
=
featureAbility
.
getContext
();
let
context
=
featureAbility
.
getContext
();
let
preferences
=
null
;
try
{
let
promise
=
data_preferences
.
getPreferences
(
context
,
'
mystore
'
);
mPreference
.
getPreferences
(
context
,
1233
).
then
((
ret
)
=>
{
promise
.
then
((
object
)
=>
{
console
.
log
(
"
get err
"
)
preferences
=
object
;
expect
(
false
).
assertTrue
()
console
.
info
(
"
Succeeded in getting preferences.
"
);
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
console
.
log
(
"
get err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
console
.
info
(
"
Failed to get preferences. Cause:
"
+
err
);
expect
(
false
).
assertTrue
()
})
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
done
()
console
.
log
(
"
testPreferencesPromise0000 end.
"
)
}
```
```
Stage模型示例:
Stage模型示例:
...
@@ -137,14 +152,19 @@ class MainAbility extends Ability{
...
@@ -137,14 +152,19 @@ class MainAbility extends Ability{
}
}
}
}
let
preferences
=
null
;
try
{
let
promise
=
data_preferences
.
getPreferences
(
context
,
'
mystore
'
);
mPreference
.
getPreferences
(
context
,
1233
).
then
((
ret
)
=>
{
promise
.
then
((
object
)
=>
{
console
.
log
(
"
get err
"
)
preferences
=
object
;
expect
(
false
).
assertTrue
()
console
.
info
(
"
Succeeded in getting preferences.
"
);
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
console
.
log
(
"
get err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
console
.
info
(
"
Failed to get preferences. Cause:
"
+
err
);
expect
(
false
).
assertTrue
()
})
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
done
()
console
.
log
(
"
testPreferencesPromise0000 end.
"
)
}
```
```
## data_preferences.deletePreferences
## data_preferences.deletePreferences
...
@@ -167,6 +187,14 @@ deletePreferences(context: Context, name: string, callback: AsyncCallback<voi
...
@@ -167,6 +187,14 @@ deletePreferences(context: Context, name: string, callback: AsyncCallback<voi
| name | string | 是 | Preferences实例的名称。 |
| name | string | 是 | Preferences实例的名称。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。当移除成功,err为undefined,否则为错误码。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。当移除成功,err为undefined,否则为错误码。 |
**错误码:**
以下错误码的详细介绍请参见
[
首选项错误码
](
../errorcodes/errorcode-preferences.md
)
。
| 错误码ID | 错误信息 |
| -------- | ------------------------------|
| 15500010 | Failed to delete preferences. |
**示例:**
**示例:**
FA模型示例:
FA模型示例:
...
@@ -176,13 +204,19 @@ FA模型示例:
...
@@ -176,13 +204,19 @@ FA模型示例:
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
let
context
=
featureAbility
.
getContext
();
let
context
=
featureAbility
.
getContext
();
data_preferences
.
deletePreferences
(
context
,
'
mystore
'
,
function
(
err
)
{
try
{
if
(
err
)
{
mPreference
.
deletePreferences
(
context
,
123
,
function
(
err
,
val
)
{
console
.
info
(
"
Failed to delete preferences. Cause:
"
+
err
);
if
(
err
)
{
return
;
console
.
log
(
"
get err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
}
expect
(
false
).
assertTrue
()
console
.
info
(
"
Succeeded in deleting preferences.
"
);
}
})
expect
(
true
).
assertEqual
(
val
)
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
done
()
console
.
log
(
"
testPreferencesCallback0001 end.
"
)
}
```
```
Stage模型示例:
Stage模型示例:
...
@@ -197,13 +231,19 @@ class MainAbility extends Ability{
...
@@ -197,13 +231,19 @@ class MainAbility extends Ability{
}
}
}
}
data_preferences
.
deletePreferences
(
context
,
'
mystore
'
,
function
(
err
)
{
try
{
if
(
err
)
{
mPreference
.
deletePreferences
(
context
,
123
,
function
(
err
,
val
)
{
console
.
info
(
"
Failed to delete preferences. Cause:
"
+
err
);
if
(
err
)
{
return
;
console
.
log
(
"
get err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
}
expect
(
false
).
assertTrue
()
console
.
info
(
"
Succeeded in deleting preferences.
"
);
}
})
expect
(
true
).
assertEqual
(
val
)
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
done
()
console
.
log
(
"
testPreferencesCallback0001 end.
"
)
}
```
```
## data_preferences.deletePreferences
## data_preferences.deletePreferences
...
@@ -225,6 +265,14 @@ deletePreferences(context: Context, name: string): Promise<void>
...
@@ -225,6 +265,14 @@ deletePreferences(context: Context, name: string): Promise<void>
| context | Context | 是 | 应用上下文。
<br>
FA模型的应用Context定义见
[
Context
](
js-apis-Context.md
)
。
<br>
Stage模型的应用Context定义见
[
Context
](
js-apis-ability-context.md
)
。 |
| context | Context | 是 | 应用上下文。
<br>
FA模型的应用Context定义见
[
Context
](
js-apis-Context.md
)
。
<br>
Stage模型的应用Context定义见
[
Context
](
js-apis-ability-context.md
)
。 |
| name | string | 是 | Preferences实例的名称。 |
| name | string | 是 | Preferences实例的名称。 |
**错误码:**
以下错误码的详细介绍请参见
[
首选项错误码
](
../errorcodes/errorcode-preferences.md
)
。
| 错误码ID | 错误信息 |
| -------- | ------------------------------|
| 15500010 | Failed to delete preferences. |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
...
@@ -240,12 +288,19 @@ FA模型示例:
...
@@ -240,12 +288,19 @@ FA模型示例:
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
let
context
=
featureAbility
.
getContext
();
let
context
=
featureAbility
.
getContext
();
let
promise
=
data_preferences
.
deletePreferences
(
context
,
'
mystore
'
);
try
{
promise
.
then
(()
=>
{
mPreference
.
deletePreferences
(
context
,
1233
).
then
((
ret
)
=>
{
console
.
info
(
"
Succeeded in deleting preferences.
"
);
console
.
log
(
"
get err
"
)
}).
catch
((
err
)
=>
{
expect
(
false
).
assertTrue
()
console
.
info
(
"
Failed to delete preferences. Cause:
"
+
err
);
}).
catch
((
err
)
=>
{
})
console
.
log
(
"
get err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
done
()
console
.
log
(
"
testPreferencesPromise0001 end.
"
)
}
```
```
Stage模型示例:
Stage模型示例:
...
@@ -260,12 +315,19 @@ class MainAbility extends Ability{
...
@@ -260,12 +315,19 @@ class MainAbility extends Ability{
}
}
}
}
let
promise
=
data_preferences
.
deletePreferences
(
context
,
'
mystore
'
);
try
{
promise
.
then
(()
=>
{
mPreference
.
deletePreferences
(
context
,
1233
).
then
((
ret
)
=>
{
console
.
info
(
"
Succeeded in deleting preferences.
"
);
console
.
log
(
"
get err
"
)
}).
catch
((
err
)
=>
{
expect
(
false
).
assertTrue
()
console
.
info
(
"
Failed to delete preferences. Cause:
"
+
err
);
}).
catch
((
err
)
=>
{
})
console
.
log
(
"
get err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
done
()
console
.
log
(
"
testPreferencesPromise0001 end.
"
)
}
```
```
## data_preferences.removePreferencesFromCache
## data_preferences.removePreferencesFromCache
...
@@ -295,13 +357,19 @@ FA模型示例:
...
@@ -295,13 +357,19 @@ FA模型示例:
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
let
context
=
featureAbility
.
getContext
();
let
context
=
featureAbility
.
getContext
();
data_preferences
.
removePreferencesFromCache
(
context
,
'
mystore
'
,
function
(
err
)
{
try
{
if
(
err
)
{
mPreference
.
removePreferencesFromCache
(
context
,
123
,
function
(
err
,
val
)
{
console
.
info
(
"
Failed to remove preferences. Cause:
"
+
err
);
if
(
err
)
{
return
;
console
.
log
(
"
get err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
}
expect
(
false
).
assertTrue
()
console
.
info
(
"
Succeeded in removing preferences.
"
);
}
})
expect
(
true
).
assertEqual
(
val
)
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
done
()
console
.
log
(
"
testPreferencesCallback0002 end.
"
)
}
```
```
Stage模型示例:
Stage模型示例:
...
@@ -316,13 +384,19 @@ class MainAbility extends Ability{
...
@@ -316,13 +384,19 @@ class MainAbility extends Ability{
}
}
}
}
data_preferences
.
removePreferencesFromCache
(
context
,
'
mystore
'
,
function
(
err
)
{
try
{
if
(
err
)
{
mPreference
.
removePreferencesFromCache
(
context
,
123
,
function
(
err
,
val
)
{
console
.
info
(
"
Failed to remove preferences. Cause:
"
+
err
);
if
(
err
)
{
return
;
console
.
log
(
"
get err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
}
expect
(
false
).
assertTrue
()
console
.
info
(
"
Succeeded in removing preferences.
"
);
}
})
expect
(
true
).
assertEqual
(
val
)
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
done
()
console
.
log
(
"
testPreferencesCallback0002 end.
"
)
}
```
```
## data_preferences.removePreferencesFromCache
## data_preferences.removePreferencesFromCache
...
@@ -357,12 +431,19 @@ FA模型示例:
...
@@ -357,12 +431,19 @@ FA模型示例:
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
let
context
=
featureAbility
.
getContext
();
let
context
=
featureAbility
.
getContext
();
let
promise
=
data_preferences
.
removePreferencesFromCache
(
context
,
'
mystore
'
);
try
{
promise
.
then
(()
=>
{
mPreference
.
removePreferencesFromCache
(
context
,
1233
).
then
((
ret
)
=>
{
console
.
info
(
"
Succeeded in removing preferences.
"
);
console
.
log
(
"
get err
"
)
}).
catch
((
err
)
=>
{
expect
(
false
).
assertTrue
()
console
.
info
(
"
Failed to remove preferences. Cause:
"
+
err
);
}).
catch
((
err
)
=>
{
})
console
.
log
(
"
get err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
done
()
console
.
log
(
"
testPreferencesPromise0002 end.
"
)
}
```
```
Stage模型示例:
Stage模型示例:
...
@@ -377,12 +458,19 @@ class MainAbility extends Ability{
...
@@ -377,12 +458,19 @@ class MainAbility extends Ability{
}
}
}
}
let
promise
=
data_preferences
.
removePreferencesFromCache
(
context
,
'
mystore
'
);
try
{
promise
.
then
(()
=>
{
mPreference
.
removePreferencesFromCache
(
context
,
1233
).
then
((
ret
)
=>
{
console
.
info
(
"
Succeeded in removing preferences.
"
);
console
.
log
(
"
get err
"
)
}).
catch
((
err
)
=>
{
expect
(
false
).
assertTrue
()
console
.
info
(
"
Failed to remove preferences. Cause:
"
+
err
);
}).
catch
((
err
)
=>
{
})
console
.
log
(
"
get err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
done
()
console
.
log
(
"
testPreferencesPromise0002 end.
"
)
}
```
```
## Preferences
## Preferences
...
@@ -411,13 +499,19 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>):
...
@@ -411,13 +499,19 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>):
**示例:**
**示例:**
```
js
```
js
preferences
.
get
(
'
startup
'
,
'
default
'
,
function
(
err
,
data
)
{
try
{
if
(
err
)
{
mPreference
.
get
(
123
,
function
(
err
,
val
)
{
console
.
info
(
"
Failed to get value of 'startup'. Cause:
"
+
err
);
if
(
err
)
{
return
;
console
.
log
(
"
get err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
}
expect
(
false
).
assertTrue
()
console
.
info
(
"
Succeeded in getting value of 'startup'. Data:
"
+
data
);
}
})
expect
(
true
).
assertEqual
(
val
)
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
done
()
console
.
log
(
"
testPreferencesCallback002 end.
"
)
}
```
```
...
@@ -445,12 +539,19 @@ get(key: string, defValue: ValueType): Promise<ValueType>
...
@@ -445,12 +539,19 @@ get(key: string, defValue: ValueType): Promise<ValueType>
**示例:**
**示例:**
```
js
```
js
let
promise
=
preferences
.
get
(
'
startup
'
,
'
default
'
);
try
{
promise
.
then
((
data
)
=>
{
mPreference
.
get
(
KEY_TEST_STRING_ELEMENT
,
KEY_TEST_INT_ELEMENT
).
then
((
ret
)
=>
{
console
.
info
(
"
Succeeded in getting value of 'startup'. Data:
"
+
data
);
expect
(
'
123
'
).
assertEqual
(
ret
)
}).
catch
((
err
)
=>
{
done
()
console
.
info
(
"
Failed to get value of 'startup'. Cause:
"
+
err
);
console
.
log
(
"
testPreferencesPromise003 end.
"
)
})
}).
catch
((
err
)
=>
{
console
.
log
(
"
get err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
}
```
```
### getAll
### getAll
...
@@ -470,15 +571,20 @@ getAll(callback: AsyncCallback<Object>): void;
...
@@ -470,15 +571,20 @@ getAll(callback: AsyncCallback<Object>): void;
**示例:**
**示例:**
```
js
```
js
preferences
.
getAll
(
function
(
err
,
value
)
{
try
{
if
(
err
)
{
mPreference
.
getAll
(
function
(
err
,
val
)
{
console
.
info
(
"
Failed to get all key-values. Cause:
"
+
err
);
if
(
err
)
{
return
;
console
.
log
(
"
getAll err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
}
expect
(
false
).
assertTrue
()
let
allKeys
=
Object
.
keys
(
value
);
}
console
.
info
(
"
getAll keys =
"
+
allKeys
);
console
.
log
(
"
getAll val =
"
+
JSON
.
stringify
(
val
))
console
.
info
(
"
getAll object =
"
+
JSON
.
stringify
(
value
));
done
()
});
console
.
log
(
"
testPreferencesCallback004 end.
"
)
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
}
```
```
...
@@ -499,14 +605,18 @@ getAll(): Promise<Object>
...
@@ -499,14 +605,18 @@ getAll(): Promise<Object>
**示例:**
**示例:**
```
js
```
js
let
promise
=
preferences
.
getAll
();
try
{
promise
.
then
((
value
)
=>
{
mPreference
.
getAll
().
then
((
ret
)
=>
{
let
allKeys
=
Object
.
keys
(
value
);
done
()
console
.
info
(
'
getAll keys =
'
+
allKeys
);
console
.
log
(
"
testPreferencesPromise004 end.
"
)
console
.
info
(
"
getAll object =
"
+
JSON
.
stringify
(
value
));
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
console
.
log
(
"
getAll err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
console
.
info
(
"
Failed to get all key-values. Cause:
"
+
err
);
expect
(
false
).
assertTrue
()
})
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
}
```
```
### put
### put
...
@@ -528,13 +638,20 @@ put(key: string, value: ValueType, callback: AsyncCallback<void>): void
...
@@ -528,13 +638,20 @@ put(key: string, value: ValueType, callback: AsyncCallback<void>): void
**示例:**
**示例:**
```
js
```
js
preferences
.
put
(
'
startup
'
,
'
auto
'
,
function
(
err
)
{
try
{
if
(
err
)
{
mPreference
.
put
(
KEY_TEST_STRING_ELEMENT
,
KEY_TEST_INT_ELEMENT
,
function
(
err
)
{
console
.
info
(
"
Failed to put value of 'startup'. Cause:
"
+
err
);
if
(
err
)
{
return
;
console
.
log
(
"
put err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
}
expect
(
false
).
assertTrue
()
console
.
info
(
"
Succeeded in putting value of 'startup'.
"
);
}
})
done
()
console
.
log
(
"
testPreferencesCallback008 end.
"
)
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
}
```
```
...
@@ -562,12 +679,18 @@ put(key: string, value: ValueType): Promise<void>
...
@@ -562,12 +679,18 @@ put(key: string, value: ValueType): Promise<void>
**示例:**
**示例:**
```
js
```
js
let
promise
=
preferences
.
put
(
'
startup
'
,
'
auto
'
);
try
{
promise
.
then
(()
=>
{
mPreference
.
put
(
KEY_TEST_STRING_ELEMENT
,
KEY_TEST_INT_ELEMENT
).
then
(()
=>
{
console
.
info
(
"
Succeeded in putting value of 'startup'.
"
);
done
()
}).
catch
((
err
)
=>
{
console
.
log
(
"
testPreferencesPromise008 end.
"
)
console
.
info
(
"
Failed to put value of 'startup'. Cause:
"
+
err
);
}).
catch
((
err
)
=>
{
})
console
.
log
(
"
put err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
}
```
```
...
@@ -589,17 +712,20 @@ has(key: string, callback: AsyncCallback<boolean>): void
...
@@ -589,17 +712,20 @@ has(key: string, callback: AsyncCallback<boolean>): void
**示例:**
**示例:**
```
js
```
js
preferences
.
has
(
'
startup
'
,
function
(
err
,
isExist
)
{
try
{
if
(
err
)
{
mPreference
.
has
(
KEY_TEST_STRING_ELEMENT
,
function
(
err
,
val
)
{
console
.
info
(
"
Failed to check the key 'startup'. Cause:
"
+
err
);
if
(
err
)
{
return
;
console
.
log
(
"
has err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
}
expect
(
false
).
assertTrue
()
if
(
isExist
)
{
}
console
.
info
(
"
The key 'startup' is contained.
"
);
expect
(
true
).
assertEqual
(
val
)
}
else
{
done
()
console
.
info
(
"
The key 'startup' dose not contain.
"
);
console
.
log
(
"
testPreferencesCallback006 end.
"
)
}
})
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
}
```
```
...
@@ -626,16 +752,18 @@ has(key: string): Promise<boolean>
...
@@ -626,16 +752,18 @@ has(key: string): Promise<boolean>
**示例:**
**示例:**
```
js
```
js
let
promise
=
preferences
.
has
(
'
startup
'
);
try
{
promise
.
then
((
isExist
)
=>
{
mPreference
.
has
(
KEY_TEST_STRING_ELEMENT
).
then
((
val
)
=>
{
if
(
isExist
)
{
done
()
console
.
info
(
"
The key 'startup' is contained.
"
);
console
.
log
(
"
testPreferencesPromise006 end.
"
)
}
else
{
}).
catch
((
err
)
=>
{
console
.
info
(
"
The key 'startup' dose not contain.
"
);
console
.
log
(
"
has err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
}
expect
(
false
).
assertTrue
()
}).
catch
((
err
)
=>
{
})
console
.
info
(
"
Failed to check the key 'startup'. Cause:
"
+
err
);
}
catch
(
err
)
{
})
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
}
```
```
...
@@ -657,13 +785,19 @@ delete(key: string, callback: AsyncCallback<void>): void
...
@@ -657,13 +785,19 @@ delete(key: string, callback: AsyncCallback<void>): void
**示例:**
**示例:**
```
js
```
js
preferences
.
delete
(
'
startup
'
,
function
(
err
)
{
try
{
if
(
err
)
{
mPreference
.
delete
(
KEY_TEST_STRING_ELEMENT
,
function
(
err
)
{
console
.
info
(
"
Failed to delete the key 'startup'. Cause:
"
+
err
);
if
(
err
)
{
return
;
console
.
log
(
"
delete err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
}
expect
(
false
).
assertTrue
()
console
.
info
(
"
Succeeded in deleting the key 'startup'.
"
);
}
})
done
()
console
.
log
(
"
testPreferencesCallback010 end.
"
)
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
}
```
```
...
@@ -690,12 +824,18 @@ delete(key: string): Promise<void>
...
@@ -690,12 +824,18 @@ delete(key: string): Promise<void>
**示例:**
**示例:**
```
js
```
js
let
promise
=
preferences
.
delete
(
'
startup
'
);
try
{
promise
.
then
(()
=>
{
mPreference
.
delete
(
KEY_TEST_STRING_ELEMENT
).
then
(()
=>
{
console
.
info
(
"
Succeeded in deleting the key 'startup'.
"
);
done
()
}).
catch
((
err
)
=>
{
console
.
log
(
"
testPreferencesPromise005 end.
"
)
console
.
info
(
"
Failed to delete the key 'startup'. Cause:
"
+
err
);
}).
catch
((
err
)
=>
{
})
console
.
log
(
"
delete err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
}
```
```
...
@@ -716,13 +856,19 @@ flush(callback: AsyncCallback<void>): void
...
@@ -716,13 +856,19 @@ flush(callback: AsyncCallback<void>): void
**示例:**
**示例:**
```
js
```
js
preferences
.
flush
(
function
(
err
)
{
try
{
if
(
err
)
{
mPreference
.
flush
(
function
(
err
)
{
console
.
info
(
"
Failed to flush. Cause:
"
+
err
);
if
(
err
)
{
return
;
console
.
log
(
"
flush err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
}
expect
(
false
).
assertTrue
()
console
.
info
(
"
Succeeded in flushing.
"
);
}
})
done
()
console
.
log
(
"
testPreferencesCallback012 end.
"
)
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
}
```
```
...
@@ -743,12 +889,18 @@ flush(): Promise<void>
...
@@ -743,12 +889,18 @@ flush(): Promise<void>
**示例:**
**示例:**
```
js
```
js
let
promise
=
preferences
.
flush
();
try
{
promise
.
then
(()
=>
{
mPreference
.
flush
().
then
(()
=>
{
console
.
info
(
"
Succeeded in flushing.
"
);
done
()
}).
catch
((
err
)
=>
{
console
.
log
(
"
testPreferencesPromise012 end.
"
)
console
.
info
(
"
Failed to flush. Cause:
"
+
err
);
}).
catch
((
err
)
=>
{
})
console
.
log
(
"
flush err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
}
```
```
...
@@ -769,13 +921,19 @@ clear(callback: AsyncCallback<void>): void
...
@@ -769,13 +921,19 @@ clear(callback: AsyncCallback<void>): void
**示例:**
**示例:**
```
js
```
js
preferences
.
clear
(
function
(
err
)
{
try
{
if
(
err
)
{
mPreference
.
clear
(
function
(
err
)
{
console
.
info
(
"
Failed to clear. Cause:
"
+
err
);
if
(
err
)
{
return
;
console
.
log
(
"
clear err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
}
expect
(
false
).
assertTrue
()
console
.
info
(
"
Succeeded in clearing.
"
);
}
})
done
()
console
.
log
(
"
testPreferencesCallback011 end.
"
)
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
}
```
```
...
@@ -796,12 +954,18 @@ clear(): Promise<void>
...
@@ -796,12 +954,18 @@ clear(): Promise<void>
**示例:**
**示例:**
```
js
```
js
let
promise
=
preferences
.
clear
()
try
{
promise
.
then
(()
=>
{
mPreference
.
clear
().
then
(()
=>
{
console
.
info
(
"
Succeeded in clearing.
"
);
done
()
}).
catch
((
err
)
=>
{
console
.
log
(
"
testPreferencesPromise011 end.
"
)
console
.
info
(
"
Failed to clear. Cause:
"
+
err
);
}).
catch
((
err
)
=>
{
})
console
.
log
(
"
clear err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
})
}
catch
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
expect
(
false
).
assertTrue
()
}
```
```
...
@@ -823,31 +987,21 @@ on(type: 'change', callback: Callback<{ key : string }>): void
...
@@ -823,31 +987,21 @@ on(type: 'change', callback: Callback<{ key : string }>): void
**示例:**
**示例:**
```
js
```
js
data_preferences
.
getPreferences
(
this
.
context
,
'
mystore
'
,
function
(
err
,
preferences
)
{
try
{
if
(
err
)
{
mPreference
.
clear
();
console
.
info
(
"
Failed to get preferences.
"
);
var
observer
=
function
(
key
)
{
return
;
if
(
key
)
{
}
console
.
info
(
'
testPreferencesCallback013 key
'
+
key
);
let
observer
=
function
(
key
)
{
expect
(
false
).
assertTrue
()
console
.
info
(
"
The key
"
+
key
+
"
changed.
"
);
}
preferences
.
on
(
'
change
'
,
observer
);
preferences
.
put
(
'
startup
'
,
'
manual
'
,
function
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Failed to put the value of 'startup'. Cause:
"
+
err
);
return
;
}
}
console
.
info
(
"
Succeeded in putting the value of 'startup'.
"
);
expect
(
"
abcd
"
).
assertEqual
(
key
);
};
preferences
.
flush
(
function
(
err
)
{
await
mPreference
.
on
(
'
change
'
,
observer
);
if
(
err
)
{
await
mPreference
.
put
(
KEY_TEST_STRING_ELEMENT
,
"
abcd
"
);
console
.
info
(
"
Failed to flush. Cause:
"
+
err
);
}
catch
(
error
)
{
return
;
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
}
expect
(
false
).
assertTrue
()
console
.
info
(
"
Succeeded in flushing.
"
);
// observer will be called.
}
})
})
})
```
```
...
@@ -869,32 +1023,19 @@ off(type: 'change', callback?: Callback<{ key : string }>): void
...
@@ -869,32 +1023,19 @@ off(type: 'change', callback?: Callback<{ key : string }>): void
**示例:**
**示例:**
```
js
```
js
data_preferences
.
getPreferences
(
this
.
context
,
'
mystore
'
,
function
(
err
,
preferences
)
{
try
{
if
(
err
)
{
console
.
log
(
"
testPreferencesCallback015 begin.
"
)
console
.
info
(
"
Failed to get preferences.
"
);
var
observer
=
function
(
key
)
{
return
;
console
.
info
(
'
testPreferencesCallback015 key
'
+
key
);
}
expect
(
''
).
assertEqual
(
key
);
let
observer
=
function
(
key
)
{
};
console
.
info
(
"
The key
"
+
key
+
"
changed.
"
);
await
mPreference
.
on
(
'
change
'
,
observer
);
}
await
mPreference
.
off
(
'
change
'
,
observer
);
preferences
.
on
(
'
change
'
,
observer
);
await
mPreference
.
put
(
KEY_TEST_STRING_ELEMENT
,
"
abc
"
);
preferences
.
put
(
'
startup
'
,
'
auto
'
,
function
(
err
)
{
}
catch
(
error
)
{
if
(
err
)
{
console
.
log
(
"
trycatch err =
"
+
err
+
"
, code =
"
+
err
.
code
+
"
, message =
"
+
err
.
message
)
console
.
info
(
"
Failed to put the value of 'startup'. Cause:
"
+
err
);
expect
(
false
).
assertTrue
()
return
;
}
}
console
.
info
(
"
Succeeded in putting the value of 'startup'.
"
);
preferences
.
flush
(
function
(
err
)
{
if
(
err
)
{
console
.
info
(
"
Failed to flush. Cause:
"
+
err
);
return
;
}
console
.
info
(
"
Succeeded in flushing.
"
);
// observer will be called.
})
preferences
.
off
(
'
change
'
,
observer
);
})
})
```
```
## ValueType
## ValueType
...
...
zh-cn/application-dev/reference/errorcodes/errorcode-preferences.md
0 → 100644
浏览文件 @
6f7f8f08
# 首选项错误码
## 15500010 删除首选项失败
**错误信息**
<br>
Failed to delete preferences.
**错误描述**
<br>
删除首选项失败。
**可能原因**
系统错误导致文件删除失败。
**处理步骤**
重启设备后再次尝试。
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录