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

!3987 Update data-Preferences File Context and sample code

Merge pull request !3987 from PaDaBoo/master
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
首选项为应用提供key-value键值型的数据处理能力,支持应用持久化轻量级数据,并对其修改和查询。数据存储形式为键值对,键的类型为字符串型,值的存储数据类型包括数字型、字符型、布尔型。 首选项为应用提供key-value键值型的数据处理能力,支持应用持久化轻量级数据,并对其修改和查询。数据存储形式为键值对,键的类型为字符串型,值的存储数据类型包括数字型、字符型、布尔型。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > **说明:**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...@@ -15,7 +15,7 @@ import data_preferences from '@ohos.data.preferences'; ...@@ -15,7 +15,7 @@ import data_preferences from '@ohos.data.preferences';
## 常量 ## 常量
**系统能力**以下各项对应的系统能力均为SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.Preferences.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
...@@ -30,43 +30,25 @@ getPreferences(context: Context, name: string, callback: AsyncCallback<Prefer ...@@ -30,43 +30,25 @@ getPreferences(context: Context, name: string, callback: AsyncCallback<Prefer
读取指定首选项持久化文件,将数据加载到Preferences实例,用于数据操作,该方法使用callback方式作为异步方法。 读取指定首选项持久化文件,将数据加载到Preferences实例,用于数据操作,该方法使用callback方式作为异步方法。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| context | [Context](js-apis-Context.md) | 是 | 应用程序或功能的上下文。 | | context | [Context](js-apis-ability-context.md) | 是 | 应用程序或功能的上下文。 |
| name | string | 是 | 应用程序内部数据存储名称。 | | name | string | 是 | 应用程序内部数据存储名称。 |
| callback | AsyncCallback<[Preferences](#preferences)> | 是 | 回调函数。 | | callback | AsyncCallback<[Preferences](#preferences)> | 是 | 回调函数。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {
import data_preferences from '@ohos.data.preferences'
export default class MainAbility extends Ability {
data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {
if (err) { if (err) {
console.info("Get the preferences failed") console.info("Get preferences failed.")
return; return;
} }
preferences.put('startup', 'auto', function (err) { console.info("Get preferences successfully.")
if (err) { })
console.info("Put the value of startup failed, err: " + err) ```
return
}
console.info("Put the value of startup successfully.")
preferences.flush(function (err) {
if (err) {
console.info("Flush to file failed, err: " + err)
return
}
console.info("Flushed to file successfully.")
})
})
})
}
```
## data_preferences.getPreferences ## data_preferences.getPreferences
...@@ -75,12 +57,12 @@ getPreferences(context: Context, name: string): Promise<Preferences> ...@@ -75,12 +57,12 @@ getPreferences(context: Context, name: string): Promise<Preferences>
读取指定首选项持久化文件,将数据加载到Preferences实例,用于数据操作,该方法使用Promise方式作为异步方法。 读取指定首选项持久化文件,将数据加载到Preferences实例,用于数据操作,该方法使用Promise方式作为异步方法。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| context | [Context](js-apis-Context.md) | 是 | 应用程序或功能的上下文。 | | context | [Context](js-apis-ability-context.md) | 是 | 应用程序或功能的上下文。 |
| name | string | 是 | 应用程序内部数据存储名称。 | | name | string | 是 | 应用程序内部数据存储名称。 |
**返回值:** **返回值:**
...@@ -89,32 +71,14 @@ getPreferences(context: Context, name: string): Promise<Preferences> ...@@ -89,32 +71,14 @@ getPreferences(context: Context, name: string): Promise<Preferences>
| Promise<[Preferences](#preferences)> | Promise实例,用于异步获取结果。 | | Promise<[Preferences](#preferences)> | Promise实例,用于异步获取结果。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' let promise = data_preferences.getPreferences(this.context, 'mystore')
import data_preferences from '@ohos.data.preferences' promise.then((preferences) => {
export default class MainAbility extends Ability { console.info("Get preferences successfully.")
}).catch((err) => {
let promise = data_preferences.getPreferences(this.context, 'mystore') console.info("Get preferences failed.")
promise.then((preferences) => { })
preferences.put('startup', 'auto', function (err) { ```
if (err) {
console.info("Put the value of startup failed, err: " + err)
return
}
console.info("Put the value of startup successfully.")
preferences.flush(function (err) {
if (err) {
console.info("Flush to file failed, err: " + err)
return
}
console.info("Flushed to file successfully.")
})
})
}).catch((err) => {
console.info("Get the preferences failed")
})
}
```
## data_preferences.deletePreferences ## data_preferences.deletePreferences
...@@ -124,30 +88,25 @@ deletePreferences(context: Context, name: string, callback: AsyncCallback<voi ...@@ -124,30 +88,25 @@ deletePreferences(context: Context, name: string, callback: AsyncCallback<voi
从内存中移除指定首选项持久化文件对应的Preferences单实例,并删除指定文件及其备份文件和损坏文件。 从内存中移除指定首选项持久化文件对应的Preferences单实例,并删除指定文件及其备份文件和损坏文件。
删除指定首选项持久化文件时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题,该方法使用callback方式作为异步方法。 删除指定首选项持久化文件时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题,该方法使用callback方式作为异步方法。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| context | [Context](js-apis-Context.md) | 是 | 应用程序或功能的上下文。 | | context | [Context](js-apis-ability-context.md) | 是 | 应用程序或功能的上下文。 |
| name | string | 是 | 应用程序内部数据存储名称。 | | name | string | 是 | 应用程序内部数据存储名称。 |
| callback | AsyncCallback<void> | 是 | 回调函数。 | | callback | AsyncCallback<void> | 是 | 回调函数。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' data_preferences.deletePreferences(this.context, 'mystore', function (err) {
import data_preferences from '@ohos.data.preferences'
export default class MainAbility extends Ability {
data_preferences.deletePreferences(this.context, 'mystore', function (err) {
if (err) { if (err) {
console.info("Deleted failed, err: " + err) console.info("Deleted preferences failed, err: " + err)
return return
} }
console.info("Deleted successfully.") console.info("Deleted preferences successfully.")
}) })
} ```
```
## data_preferences.deletePreferences ## data_preferences.deletePreferences
...@@ -157,12 +116,12 @@ deletePreferences(context: Context, name: string): Promise<void> ...@@ -157,12 +116,12 @@ deletePreferences(context: Context, name: string): Promise<void>
从内存中移除指定首选项持久化文件对应的Preferences单实例,并删除指定文件及其备份文件和损坏文件。 从内存中移除指定首选项持久化文件对应的Preferences单实例,并删除指定文件及其备份文件和损坏文件。
删除指定首选项持久化文件时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题,该方法使用Promise方式作为异步方法。 删除指定首选项持久化文件时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题,该方法使用Promise方式作为异步方法。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| context | [Context](js-apis-Context.md) | 是 | 应用程序或功能的上下文。 | | context | [Context](js-apis-ability-context.md) | 是 | 应用程序或功能的上下文。 |
| name | string | 是 | 应用程序内部数据存储名称。 | | name | string | 是 | 应用程序内部数据存储名称。 |
**返回值:** **返回值:**
...@@ -171,19 +130,14 @@ deletePreferences(context: Context, name: string): Promise<void> ...@@ -171,19 +130,14 @@ deletePreferences(context: Context, name: string): Promise<void>
| Promise<void> | Promise实例,用于异步获取结果。 | | Promise<void> | Promise实例,用于异步获取结果。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' let promise = data_preferences.deletePreferences(this.context, 'mystore')
import data_preferences from '@ohos.data.preferences' promise.then(() => {
export default class MainAbility extends Ability { console.info("Deleted preferences successfully.")
}).catch((err) => {
let promise = data_preferences.deletePreferences(this.context, 'mystore') console.info("Deleted preferences failed, err: " + err)
promise.then(() => { })
console.info("Deleted successfully.") ```
}).catch((err) => {
console.info("Deleted failed, err: " + err)
})
}
```
## data_preferences.removePreferencesFromCache ## data_preferences.removePreferencesFromCache
...@@ -194,30 +148,25 @@ removePreferencesFromCache(context: Context, name: string, callback: AsyncCallba ...@@ -194,30 +148,25 @@ removePreferencesFromCache(context: Context, name: string, callback: AsyncCallba
移除Preferences单实例时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题,该方法使用callback方式作为异步方法。 移除Preferences单实例时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题,该方法使用callback方式作为异步方法。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| context | [Context](js-apis-Context.md) | 是 | 应用程序或功能的上下文。 | | context | [Context](js-apis-ability-context.md) | 是 | 应用程序或功能的上下文。 |
| name | string | 是 | 应用程序内部数据存储名称。 | | name | string | 是 | 应用程序内部数据存储名称。 |
| callback | AsyncCallback<void> | 是 | 回调函数。 | | callback | AsyncCallback<void> | 是 | 回调函数。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' data_preferences.removePreferencesFromCache(this.context, 'mystore', function (err) {
import data_preferences from '@ohos.data.preferences'
export default class MainAbility extends Ability {
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
} }
console.info("Removed preferences from cache successfully.") console.info("Removed preferences from cache successfully.")
}) })
} ```
```
## data_preferences.removePreferencesFromCache ## data_preferences.removePreferencesFromCache
...@@ -228,12 +177,12 @@ removePreferencesFromCache(context: Context, name: string): Promise<void> ...@@ -228,12 +177,12 @@ removePreferencesFromCache(context: Context, name: string): Promise<void>
移除Preferences单实例时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题,该方法使用Promise方式作为异步方法。 移除Preferences单实例时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题,该方法使用Promise方式作为异步方法。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| context | [Context](js-apis-Context.md) | 是 | 应用程序或功能的上下文。 | | context | [Context](js-apis-ability-context.md) | 是 | 应用程序或功能的上下文。 |
| name | string | 是 | 应用程序内部数据存储名称。 | | name | string | 是 | 应用程序内部数据存储名称。 |
**返回值:** **返回值:**
...@@ -242,19 +191,14 @@ removePreferencesFromCache(context: Context, name: string): Promise<void> ...@@ -242,19 +191,14 @@ removePreferencesFromCache(context: Context, name: string): Promise<void>
| Promise<void> | Promise实例,用于异步获取结果。 | | Promise<void> | Promise实例,用于异步获取结果。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' let promise = data_preferences.removePreferencesFromCache(this.context, 'mystore')
import data_preferences from '@ohos.data.preferences' promise.then(() => {
export default class MainAbility extends Ability {
let promise = data_preferences.removePreferencesFromCache(this.context, 'mystore')
promise.then(() => {
console.info("Removed preferences from cache successfully.") console.info("Removed preferences from cache successfully.")
}).catch((err) => { }).catch((err) => {
console.info("Removed preferences from cache failed, err: " + err) console.info("Removed preferences from cache failed, err: " + err)
}) })
} ```
```
## Preferences ## Preferences
...@@ -268,7 +212,7 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>): ...@@ -268,7 +212,7 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>):
获取键对应的值,如果值为null或者非默认值类型,返回默认数据,该方法使用callback方式作为异步方法。 获取键对应的值,如果值为null或者非默认值类型,返回默认数据,该方法使用callback方式作为异步方法。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -278,26 +222,15 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>): ...@@ -278,26 +222,15 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>):
| callback | AsyncCallback<ValueType> | 是 | 回调函数。 | | callback | AsyncCallback<ValueType> | 是 | 回调函数。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
export default class MainAbility extends Ability {
data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {
if (err) {
console.info("Get the preferences failed, err: " + err)
return
}
preferences.get('startup', 'default', function(err, value) { preferences.get('startup', 'default', function(err, value) {
if (err) { if (err) {
console.info("Get the value of startup failed, err: " + err) console.info("Get value of startup failed, err: " + err)
return return
} }
console.info("The value of startup is " + value) console.info("Get value of startup is " + value)
}) })
}) ```
}
```
### get ### get
...@@ -306,7 +239,7 @@ get(key: string, defValue: ValueType): Promise<ValueType> ...@@ -306,7 +239,7 @@ get(key: string, defValue: ValueType): Promise<ValueType>
获取键对应的值,如果值为null或者非默认值类型,返回默认数据,该方法使用Promise方式作为异步方法。 获取键对应的值,如果值为null或者非默认值类型,返回默认数据,该方法使用Promise方式作为异步方法。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
- **参数:** - **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -320,24 +253,14 @@ get(key: string, defValue: ValueType): Promise<ValueType> ...@@ -320,24 +253,14 @@ get(key: string, defValue: ValueType): Promise<ValueType>
| Promise<ValueType> | Promise实例,用于异步获取结果。 | | Promise<ValueType> | Promise实例,用于异步获取结果。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' let promise = preferences.get('startup', 'default')
import data_preferences from '@ohos.data.preferences' promise.then((value) => {
export default class MainAbility extends Ability { console.info("Get value of startup is " + value)
}).catch((err) => {
let promise = data_preferences.getPreferences(this.context, 'mystore') console.info("Get value of startup failed, err: " + err)
promise.then((preferences) => { })
let promiseGet = preferences.get('startup', 'default') ```
promiseGet.then((value) => {
console.info("The value of startup is " + value)
}).catch((err) => {
console.info("Get the value of startup failed, err: " + err)
})
}).catch((err) => {
console.info("Get the preferences failed, err: " + err)
})
}
```
### put ### put
...@@ -346,7 +269,7 @@ put(key: string, value: ValueType, callback: AsyncCallback<void>): void ...@@ -346,7 +269,7 @@ put(key: string, value: ValueType, callback: AsyncCallback<void>): void
首先获取指定首选项持久化文件对应的Preferences实例,然后借助Preferences API将数据写入Preferences实例,通过flush或者flushSync将Preferences实例持久化,该方法使用callback方式作为异步方法。 首先获取指定首选项持久化文件对应的Preferences实例,然后借助Preferences API将数据写入Preferences实例,通过flush或者flushSync将Preferences实例持久化,该方法使用callback方式作为异步方法。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -356,26 +279,15 @@ put(key: string, value: ValueType, callback: AsyncCallback<void>): void ...@@ -356,26 +279,15 @@ put(key: string, value: ValueType, callback: AsyncCallback<void>): void
| callback | AsyncCallback<void> | 是 | 回调函数。 | | callback | AsyncCallback<void> | 是 | 回调函数。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' preferences.put('startup', 'auto', function (err) {
import data_preferences from '@ohos.data.preferences'
export default class MainAbility extends Ability {
data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {
if (err) {
console.info("Get the preferences failed, err: " + err)
return
}
preferences.put('startup', 'auto', function (err) {
if (err) { if (err) {
console.info("Put the value of startup failed, err: " + err) console.info("Put value of startup failed, err: " + err)
return return
} }
console.info("Put the value of startup successfully.") console.info("Put value of startup successfully.")
}) })
}) ```
}
```
### put ### put
...@@ -384,7 +296,7 @@ put(key: string, value: ValueType): Promise<void> ...@@ -384,7 +296,7 @@ put(key: string, value: ValueType): Promise<void>
首先获取指定首选项持久化文件对应的Preferences实例,然后借助Preferences API将数据写入Preferences实例,通过flush或者flushSync将Preferences实例持久化,该方法使用Promise方式作为异步方法。 首先获取指定首选项持久化文件对应的Preferences实例,然后借助Preferences API将数据写入Preferences实例,通过flush或者flushSync将Preferences实例持久化,该方法使用Promise方式作为异步方法。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -398,24 +310,14 @@ put(key: string, value: ValueType): Promise<void> ...@@ -398,24 +310,14 @@ put(key: string, value: ValueType): Promise<void>
| Promise<void> | Promise实例,用于异步处理。 | | Promise<void> | Promise实例,用于异步处理。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' let promise = preferences.put('startup', 'auto')
import data_preferences from '@ohos.data.preferences' promise.then(() => {
export default class MainAbility extends Ability { console.info("Put value of startup successfully.")
}).catch((err) => {
let promise = data_preferences.getPreferences(this.context, 'mystore') console.info("Put value of startup failed, err: " + err)
promise.then((preferences) => { })
let promisePut = preferences.put('startup', 'auto') ```
promisePut.then(() => {
console.info("Put the value of startup successfully.")
}).catch((err) => {
console.info("Put the value of startup failed, err: " + err)
})
}).catch((err) => {
console.info("Get the preferences failed, err: " + err)
})
}
```
### has ### has
...@@ -424,7 +326,7 @@ has(key: string, callback: AsyncCallback<boolean>): boolean ...@@ -424,7 +326,7 @@ has(key: string, callback: AsyncCallback<boolean>): boolean
检查存储对象是否包含名为给定key的存储键值对,该方法使用callback方式作为异步方法。 检查存储对象是否包含名为给定key的存储键值对,该方法使用callback方式作为异步方法。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -438,17 +340,8 @@ has(key: string, callback: AsyncCallback<boolean>): boolean ...@@ -438,17 +340,8 @@ has(key: string, callback: AsyncCallback<boolean>): boolean
| boolean | true表示存在,false表示不存在。 | | boolean | true表示存在,false表示不存在。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' preferences.has('startup', function (err, isExist) {
import data_preferences from '@ohos.data.preferences'
export default class MainAbility extends Ability {
data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {
if (err) {
console.info("Get the preferences failed, err: " + err)
return
}
preferences.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
...@@ -458,10 +351,8 @@ has(key: string, callback: AsyncCallback<boolean>): boolean ...@@ -458,10 +351,8 @@ has(key: string, callback: AsyncCallback<boolean>): boolean
} else { } else {
console.info("The key of startup dose not contain.") console.info("The key of startup dose not contain.")
} }
}) })
}) ```
}
```
### has ### has
...@@ -470,7 +361,7 @@ has(key: string): Promise<boolean> ...@@ -470,7 +361,7 @@ has(key: string): Promise<boolean>
检查存储对象是否包含名为给定key的存储键值对,该方法使用Promise方式作为异步方法。 检查存储对象是否包含名为给定key的存储键值对,该方法使用Promise方式作为异步方法。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -483,28 +374,18 @@ has(key: string): Promise<boolean> ...@@ -483,28 +374,18 @@ has(key: string): Promise<boolean>
| Promise<boolean> | Promise实例,用于异步处理。 | | Promise<boolean> | Promise实例,用于异步处理。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' let promise = preferences.has('startup')
import data_preferences from '@ohos.data.preferences' promise.then((isExist) => {
export default class MainAbility extends Ability {
let promise = data_preferences.getPreferences(this.context, 'mystore')
promise.then((preferences) => {
let promiseHas = preferences.has('startup')
promiseHas.then((isExist) => {
if (isExist) { if (isExist) {
console.info("The key of startup is contained.") console.info("The key of startup is contained.")
} else { } else {
console.info("The key of startup dose not contain.") console.info("The key of startup dose not contain.")
} }
}).catch((err) => { }).catch((err) => {
console.info("Check the key of startup failed, err: " + err) console.info("Check the key of startup failed, err: " + err)
}) })
}).catch((err) => { ```
console.info("Get the preferences failed, err: " + err)
})
}
```
### delete ### delete
...@@ -513,7 +394,7 @@ delete(key: string, callback: AsyncCallback<void>): void ...@@ -513,7 +394,7 @@ delete(key: string, callback: AsyncCallback<void>): void
从存储对象中删除名为给定key的存储键值对,该方法使用callback方式作为异步方法。 从存储对象中删除名为给定key的存储键值对,该方法使用callback方式作为异步方法。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -522,26 +403,15 @@ delete(key: string, callback: AsyncCallback<void>): void ...@@ -522,26 +403,15 @@ delete(key: string, callback: AsyncCallback<void>): void
| callback | AsyncCallback<void> | 是 | 回调函数。 | | callback | AsyncCallback<void> | 是 | 回调函数。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' preferences.delete('startup', function (err) {
import data_preferences from '@ohos.data.preferences'
export default class MainAbility extends Ability {
data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {
if (err) {
console.info("Get the preferences failed, err: " + err)
return
}
preferences.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
} }
console.info("Deleted startup key successfully.") console.info("Deleted startup key successfully.")
}) })
}) ```
}
```
### delete ### delete
...@@ -550,7 +420,7 @@ delete(key: string): Promise<void> ...@@ -550,7 +420,7 @@ delete(key: string): Promise<void>
从存储对象删除名为给定key的存储键值对,该方法使用Promise方式作为异步方法。 从存储对象删除名为给定key的存储键值对,该方法使用Promise方式作为异步方法。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -563,24 +433,14 @@ delete(key: string): Promise<void> ...@@ -563,24 +433,14 @@ delete(key: string): Promise<void>
| Promise<void> | Promise实例,用于异步处理。 | | Promise<void> | Promise实例,用于异步处理。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' let promise = preferences.delete('startup')
import data_preferences from '@ohos.data.preferences' promise.then(() => {
export default class MainAbility extends Ability {
let promise = data_preferences.getPreferences(this.context, 'mystore')
promise.then((preferences) => {
let promiseDelete = preferences.delete('startup')
promiseDelete.then(() => {
console.info("Deleted startup key successfully.") console.info("Deleted startup key successfully.")
}).catch((err) => { }).catch((err) => {
console.info("Delete startup key failed, err: " + err) console.info("Delete startup key failed, err: " + err)
}) })
}).catch((err) => { ```
console.info("Get the preferences failed, err: " + err)
})
}
```
### flush ### flush
...@@ -589,7 +449,7 @@ flush(callback: AsyncCallback<void>): void ...@@ -589,7 +449,7 @@ flush(callback: AsyncCallback<void>): void
将当前preferences对象中的修改保存到当前的preferences,并异步存储到首选项持久化文件中,该方法使用callback方式作为异步方法。 将当前preferences对象中的修改保存到当前的preferences,并异步存储到首选项持久化文件中,该方法使用callback方式作为异步方法。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -597,26 +457,15 @@ flush(callback: AsyncCallback<void>): void ...@@ -597,26 +457,15 @@ flush(callback: AsyncCallback<void>): void
| callback | AsyncCallback<void> | 是 | 回调函数。 | | callback | AsyncCallback<void> | 是 | 回调函数。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' preferences.flush(function (err) {
import data_preferences from '@ohos.data.preferences'
export default class MainAbility extends Ability {
data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {
if (err) {
console.info("Get the preferences failed, err: " + err)
return
}
preferences.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.") console.info("Flushed to file successfully.")
}) })
}) ```
}
```
### flush ### flush
...@@ -625,7 +474,7 @@ flush(): Promise<void> ...@@ -625,7 +474,7 @@ flush(): Promise<void>
将当前preferences对象中的修改保存到当前的preferences,并异步存储到首选项持久化文件中,该方法使用Promise方式作为异步方法。 将当前preferences对象中的修改保存到当前的preferences,并异步存储到首选项持久化文件中,该方法使用Promise方式作为异步方法。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -633,24 +482,14 @@ flush(): Promise<void> ...@@ -633,24 +482,14 @@ flush(): Promise<void>
| Promise<void> | Promise实例,用于异步处理。 | | Promise<void> | Promise实例,用于异步处理。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' let promise = preferences.flush()
import data_preferences from '@ohos.data.preferences' promise.then(() => {
export default class MainAbility extends Ability {
let promise = data_preferences.getPreferences(this.context, 'mystore')
promise.then((preferences) => {
let promiseFlush = preferences.flush()
promiseFlush.then(() => {
console.info("Flushed to file successfully.") console.info("Flushed to file successfully.")
}).catch((err) => { }).catch((err) => {
console.info("Flush to file failed, err: " + err) console.info("Flush to file failed, err: " + err)
}) })
}).catch((err) => { ```
console.info("Get the preferences failed, err: " + err)
})
}
```
### clear ### clear
...@@ -659,7 +498,7 @@ clear(callback: AsyncCallback<void>): void ...@@ -659,7 +498,7 @@ clear(callback: AsyncCallback<void>): void
清除此存储对象中的所有存储,该方法使用callback方式作为异步方法。 清除此存储对象中的所有存储,该方法使用callback方式作为异步方法。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -667,26 +506,15 @@ clear(callback: AsyncCallback<void>): void ...@@ -667,26 +506,15 @@ clear(callback: AsyncCallback<void>): void
| callback | AsyncCallback<void> | 是 | 回调函数。 | | callback | AsyncCallback<void> | 是 | 回调函数。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' preferences.clear(function (err) {
import data_preferences from '@ohos.data.preferences'
export default class MainAbility extends Ability {
data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {
if (err) {
console.info("Get the preferences failed, err: " + err)
return
}
preferences.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
} }
console.info("Cleared to file successfully.") console.info("Cleared to file successfully.")
}) })
}) ```
}
```
### clear ### clear
...@@ -695,7 +523,7 @@ clear(): Promise<void> ...@@ -695,7 +523,7 @@ clear(): Promise<void>
清除此存储对象中的所有存储,该方法使用Promise方式作为异步方法。 清除此存储对象中的所有存储,该方法使用Promise方式作为异步方法。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -703,24 +531,14 @@ clear(): Promise<void> ...@@ -703,24 +531,14 @@ clear(): Promise<void>
| Promise<void> | Promise实例,用于异步处理。 | | Promise<void> | Promise实例,用于异步处理。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' let promise = preferences.clear()
import data_preferences from '@ohos.data.preferences' promise.then(() => {
export default class MainAbility extends Ability {
let promise = data_preferences.getPreferences(this.context, 'mystore')
promise.then((preferences) => {
let promiseClear = preferences.clear()
promiseClear.then(() => {
console.info("Cleared to file successfully.") console.info("Cleared to file successfully.")
}).catch((err) => { }).catch((err) => {
console.info("Clear to file failed, err: " + err) console.info("Clear to file failed, err: " + err)
}) })
}).catch((err) => { ```
console.info("Get the preferences failed, err: " + err)
})
}
```
### on('change') ### on('change')
...@@ -729,7 +547,7 @@ on(type: 'change', callback: Callback<{ key : string }>): void ...@@ -729,7 +547,7 @@ on(type: 'change', callback: Callback<{ key : string }>): void
订阅数据变更者类,订阅的key的值发生变更后,在执行flush方法后,callback方法会被回调。 订阅数据变更者类,订阅的key的值发生变更后,在执行flush方法后,callback方法会被回调。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
...@@ -738,26 +556,21 @@ on(type: 'change', callback: Callback<{ key : string }>): void ...@@ -738,26 +556,21 @@ on(type: 'change', callback: Callback<{ key : string }>): void
| callback | Callback<{ key : string }> | 回调对象实例。 | | callback | Callback<{ key : string }> | 回调对象实例。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' var observer = function (key) {
import data_preferences from '@ohos.data.preferences'
export default class MainAbility extends Ability {
var observer = function (key) {
console.info("The key of " + key + " changed.") console.info("The key of " + key + " changed.")
} }
data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {
if (err) { ...
console.info("Get the preferences failed, err: " + err)
return preferences.on('change', observer)
} preferences.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.")
preferences.flush(function (err) { preferences.flush(function (err) {
if (err) { if (err) {
console.info("Flush to file failed, err: " + err) console.info("Flush to file failed, err: " + err)
...@@ -765,10 +578,8 @@ on(type: 'change', callback: Callback<{ key : string }>): void ...@@ -765,10 +578,8 @@ on(type: 'change', callback: Callback<{ key : string }>): void
} }
console.info("Flushed to file successfully.") // observer will be called. console.info("Flushed to file successfully.") // observer will be called.
}) })
}) })
}) ```
}
```
### off('change') ### off('change')
...@@ -777,7 +588,7 @@ off(type: 'change', callback: Callback<{ key : string }>): void ...@@ -777,7 +588,7 @@ off(type: 'change', callback: Callback<{ key : string }>): void
当不再进行订阅数据变更时,使用此接口取消订阅。 当不再进行订阅数据变更时,使用此接口取消订阅。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
...@@ -786,25 +597,21 @@ off(type: 'change', callback: Callback<{ key : string }>): void ...@@ -786,25 +597,21 @@ off(type: 'change', callback: Callback<{ key : string }>): void
| callback | Callback<{ key : string }> | 需要取消的回调对象实例。 | | callback | Callback<{ key : string }> | 需要取消的回调对象实例。 |
**示例:** **示例:**
```ts ```ts
import Ability from '@ohos.application.Ability' var observer = function (key) {
import data_preferences from '@ohos.data.preferences'
export default class MainAbility extends Ability {
var observer = function (key) {
console.info("The key of " + key + " changed.") console.info("The key of " + key + " changed.")
} }
data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {
if (err) { ...
console.info("Get the preferences failed, err: " + err)
return preferences.on('change', observer)
} preferences.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.")
preferences.flush(function (err) { preferences.flush(function (err) {
if (err) { if (err) {
console.info("Flush to file failed, err: " + err) console.info("Flush to file failed, err: " + err)
...@@ -813,16 +620,14 @@ off(type: 'change', callback: Callback<{ key : string }>): void ...@@ -813,16 +620,14 @@ off(type: 'change', callback: Callback<{ key : string }>): void
console.info("Flushed to file successfully.") // observer will be called. console.info("Flushed to file successfully.") // observer will be called.
preferences.off('change', observer) preferences.off('change', observer)
}) })
}) })
}) ```
}
```
## ValueType ## ValueType
用于表示允许的数据字段类型。 用于表示允许的数据字段类型。
**系统能力**SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
| 名称 | 说明 | | 名称 | 说明 |
| ------- | -------------------- | | ------- | -------------------- |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册