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

!4451 Update preferences getAll function , fix callback return value type and maxlength desc.

Merge pull request !4451 from PaDaBoo/master
...@@ -19,8 +19,8 @@ import data_preferences from '@ohos.data.preferences'; ...@@ -19,8 +19,8 @@ import data_preferences from '@ohos.data.preferences';
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| MAX_KEY_LENGTH | string | 是 | 否 | key的最大长度限制,大小为80字节。 | | MAX_KEY_LENGTH | string | 是 | 否 | key的最大长度限制,需小于80字节。 |
| MAX_VALUE_LENGTH | string | 是 | 否 | value的最大长度限制,大小为8192字节。 | | MAX_VALUE_LENGTH | string | 是 | 否 | value的最大长度限制,需小于8192字节。 |
## data_preferences.getPreferences ## data_preferences.getPreferences
...@@ -223,7 +223,7 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>): ...@@ -223,7 +223,7 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>):
**示例:** **示例:**
```ts ```ts
preferences.get('startup', 'default', function(err, value) { preferences.get('startup', 'default', function(err, value) {
if (err) { if (err) {
console.info("Get value of startup failed, err: " + err) console.info("Get value of startup failed, err: " + err)
return return
...@@ -262,6 +262,57 @@ promise.then((value) => { ...@@ -262,6 +262,57 @@ promise.then((value) => {
}) })
``` ```
### getAll
getAll(callback: AsyncCallback<Object>): void;
返回含有所有键值的Object对象。
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback<Object> | 是 | 回调函数。返回含有所有键值的Object对象。 |
**示例:**
```ts
preferences.get.getAll(function (err, value) {
if (err) {
console.info("getAll failed, err: " + err)
return
}
let keys = Object.keys(value)
console.info('getAll keys = ' + keys)
console.info("getAll object = " + JSON.stringify(value))
});
```
### getAll
getAll(): Promise<Object>
返回含有所有键值的Object对象。
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise<Object> | Promise对象。返回含有所有键值的Object对象。 |
**示例:**
```ts
let promise = preferences.getAll()
promise.then((value) => {
let keys = Object.keys(value)
console.info('getAll keys = ' + keys)
console.info("getAll object = " + JSON.stringify(value))
}).catch((err) => {
console.info("getAll failed, err: " + err)
})
```
### put ### put
...@@ -322,7 +373,7 @@ promise.then(() => { ...@@ -322,7 +373,7 @@ promise.then(() => {
### has ### has
has(key: string, callback: AsyncCallback<boolean>): boolean has(key: string, callback: AsyncCallback<boolean>): void
检查存储对象是否包含名为给定key的存储键值对,该方法使用callback方式作为异步方法。 检查存储对象是否包含名为给定key的存储键值对,该方法使用callback方式作为异步方法。
...@@ -332,12 +383,7 @@ has(key: string, callback: AsyncCallback<boolean>): boolean ...@@ -332,12 +383,7 @@ has(key: string, callback: AsyncCallback<boolean>): boolean
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| key | string | 是 | 要检查的存储key名称,不能为空。 | | key | string | 是 | 要检查的存储key名称,不能为空。 |
| callback | AsyncCallback<boolean> | 是 | 回调函数。 | | callback | AsyncCallback<boolean> | 是 | 回调函数。返回存储对象是否包含给定key的存储键值对,true表示存在,false表示不存在。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| boolean | true表示存在,false表示不存在。 |
**示例:** **示例:**
```ts ```ts
...@@ -371,7 +417,7 @@ has(key: string): Promise<boolean> ...@@ -371,7 +417,7 @@ has(key: string): Promise<boolean>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise<boolean> | Promise实例,用于异步处理。 | | Promise<boolean> | Promise对象。返回存储对象是否包含给定key的存储键值对,true表示存在,false表示不存在。 |
**示例:** **示例:**
```ts ```ts
...@@ -550,10 +596,10 @@ on(type: 'change', callback: Callback<{ key : string }>): void ...@@ -550,10 +596,10 @@ on(type: 'change', callback: Callback<{ key : string }>): void
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 事件类型,固定值'change',表示数据变更。 | | type | string | 是 | 事件类型,固定值'change',表示数据变更。 |
| callback | Callback<{ key : string }> | 回调对象实例。 | | callback | Callback<{ key : string }> | 是| 回调对象实例。 |
**示例:** **示例:**
```ts ```ts
...@@ -584,17 +630,17 @@ preferences.put('startup', 'auto', function (err) { ...@@ -584,17 +630,17 @@ preferences.put('startup', 'auto', function (err) {
### off('change') ### off('change')
off(type: 'change', callback: Callback<{ key : string }>): void off(type: 'change', callback?: Callback<{ key : string }>): void
当不再进行订阅数据变更时,使用此接口取消订阅。 当不再进行订阅数据变更时,使用此接口取消订阅。
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:** **参数:**
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 事件类型,固定值'change',表示数据变更。 | | type | string | 是 | 事件类型,固定值'change',表示数据变更。 |
| callback | Callback<{ key : string }> | 需要取消的回调对象实例。 | | callback | Callback<{ key : string }> | 否| 需要取消的回调对象实例,不填则全部取消。 |
**示例:** **示例:**
```ts ```ts
......
...@@ -22,8 +22,8 @@ import dataStorage from '@ohos.data.storage'; ...@@ -22,8 +22,8 @@ import dataStorage from '@ohos.data.storage';
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| MAX_KEY_LENGTH | string | 是 | 否 | key的最大长度限制,大小为80字节。 | | MAX_KEY_LENGTH | string | 是 | 否 | key的最大长度限制,需小于80字节。 |
| MAX_VALUE_LENGTH | string | 是 | 否 | value的最大长度限制,大小为8192字节。 | | MAX_VALUE_LENGTH | string | 是 | 否 | value的最大长度限制,需小于8192字节。 |
## dataStorage.getStorageSync ## dataStorage.getStorageSync
......
...@@ -68,7 +68,7 @@ set(Object): void ...@@ -68,7 +68,7 @@ set(Object): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| key | string | 是 | 要修改的存储值的索引。 | | key | string | 是 | 要修改的存储值的索引。 |
| value | string | 是 | 新值。最大长度128。 | | value | string | 是 | 新值。长度需小于128字节。 |
| success | Function | 否 | 接口调用成功的回调函数。 | | success | Function | 否 | 接口调用成功的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数,data为错误信息,code为错误码。 | | fail | Function | 否 | 接口调用失败的回调函数,data为错误信息,code为错误码。 |
| complete | Function | 否 | 接口调用结束的回调函数。 | | complete | Function | 否 | 接口调用结束的回调函数。 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册