未验证 提交 d17df5b3 编写于 作者: O openharmony_ci 提交者: Gitee

!9458 Preferences:开发指南和API参考,补充关于context在FA模型和Stage模型下不同的获取使用方式:需同步翻译

Merge pull request !9458 from 葛亚芳/master
...@@ -55,15 +55,15 @@ ...@@ -55,15 +55,15 @@
| ----------- | ----------------------- | ------------------------------------------- | | ----------- | ----------------------- | ------------------------------------------- |
| Preferences | flush(): Promise\<void> | 将Preferences实例通过异步线程回写入文件中。 | | Preferences | flush(): Promise\<void> | 将Preferences实例通过异步线程回写入文件中。 |
### 订阅数据变 ### 订阅数据变
订阅数据变更者类,订阅的Key的值发生变更后,在执行flush方法后,会触发callback回调。 订阅数据变更,订阅的Key的值发生变更后,在执行flush方法后,会触发callback回调。
**表5** 首选项变化订阅接口 **表5** 首选项变化订阅接口
| 类名 | 接口名 | 描述 | | 类名 | 接口名 | 描述 |
| ----------- | ------------------------------------------------------------ | -------------- | | ----------- | ------------------------------------------------------------ | -------------- |
| Preferences | on(type: 'change', callback: Callback<{ key : string }>): void | 订阅数据变。 | | Preferences | on(type: 'change', callback: Callback<{ key : string }>): void | 订阅数据变。 |
| Preferences | off(type: 'change', callback: Callback<{ key : string }>): void | 注销订阅。 | | Preferences | off(type: 'change', callback: Callback<{ key : string }>): void | 注销订阅。 |
### 删除数据文件 ### 删除数据文件
...@@ -88,8 +88,30 @@ ...@@ -88,8 +88,30 @@
2. 获取Preferences实例。 2. 获取Preferences实例。
读取指定文件,将数据加载到Preferences实例,用于数据操作。 读取指定文件,将数据加载到Preferences实例,用于数据操作。
FA模型示例:
```js ```js
let promise = data_preferences.getPreferences(this.context, 'mystore'); // 获取context
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext()
let promise = data_preferences.getPreferences(context, 'mystore');
```
Stage模型示例:
```ts
// 获取context
import Ability from '@ohos.application.Ability'
var context
class MainAbility extends Ability{
onWindowStageCreate(windowStage){
context = this.context
}
}
let promise = data_preferences.getPreferences(context, 'mystore');
``` ```
3. 存入数据。 3. 存入数据。
...@@ -134,9 +156,9 @@ ...@@ -134,9 +156,9 @@
preferences.flush(); preferences.flush();
``` ```
6. 订阅数据变 6. 订阅数据变
应用订阅数据变需要指定observer作为回调方法。订阅的Key的值发生变更后,当执行flush方法时,observer被触发回调。 应用订阅数据变需要指定observer作为回调方法。订阅的Key的值发生变更后,当执行flush方法时,observer被触发回调。
```js ```js
var observer = function (key) { var observer = function (key) {
......
...@@ -38,15 +38,21 @@ getPreferences(context: Context, name: string, callback: AsyncCallback&lt;Prefer ...@@ -38,15 +38,21 @@ getPreferences(context: Context, name: string, callback: AsyncCallback&lt;Prefer
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ------------------------------------------------ | ---- | ------------------------------------------------------------ |
| 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实例的名称。 |
| callback | AsyncCallback&lt;[Preferences](#preferences)&gt; | 是 | 回调函数。当获取Preferences实例成功,err为undefined,返回Preferences实例;否则err为错误码。 | | callback | AsyncCallback&lt;[Preferences](#preferences)&gt; | 是 | 回调函数。当获取Preferences实例成功,err为undefined,返回Preferences实例;否则err为错误码。 |
**示例:** **示例:**
FA模型示例:
```js ```js
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext()
var preferences = null; var preferences = null;
data_preferences.getPreferences(this.context, 'mystore', function (err, object) { data_preferences.getPreferences(context, 'mystore', function (err, object) {
if (err) { if (err) {
console.info("Failed to get preferences. Cause: " + err); console.info("Failed to get preferences. Cause: " + err);
return; return;
...@@ -56,6 +62,28 @@ data_preferences.getPreferences(this.context, 'mystore', function (err, object) ...@@ -56,6 +62,28 @@ data_preferences.getPreferences(this.context, 'mystore', function (err, object)
}) })
``` ```
Stage模型示例:
```ts
// 获取context
import Ability from '@ohos.application.Ability'
var context;
class MainAbility extends Ability{
onWindowStageCreate(windowStage){
context = this.context
}
}
var 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.");
})
```
## data_preferences.getPreferences ## data_preferences.getPreferences
...@@ -69,7 +97,7 @@ getPreferences(context: Context, name: string): Promise&lt;Preferences&gt; ...@@ -69,7 +97,7 @@ getPreferences(context: Context, name: string): Promise&lt;Preferences&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------- | ---- | ----------------------- | | ------- | ------------------------------------- | ---- | ----------------------- |
| 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实例的名称。 |
**返回值:** **返回值:**
...@@ -80,9 +108,15 @@ getPreferences(context: Context, name: string): Promise&lt;Preferences&gt; ...@@ -80,9 +108,15 @@ getPreferences(context: Context, name: string): Promise&lt;Preferences&gt;
**示例:** **示例:**
FA模型示例:
```js ```js
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext()
var preferences = null; var preferences = null;
let promise = data_preferences.getPreferences(this.context, 'mystore') let promise = data_preferences.getPreferences(context, 'mystore')
promise.then((object) => { promise.then((object) => {
preferences = object; preferences = object;
console.info("Succeeded in getting preferences."); console.info("Succeeded in getting preferences.");
...@@ -91,6 +125,27 @@ promise.then((object) => { ...@@ -91,6 +125,27 @@ promise.then((object) => {
}) })
``` ```
Stage模型示例:
```ts
// 获取context
import Ability from '@ohos.application.Ability'
var context;
class MainAbility extends Ability{
onWindowStageCreate(windowStage){
context = this.context
}
}
var 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);
})
```
## data_preferences.deletePreferences ## data_preferences.deletePreferences
...@@ -108,14 +163,20 @@ deletePreferences(context: Context, name: string, callback: AsyncCallback&lt;voi ...@@ -108,14 +163,20 @@ deletePreferences(context: Context, name: string, callback: AsyncCallback&lt;voi
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ---------------------------------------------------- | | -------- | ------------------------------------- | ---- | ---------------------------------------------------- |
| 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实例的名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当移除成功,err为undefined,否则为错误码。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当移除成功,err为undefined,否则为错误码。 |
**示例:** **示例:**
FA模型示例:
```js ```js
data_preferences.deletePreferences(this.context, 'mystore', function (err) { // 获取context
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext()
data_preferences.deletePreferences(context, 'mystore', function (err) {
if (err) { if (err) {
console.info("Failed to delete preferences. Cause: " + err); console.info("Failed to delete preferences. Cause: " + err);
return return
...@@ -124,6 +185,26 @@ data_preferences.deletePreferences(this.context, 'mystore', function (err) { ...@@ -124,6 +185,26 @@ data_preferences.deletePreferences(this.context, 'mystore', function (err) {
}) })
``` ```
Stage模型示例:
```ts
// 获取context
import Ability from '@ohos.application.Ability'
var context
class MainAbility extends Ability{
onWindowStageCreate(windowStage){
context = this.context
}
}
data_preferences.deletePreferences(context, 'mystore', function (err) {
if (err) {
console.info("Failed to delete preferences. Cause: " + err);
return
}
console.info("Succeeded in deleting preferences." );
})
```
## data_preferences.deletePreferences ## data_preferences.deletePreferences
...@@ -141,7 +222,7 @@ deletePreferences(context: Context, name: string): Promise&lt;void&gt; ...@@ -141,7 +222,7 @@ deletePreferences(context: Context, name: string): Promise&lt;void&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------- | ---- | ----------------------- | | ------- | ------------------------------------- | ---- | ----------------------- |
| 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实例的名称。 |
**返回值:** **返回值:**
...@@ -152,8 +233,14 @@ deletePreferences(context: Context, name: string): Promise&lt;void&gt; ...@@ -152,8 +233,14 @@ deletePreferences(context: Context, name: string): Promise&lt;void&gt;
**示例:** **示例:**
FA模型示例:
```js ```js
let promise = data_preferences.deletePreferences(this.context, 'mystore') // 获取context
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext()
let promise = data_preferences.deletePreferences(context, 'mystore')
promise.then(() => { promise.then(() => {
console.info("Succeeded in deleting preferences."); console.info("Succeeded in deleting preferences.");
}).catch((err) => { }).catch((err) => {
...@@ -161,6 +248,25 @@ promise.then(() => { ...@@ -161,6 +248,25 @@ promise.then(() => {
}) })
``` ```
Stage模型示例:
```ts
// 获取context
import Ability from '@ohos.application.Ability'
var context
class MainAbility extends Ability{
onWindowStageCreate(windowStage){
context = this.context
}
}
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);
})
```
## data_preferences.removePreferencesFromCache ## data_preferences.removePreferencesFromCache
...@@ -176,14 +282,20 @@ removePreferencesFromCache(context: Context, name: string, callback: AsyncCallba ...@@ -176,14 +282,20 @@ removePreferencesFromCache(context: Context, name: string, callback: AsyncCallba
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ---------------------------------------------------- | | -------- | ------------------------------------- | ---- | ---------------------------------------------------- |
| 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实例的名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当移除成功,err为undefined,否则为错误码。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当移除成功,err为undefined,否则为错误码。 |
**示例:** **示例:**
FA模型示例:
```js ```js
data_preferences.removePreferencesFromCache(this.context, 'mystore', function (err) { // 获取context
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext()
data_preferences.removePreferencesFromCache(context, 'mystore', function (err) {
if (err) { if (err) {
console.info("Failed to remove preferences. Cause: " + err); console.info("Failed to remove preferences. Cause: " + err);
return; return;
...@@ -192,6 +304,26 @@ data_preferences.removePreferencesFromCache(this.context, 'mystore', function (e ...@@ -192,6 +304,26 @@ data_preferences.removePreferencesFromCache(this.context, 'mystore', function (e
}) })
``` ```
Stage模型示例:
```ts
// 获取context
import Ability from '@ohos.application.Ability'
var context
class MainAbility extends Ability{
onWindowStageCreate(windowStage){
context = this.context
}
}
data_preferences.removePreferencesFromCache(context, 'mystore', function (err) {
if (err) {
console.info("Failed to remove preferences. Cause: " + err);
return;
}
console.info("Succeeded in removing preferences.");
})
```
## data_preferences.removePreferencesFromCache ## data_preferences.removePreferencesFromCache
...@@ -207,7 +339,7 @@ removePreferencesFromCache(context: Context, name: string): Promise&lt;void&gt; ...@@ -207,7 +339,7 @@ removePreferencesFromCache(context: Context, name: string): Promise&lt;void&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------- | ---- | ----------------------- | | ------- | ------------------------------------- | ---- | ----------------------- |
| 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实例的名称。 |
**返回值:** **返回值:**
...@@ -218,8 +350,14 @@ removePreferencesFromCache(context: Context, name: string): Promise&lt;void&gt; ...@@ -218,8 +350,14 @@ removePreferencesFromCache(context: Context, name: string): Promise&lt;void&gt;
**示例:** **示例:**
FA模型示例:
```js ```js
let promise = data_preferences.removePreferencesFromCache(this.context, 'mystore') // 获取context
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext()
let promise = data_preferences.removePreferencesFromCache(context, 'mystore')
promise.then(() => { promise.then(() => {
console.info("Succeeded in removing preferences."); console.info("Succeeded in removing preferences.");
}).catch((err) => { }).catch((err) => {
...@@ -227,6 +365,25 @@ promise.then(() => { ...@@ -227,6 +365,25 @@ promise.then(() => {
}) })
``` ```
Stage模型示例:
```ts
// 获取context
import Ability from '@ohos.application.Ability'
var context
class MainAbility extends Ability{
onWindowStageCreate(windowStage){
context = this.context
}
}
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);
})
```
## Preferences ## Preferences
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册