Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 ece5ce93 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!1749 修改系统能力标识和版本支持标识 

Merge pull request !1749 from PaDaBoo/master
上级 e6c0532f 73c82ebe
隐藏空白更改
内联 并排
Showing with 62 addition and 47 deletion
zh-cn/application-dev/reference/apis/js-apis-data-preferences.md
浏览文件 @ ece5ce93
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
...@@ -23,13 +23,13 @@ import data_Preferences from '@ohos.data.preferences' ...@@ -23,13 +23,13 @@ import data_Preferences from '@ohos.data.preferences'
## data_Preferences.getPreferences ## data_Preferences.getPreferences
### 系统能力
SystemCapability.DistributedDataManager.Preferences.Core
getPreferences(context: Context, name: string, callback: AsyncCallback<Preferences>): void getPreferences(context: Context, name: string, callback: AsyncCallback<Preferences>): void
读取指定文件，将数据加载到Preferences实例，用于数据操作，使用callback形式返回结果。 读取指定文件，将数据加载到Preferences实例，用于数据操作，使用callback形式返回结果。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 参数： - 参数：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -55,13 +55,13 @@ getPreferences(context: Context, name: string, callback: AsyncCallback<Prefer ...@@ -55,13 +55,13 @@ getPreferences(context: Context, name: string, callback: AsyncCallback<Prefer
## data_Preferences.getPreferences ## data_Preferences.getPreferences
### 系统能力
SystemCapability.DistributedDataManager.Preferences.Core
getPreferences(context: Context, name: string): Promise<Preferences> getPreferences(context: Context, name: string): Promise<Preferences>
读取指定文件，将数据加载到Preferences实例，用于数据操作，使用Promise方式作为异步方法。 读取指定文件，将数据加载到Preferences实例，用于数据操作，使用Promise方式作为异步方法。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 参数： - 参数：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -90,13 +90,13 @@ getPreferences(context: Context, name: string): Promise<Preferences> ...@@ -90,13 +90,13 @@ getPreferences(context: Context, name: string): Promise<Preferences>
## data_Preferences.deletePreferences ## data_Preferences.deletePreferences
### 系统能力
SystemCapability.DistributedDataManager.Preferences.Core
deletePreferences(context: Context, name: string, callback: AsyncCallback<void>) deletePreferences(context: Context, name: string, callback: AsyncCallback<void>)
从内存中移除指定文件对应的Preferences单实例，并删除指定文件及其备份文件、损坏文件。删除指定文件时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，使用callback方式作为异步方法。 从内存中移除指定文件对应的Preferences单实例，并删除指定文件及其备份文件、损坏文件。删除指定文件时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，使用callback方式作为异步方法。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 参数： - 参数：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -120,13 +120,13 @@ deletePreferences(context: Context, name: string, callback: AsyncCallback<voi ...@@ -120,13 +120,13 @@ deletePreferences(context: Context, name: string, callback: AsyncCallback<voi
## data_Preferences.deletePreferences ## data_Preferences.deletePreferences
### 系统能力
SystemCapability.DistributedDataManager.Preferences.Core
deletePreferences(context: Context, name: string): Promise<void> deletePreferences(context: Context, name: string): Promise<void>
从内存中移除指定文件对应的Preferences单实例，并删除指定文件及其备份文件、损坏文件。删除指定文件时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，使用promise方式作为异步方法。 从内存中移除指定文件对应的Preferences单实例，并删除指定文件及其备份文件、损坏文件。删除指定文件时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，使用promise方式作为异步方法。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 参数： - 参数：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -153,15 +153,15 @@ deletePreferences(context: Context, name: string): Promise<void> ...@@ -153,15 +153,15 @@ deletePreferences(context: Context, name: string): Promise<void>
## data_Preferences.removePreferencesFromCache ## data_Preferences.removePreferencesFromCache
### 系统能力
SystemCapability.DistributedDataManager.Preferences.Core
removePreferencesFromCache(context: Context, name: string, callback: AsyncCallback<Preferences>): void removePreferencesFromCache(context: Context, name: string, callback: AsyncCallback<Preferences>): void
从内存中移除指定文件对应的Preferences单实例。移除Preferences单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题。 从内存中移除指定文件对应的Preferences单实例。移除Preferences单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题。
此方法为异步方法。 此方法为异步方法。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 参数： - 参数：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -185,14 +185,15 @@ removePreferencesFromCache(context: Context, name: string, callback: AsyncCallba ...@@ -185,14 +185,15 @@ removePreferencesFromCache(context: Context, name: string, callback: AsyncCallba
## data_Preferences.removePreferencesFromCache ## data_Preferences.removePreferencesFromCache
### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
removePreferencesFromCache(context: Context, name: string): Promise<void> removePreferencesFromCache(context: Context, name: string): Promise<void>
从内存中移除指定文件对应的Preferences单实例。移除Preferences单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题。 从内存中移除指定文件对应的Preferences单实例。移除Preferences单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题。
此方法为异步方法。 此方法为异步方法。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 参数： - 参数：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -224,14 +225,15 @@ removePreferencesFromCache(context: Context, name: string): Promise<void> ...@@ -224,14 +225,15 @@ removePreferencesFromCache(context: Context, name: string): Promise<void>
### get ### get
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>): void get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>): void
获取键对应的值，如果值为null或者非默认值类型，返回默认数据。 获取键对应的值，如果值为null或者非默认值类型，返回默认数据。
此方法为异步方法。 此方法为异步方法。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 参数： - 参数：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -253,14 +255,15 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>): ...@@ -253,14 +255,15 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>):
### get ### get
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
get(key: string, defValue: ValueType): Promise<ValueType> get(key: string, defValue: ValueType): Promise<ValueType>
获取键对应的值，如果值为null或者非默认值类型，返默认数据。 获取键对应的值，如果值为null或者非默认值类型，返默认数据。
此方法为异步方法。 此方法为异步方法。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- **参数：** - **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -285,14 +288,15 @@ get(key: string, defValue: ValueType): Promise<ValueType> ...@@ -285,14 +288,15 @@ get(key: string, defValue: ValueType): Promise<ValueType>
### put ### put
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
put(key: string, value: ValueType, callback: AsyncCallback<void>): void put(key: string, value: ValueType, callback: AsyncCallback<void>): void
首先获取指定文件对应的Preferences实例，然后借助Preferences API将数据写入Preferences实例，通过flush或者flushSync将Preferences实例持久化。 首先获取指定文件对应的Preferences实例，然后借助Preferences API将数据写入Preferences实例，通过flush或者flushSync将Preferences实例持久化。
此方法为异步方法。 此方法为异步方法。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 参数： - 参数：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -314,14 +318,15 @@ put(key: string, value: ValueType, callback: AsyncCallback<void>): void ...@@ -314,14 +318,15 @@ put(key: string, value: ValueType, callback: AsyncCallback<void>): void
### put ### put
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
put(key: string, value: ValueType): Promise<void> put(key: string, value: ValueType): Promise<void>
首先获取指定文件对应的Preferences实例，然后借助Preferences API将数据写入Preferences实例，通过flush或者flushSync将Preferences实例持久化。 首先获取指定文件对应的Preferences实例，然后借助Preferences API将数据写入Preferences实例，通过flush或者flushSync将Preferences实例持久化。
此方法为异步方法。 此方法为异步方法。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 参数： - 参数：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -346,14 +351,15 @@ put(key: string, value: ValueType): Promise<void> ...@@ -346,14 +351,15 @@ put(key: string, value: ValueType): Promise<void>
### has ### has
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
has(key: string, callback: AsyncCallback<boolean>): boolean has(key: string, callback: AsyncCallback<boolean>): boolean
检查存储对象是否包含名为给定key的存储。 检查存储对象是否包含名为给定key的存储。
此方法为异步方法。 此方法为异步方法。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 参数： - 参数：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -381,14 +387,15 @@ has(key: string, callback: AsyncCallback<boolean>): boolean ...@@ -381,14 +387,15 @@ has(key: string, callback: AsyncCallback<boolean>): boolean
### has ### has
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
has(key: string): Promise<boolean> has(key: string): Promise<boolean>
检查存储对象是否包含名为给定key的存储。 检查存储对象是否包含名为给定key的存储。
此方法为异步方法。 此方法为异步方法。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 参数： - 参数：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -414,14 +421,15 @@ has(key: string): Promise<boolean> ...@@ -414,14 +421,15 @@ has(key: string): Promise<boolean>
### delete ### delete
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
delete(key: string, callback: AsyncCallback<void>): void delete(key: string, callback: AsyncCallback<void>): void
从存储对象中删除名为给定key的存储。 从存储对象中删除名为给定key的存储。
此方法为异步方法。 此方法为异步方法。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 参数： - 参数：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -442,14 +450,15 @@ delete(key: string, callback: AsyncCallback<void>): void ...@@ -442,14 +450,15 @@ delete(key: string, callback: AsyncCallback<void>): void
### delete ### delete
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
delete(key: string): Promise<void> delete(key: string): Promise<void>
从存储对象删除名为给定key的存储。 从存储对象删除名为给定key的存储。
此方法为异步方法。 此方法为异步方法。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 参数： - 参数：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -473,14 +482,15 @@ delete(key: string): Promise<void> ...@@ -473,14 +482,15 @@ delete(key: string): Promise<void>
### flush ### flush
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
flush(callback: AsyncCallback<void>): void flush(callback: AsyncCallback<void>): void
将当前preferences对象中的修改保存到当前的preferences，并异步存储到文件中。 将当前preferences对象中的修改保存到当前的preferences，并异步存储到文件中。
此方法为异步方法。 此方法为异步方法。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 参数： - 参数：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -500,14 +510,15 @@ flush(callback: AsyncCallback<void>): void ...@@ -500,14 +510,15 @@ flush(callback: AsyncCallback<void>): void
### flush ### flush
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
flush(): Promise<void> flush(): Promise<void>
将当前preferences对象中的修改保存到当前的preferences，并异步存储到文件中。 将当前preferences对象中的修改保存到当前的preferences，并异步存储到文件中。
此方法为异步方法。 此方法为异步方法。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 返回值： - 返回值：
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
...@@ -526,14 +537,15 @@ flush(): Promise<void> ...@@ -526,14 +537,15 @@ flush(): Promise<void>
### clear ### clear
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
clear(callback: AsyncCallback<void>): void clear(callback: AsyncCallback<void>): void
清除此存储对象中的所有存储。 清除此存储对象中的所有存储。
此方法为异步方法。 此方法为异步方法。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 参数： - 参数：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -553,14 +565,15 @@ clear(callback: AsyncCallback<void>): void ...@@ -553,14 +565,15 @@ clear(callback: AsyncCallback<void>): void
### clear ### clear
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
clear(): Promise<void> clear(): Promise<void>
清除此存储对象中的所有存储。 清除此存储对象中的所有存储。
此方法为异步方法。 此方法为异步方法。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 返回值： - 返回值：
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
...@@ -579,12 +592,13 @@ clear(): Promise<void> ...@@ -579,12 +592,13 @@ clear(): Promise<void>
### on('change') ### on('change')
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
on(type: 'change', callback: Callback<{ key : string }>): void on(type: 'change', callback: Callback<{ key : string }>): void
订阅数据变更者类，订阅的key的值发生变更后，在执行flush方法后，callback方法会被回调。 订阅数据变更者类，订阅的key的值发生变更后，在执行flush方法后，callback方法会被回调。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 参数： - 参数：
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
...@@ -604,12 +618,13 @@ on(type: 'change', callback: Callback<{ key : string }>): void ...@@ -604,12 +618,13 @@ on(type: 'change', callback: Callback<{ key : string }>): void
### off('change') ### off('change')
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
off(type: 'change', callback: Callback<{ key : string }>): void off(type: 'change', callback: Callback<{ key : string }>): void
当不再进行订阅数据变更时，使用此接口取消订阅。 当不再进行订阅数据变更时，使用此接口取消订阅。
### 系统能力###
SystemCapability.DistributedDataManager.Preferences.Core
- 参数： - 参数：
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
......
zh-cn/application-dev/reference/apis/js-apis-data-storage.md
浏览文件 @ ece5ce93
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 从API Version 8开始，该接口不再维护，推荐使用新接口 [@ohos.data.preferences](js-apis-data-preferences.md) > 从API Version 9开始，该接口不再维护，推荐使用新接口 [@ohos.data.preferences](js-apis-data-preferences.md)
## 导入模块 ## 导入模块
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或