Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 14a72706 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!10882 增加首选项错误码文档 

Merge pull request !10882 from 一唯呀/master
上级 8966be05 4f1e59eb
隐藏空白更改
内联 并排
Showing with 374 addition and 226 deletion
zh-cn/application-dev/reference/apis/js-apis-data-preferences.md
浏览文件 @ 14a72706
......@@ -50,16 +50,19 @@ FA模型示例：
// 获取context
import featureAbility from '@ohos.ability.featureAbility';
let context = featureAbility.getContext();
let preferences = null;
data_preferences.getPreferences(context, 'mystore', function (err, object) {
if (err) {
console.info("Failed to get preferences. Cause: " + err);
return;
}
preferences = object;
console.info("Succeeded in getting preferences.");
})
try {
data_preferences.getPreferences(context, 'mystore', function (err, val) {
if (err) {
console.info("Failed to get preferences. code =" + err.code + ", message =" + err.message);
return;
}
console.info("Succeeded in getting preferences.");
})
} catch (err) {
console.info("Failed to get preferences. code =" + err.code + ", message =" + err.message);
}
```
Stage模型示例：
......@@ -75,14 +78,17 @@ class MainAbility extends Ability{
}
let preferences = null;
data_preferences.getPreferences(context, 'mystore', function (err, object) {
if (err) {
console.info("Failed to get preferences. Cause: " + err);
return;
}
preferences = object;
console.info("Succeeded in getting preferences.");
})
try {
data_preferences.getPreferences(context, 'mystore', function (err, val) {
if (err) {
console.info("Failed to get preferences. code =" + err.code + ", message =" + err.message);
return;
}
console.info("Succeeded in getting preferences.");
})
} catch (err) {
console.info("Failed to get preferences. code =" + err.code + ", message =" + err.message);
}
```
## data_preferences.getPreferences
......@@ -116,13 +122,17 @@ import featureAbility from '@ohos.ability.featureAbility';
let context = featureAbility.getContext();
let preferences = null;
let promise = data_preferences.getPreferences(context, 'mystore');
promise.then((object) => {
preferences = object;
console.info("Succeeded in getting preferences.");
}).catch((err) => {
console.info("Failed to get preferences. Cause: " + err);
})
try {
let promise = data_preferences.getPreferences(context, 'mystore');
promise.then((object) => {
preferences = object;
console.info("Succeeded in getting preferences.");
}).catch((err) => {
console.log("Failed to get preferences. code =" + err.code + ", message =" + err.message);
})
} catch(err) {
console.log("Failed to get preferences. code =" + err.code + ", message =" + err.message);
}
```
Stage模型示例：
......@@ -138,13 +148,17 @@ class MainAbility extends Ability{
}
let preferences = null;
let promise = data_preferences.getPreferences(context, 'mystore');
promise.then((object) => {
preferences = object;
console.info("Succeeded in getting preferences.");
}).catch((err) => {
console.info("Failed to get preferences. Cause: " + err);
})
try {
let promise = data_preferences.getPreferences(context, 'mystore');
promise.then((object) => {
preferences = object;
console.info("Succeeded in getting preferences.");
}).catch((err) => {
console.log("Failed to get preferences. code =" + err.code + ", message =" + err.message);
})
} catch(err) {
console.log("Failed to get preferences. code =" + err.code + ", message =" + err.message);
}
```
## data_preferences.deletePreferences
......@@ -167,6 +181,14 @@ deletePreferences(context: Context, name: string, callback: AsyncCallback<voi
| name | string | 是 | Preferences实例的名称。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当移除成功，err为undefined，否则为错误码。 |
**错误码：**
以下错误码的详细介绍请参见[首选项错误码](../errorcodes/errorcode-preferences.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------|
| 15500010 | Failed to delete preferences. |
**示例：**
FA模型示例：
......@@ -176,13 +198,17 @@ FA模型示例：
import featureAbility from '@ohos.ability.featureAbility';
let context = featureAbility.getContext();
data_preferences.deletePreferences(context, 'mystore', function (err) {
if (err) {
console.info("Failed to delete preferences. Cause: " + err);
return;
}
console.info("Succeeded in deleting preferences." );
})
try {
data_preferences.deletePreferences(context, 'mystore', function (err, val) {
if (err) {
console.info("Failed to delete preferences. code =" + err.code + ", message =" + err.message);
return;
}
console.info("Succeeded in deleting preferences." );
})
} catch (err) {
console.info("Failed to delete preferences. code =" + err.code + ", message =" + err.message);
}
```
Stage模型示例：
......@@ -197,13 +223,17 @@ class MainAbility extends Ability{
}
}
data_preferences.deletePreferences(context, 'mystore', function (err) {
if (err) {
console.info("Failed to delete preferences. Cause: " + err);
return;
}
console.info("Succeeded in deleting preferences." );
})
try {
data_preferences.deletePreferences(context, 'mystore', function (err, val) {
if (err) {
console.info("Failed to delete preferences. code =" + err.code + ", message =" + err.message);
return;
}
console.info("Succeeded in deleting preferences." );
})
} catch (err) {
console.info("Failed to delete preferences. code =" + err.code + ", message =" + err.message);
}
```
## data_preferences.deletePreferences
......@@ -231,6 +261,14 @@ deletePreferences(context: Context, name: string): Promise<void>
| ------------------- | ------------------------- |
| Promise<void> | 无返回结果的Promise对象。 |
**错误码：**
以下错误码的详细介绍请参见[首选项错误码](../errorcodes/errorcode-preferences.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------|
| 15500010 | Failed to delete preferences. |
**示例：**
FA模型示例：
......@@ -240,12 +278,16 @@ FA模型示例：
import featureAbility from '@ohos.ability.featureAbility';
let context = featureAbility.getContext();
let promise = data_preferences.deletePreferences(context, 'mystore');
promise.then(() => {
console.info("Succeeded in deleting preferences.");
}).catch((err) => {
console.info("Failed to delete preferences. Cause: " + err);
})
try {
let promise = data_preferences.deletePreferences(context, 'mystore');
promise.then(() => {
console.info("Succeeded in deleting preferences.");
}).catch((err) => {
console.info("Failed to delete preferences. code =" + err.code + ", message =" + err.message);
})
} catch(err) {
console.info("Failed to delete preferences. code =" + err.code + ", message =" + err.message);
}
```
Stage模型示例：
......@@ -260,12 +302,16 @@ class MainAbility extends Ability{
}
}
let promise = data_preferences.deletePreferences(context, 'mystore');
promise.then(() => {
console.info("Succeeded in deleting preferences.");
}).catch((err) => {
console.info("Failed to delete preferences. Cause: " + err);
})
try{
let promise = data_preferences.deletePreferences(context, 'mystore');
promise.then(() => {
console.info("Succeeded in deleting preferences.");
}).catch((err) => {
console.info("Failed to delete preferences. code =" + err.code + ", message =" + err.message);
})
} catch(err) {
console.info("Failed to delete preferences. code =" + err.code + ", message =" + err.message);
}
```
## data_preferences.removePreferencesFromCache
......@@ -295,13 +341,17 @@ FA模型示例：
import featureAbility from '@ohos.ability.featureAbility';
let context = featureAbility.getContext();
data_preferences.removePreferencesFromCache(context, 'mystore', function (err) {
if (err) {
console.info("Failed to remove preferences. Cause: " + err);
return;
}
console.info("Succeeded in removing preferences.");
})
try {
data_preferences.removePreferencesFromCache(context, 'mystore', function (err, val) {
if (err) {
console.info("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
return;
}
console.info("Succeeded in removing preferences.");
})
} catch (err) {
console.info("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
}
```
Stage模型示例：
......@@ -316,13 +366,18 @@ class MainAbility extends Ability{
}
}
data_preferences.removePreferencesFromCache(context, 'mystore', function (err) {
if (err) {
console.info("Failed to remove preferences. Cause: " + err);
return;
}
console.info("Succeeded in removing preferences.");
})
try {
data_preferences.removePreferencesFromCache(context, 'mystore', function (err, val) {
if (err) {
console.info("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
return;
}
console.info("Succeeded in removing preferences.");
})
} catch (err) {
console.info("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
}
```
## data_preferences.removePreferencesFromCache
......@@ -357,12 +412,16 @@ FA模型示例：
import featureAbility from '@ohos.ability.featureAbility';
let context = featureAbility.getContext();
let promise = data_preferences.removePreferencesFromCache(context, 'mystore');
promise.then(() => {
console.info("Succeeded in removing preferences.");
}).catch((err) => {
console.info("Failed to remove preferences. Cause: " + err);
})
try {
let promise = data_preferences.removePreferencesFromCache(context, 'mystore');
promise.then(() => {
console.info("Succeeded in removing preferences.");
}).catch((err) => {
console.info("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
})
} catch(err) {
console.info("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
}
```
Stage模型示例：
......@@ -377,12 +436,16 @@ class MainAbility extends Ability{
}
}
let promise = data_preferences.removePreferencesFromCache(context, 'mystore');
promise.then(() => {
console.info("Succeeded in removing preferences.");
}).catch((err) => {
console.info("Failed to remove preferences. Cause: " + err);
})
try {
let promise = data_preferences.removePreferencesFromCache(context, 'mystore');
promise.then(() => {
console.info("Succeeded in removing preferences.");
}).catch((err) => {
console.info("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
})
} catch(err) {
console.info("Failed to remove preferences. code =" + err.code + ", message =" + err.message);
}
```
## Preferences
......@@ -411,13 +474,17 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>):
**示例：**
```js
preferences.get('startup', 'default', function(err, data) {
if (err) {
console.info("Failed to get value of 'startup'. Cause: " + err);
return;
}
console.info("Succeeded in getting value of 'startup'. Data： " + data);
})
try {
data_preferences.get('startup', 'default', function (err, val) {
if (err) {
console.info("Failed to get value of 'startup'. code =" + err.code + ", message =" + err.message);
return;
}
console.info("Succeeded in getting value of 'startup'. val： " + val);
})
} catch (err) {
console.info("Failed to get value of 'startup'. code =" + err.code + ", message =" + err.message);
}
```
......@@ -445,12 +512,16 @@ get(key: string, defValue: ValueType): Promise<ValueType>
**示例：**
```js
let promise = preferences.get('startup', 'default');
promise.then((data) => {
console.info("Succeeded in getting value of 'startup'. Data: " + data);
}).catch((err) => {
console.info("Failed to get value of 'startup'. Cause: " + err);
})
try {
let promise = preferences.get('startup', 'default');
promise.then((data) => {
console.info("Succeeded in getting value of 'startup'. Data: " + data);
}).catch((err) => {
console.info("Failed to get value of 'startup'. code =" + err.code + ", message =" + err.message);
})
} catch(err) {
console.info("Failed to get value of 'startup'. code =" + err.code + ", message =" + err.message);
}
```
### getAll
......@@ -470,15 +541,19 @@ getAll(callback: AsyncCallback<Object>): void;
**示例：**
```js
preferences.getAll(function (err, value) {
if (err) {
console.info("Failed to get all key-values. Cause: " + err);
return;
}
try {
preferences.getAll(function (err, value) {
if (err) {
console.info("Failed to get all key-values. code =" + err.code + ", message =" + err.message);
return;
}
let allKeys = Object.keys(value);
console.info("getAll keys = " + allKeys);
console.info("getAll object = " + JSON.stringify(value));
});
})
} catch (err) {
console.info("Failed to get all key-values. code =" + err.code + ", message =" + err.message);
}
```
......@@ -499,14 +574,18 @@ getAll(): Promise<Object>
**示例：**
```js
let promise = preferences.getAll();
promise.then((value) => {
let allKeys = Object.keys(value);
console.info('getAll keys = ' + allKeys);
console.info("getAll object = " + JSON.stringify(value));
}).catch((err) => {
console.info("Failed to get all key-values. Cause: " + err);
})
try {
let promise = preferences.getAll();
promise.then((value) => {
let allKeys = Object.keys(value);
console.info('getAll keys = ' + allKeys);
console.info("getAll object = " + JSON.stringify(value));
}).catch((err) => {
console.info("Failed to get all key-values. code =" + err.code + ", message =" + err.message);
})
} catch (err) {
console.info("Failed to get all key-values. code =" + err.code + ", message =" + err.message);
}
```
### put
......@@ -528,13 +607,17 @@ put(key: string, value: ValueType, callback: AsyncCallback<void>): void
**示例：**
```js
preferences.put('startup', 'auto', function (err) {
if (err) {
console.info("Failed to put value of 'startup'. Cause: " + err);
return;
}
console.info("Succeeded in putting value of 'startup'.");
})
try {
preferences.put('startup', 'auto', function (err) {
if (err) {
console.info("Failed to put value of 'startup'. code =" + err.code + ", message =" + err.message);
return;
}
console.info("Succeeded in putting value of 'startup'.");
})
} catch (err) {
console.info("Failed to put value of 'startup'. code =" + err.code + ", message =" + err.message);
}
```
......@@ -562,12 +645,16 @@ put(key: string, value: ValueType): Promise<void>
**示例：**
```js
let promise = preferences.put('startup', 'auto');
promise.then(() => {
console.info("Succeeded in putting value of 'startup'.");
}).catch((err) => {
console.info("Failed to put value of 'startup'. Cause: " + err);
})
try {
let promise = preferences.put('startup', 'auto');
promise.then(() => {
console.info("Succeeded in putting value of 'startup'.");
}).catch((err) => {
console.info("Failed to put value of 'startup'. code =" + err.code +", message =" + err.message);
})
} catch(err) {
console.info("Failed to put value of 'startup'. code =" + err.code +", message =" + err.message);
}
```
......@@ -589,17 +676,21 @@ has(key: string, callback: AsyncCallback<boolean>): void
**示例：**
```js
preferences.has('startup', function (err, isExist) {
if (err) {
console.info("Failed to check the key 'startup'. Cause: " + err);
return;
}
if (isExist) {
console.info("The key 'startup' is contained.");
} else {
console.info("The key 'startup' dose not contain.");
}
})
try {
preferences.has('startup', function (err, val) {
if (err) {
console.info("Failed to check the key 'startup'. code =" + err.code + ", message =" + err.message);
return;
}
if (val) {
console.info("The key 'startup' is contained.");
} else {
console.info("The key 'startup' dose not contain.");
}
})
} catch (err) {
console.info("Failed to check the key 'startup'. code =" + err.code + ", message =" + err.message);
}
```
......@@ -626,16 +717,20 @@ has(key: string): Promise<boolean>
**示例：**
```js
let promise = preferences.has('startup');
promise.then((isExist) => {
if (isExist) {
console.info("The key 'startup' is contained.");
} else {
console.info("The key 'startup' dose not contain.");
}
}).catch((err) => {
console.info("Failed to check the key 'startup'. Cause: " + err);
})
try {
let promise = preferences.has('startup');
promise.then((val) => {
if (val) {
console.info("The key 'startup' is contained.");
} else {
console.info("The key 'startup' dose not contain.");
}
}).catch((err) => {
console.info("Failed to check the key 'startup'. code =" + err.code + ", message =" + err.message);
})
} catch(err) {
console.info("Failed to check the key 'startup'. code =" + err.code + ", message =" + err.message);
}
```
......@@ -657,13 +752,17 @@ delete(key: string, callback: AsyncCallback<void>): void
**示例：**
```js
preferences.delete('startup', function (err) {
if (err) {
console.info("Failed to delete the key 'startup'. Cause: " + err);
return;
}
console.info("Succeeded in deleting the key 'startup'.");
})
try {
preferences.delete('startup', function (err) {
if (err) {
console.info("Failed to delete the key 'startup'. code =" + err.code + ", message =" + err.message);
return;
}
console.info("Succeeded in deleting the key 'startup'.");
})
} catch (err) {
console.info("Failed to delete the key 'startup'. code =" + err.code + ", message =" + err.message);
}
```
......@@ -690,12 +789,16 @@ delete(key: string): Promise<void>
**示例：**
```js
let promise = preferences.delete('startup');
promise.then(() => {
console.info("Succeeded in deleting the key 'startup'.");
}).catch((err) => {
console.info("Failed to delete the key 'startup'. Cause: " + err);
})
try {
let promise = preferences.delete('startup');
promise.then(() => {
console.info("Succeeded in deleting the key 'startup'.");
}).catch((err) => {
console.log("Failed to delete the key 'startup'. code =" + err.code +", message =" + err.message);
})
} catch(err) {
console.log("Failed to delete the key 'startup'. code =" + err.code +", message =" + err.message);
}
```
......@@ -716,13 +819,17 @@ flush(callback: AsyncCallback<void>): void
**示例：**
```js
preferences.flush(function (err) {
if (err) {
console.info("Failed to flush. Cause: " + err);
return;
}
console.info("Succeeded in flushing.");
})
try {
preferences.flush(function (err) {
if (err) {
console.info("Failed to flush. code =" + err.code + ", message =" + err.message);
return;
}
console.info("Succeeded in flushing.");
})
} catch (err) {
console.info("Failed to flush. code =" + err.code + ", message =" + err.message);
}
```
......@@ -743,12 +850,16 @@ flush(): Promise<void>
**示例：**
```js
let promise = preferences.flush();
promise.then(() => {
console.info("Succeeded in flushing.");
}).catch((err) => {
console.info("Failed to flush. Cause: " + err);
})
try {
let promise = preferences.flush();
promise.then(() => {
console.info("Succeeded in flushing.");
}).catch((err) => {
console.info("Failed to flush. code =" + err.code + ", message =" + err.message);
})
} catch (err) {
console.info("Failed to flush. code =" + err.code + ", message =" + err.message);
}
```
......@@ -769,13 +880,17 @@ clear(callback: AsyncCallback<void>): void
**示例：**
```js
preferences.clear(function (err) {
if (err) {
console.info("Failed to clear. Cause: " + err);
return;
}
console.info("Succeeded in clearing.");
})
try {
preferences.clear(function (err) {
if (err) {
console.info("Failed to clear. code =" + err.code + ", message =" + err.message);
return;
}
console.info("Succeeded in clearing.");
})
} catch (err) {
console.info("Failed to clear. code =" + err.code + ", message =" + err.message);
}
```
......@@ -796,12 +911,16 @@ clear(): Promise<void>
**示例：**
```js
let promise = preferences.clear()
promise.then(() => {
console.info("Succeeded in clearing.");
}).catch((err) => {
console.info("Failed to clear. Cause: " + err);
})
try {
let promise = preferences.clear();
promise.then(() => {
console.info("Succeeded in clearing.");
}).catch((err) => {
console.info("Failed to clear. code =" + err.code + ", message =" + err.message);
})
} catch(err) {
console.info("Failed to clear. code =" + err.code + ", message =" + err.message);
}
```
......@@ -823,31 +942,35 @@ on(type: 'change', callback: Callback<{ key : string }>): void
**示例：**
```js
data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {
if (err) {
console.info("Failed to get preferences.");
return;
}
let observer = function (key) {
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'.");
preferences.flush(function (err) {
if (err) {
console.info("Failed to flush. Cause: " + err);
return;
}
console.info("Succeeded in flushing."); // observer will be called.
})
})
})
try {
data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {
if (err) {
console.info("Failed to get preferences.");
return;
}
let observer = function (key) {
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'.");
preferences.flush(function (err) {
if (err) {
console.info("Failed to flush. Cause: " + err);
return;
}
console.info("Succeeded in flushing.");
})
})
})
} catch (err) {
console.info("Failed to flush. code =" + err.code + ", message =" + err.message);
}
```
......@@ -869,32 +992,36 @@ off(type: 'change', callback?: Callback<{ key : string }>): void
**示例：**
```js
data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {
if (err) {
console.info("Failed to get preferences.");
return;
}
let observer = function (key) {
console.info("The key " + key + " changed.");
}
preferences.on('change', observer);
preferences.put('startup', 'auto', function (err) {
try {
data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {
if (err) {
console.info("Failed to put the value of 'startup'. Cause: " + err);
console.info("Failed to get preferences.");
return;
}
console.info("Succeeded in putting the value of 'startup'.");
preferences.flush(function (err) {
let observer = function (key) {
console.info("The key " + key + " changed.");
}
preferences.on('change', observer);
preferences.put('startup', 'auto', function (err) {
if (err) {
console.info("Failed to flush. Cause: " + err);
console.info("Failed to put the value of 'startup'. Cause: " + err);
return;
}
console.info("Succeeded in flushing."); // observer will be called.
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.");
})
preferences.off('change', observer);
})
preferences.off('change', observer);
})
})
} catch (err) {
console.info("Failed to flush. code =" + err.code + ", message =" + err.message);
}
```
## ValueType
......
zh-cn/application-dev/reference/errorcodes/errorcode-preferences.md 0 → 100644
浏览文件 @ 14a72706
# 首选项错误码
## 15500010 删除首选项失败
**错误信息**
Failed to delete preferences.
**错误描述**
删除首选项失败。
**可能原因**
系统错误导致文件删除失败，可能原因如下：
1. 文件名称不正确。
2. 文件路径不正确。
**处理步骤**
1. 检查文件名称是否正确。
2. 检查文件路径是否正确。
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或