提交 78c56283 编写于 作者: A Annie_wang

update docs

Signed-off-by: NAnnie_wang <annie.wangli@huawei.com>
上级 e2b5da8b
...@@ -271,10 +271,10 @@ Creates a **KVManager** instance to manage KV stores. ...@@ -271,10 +271,10 @@ Creates a **KVManager** instance to manage KV stores.
Stage model: Stage model:
```js ```js
import AbilityStage from '@ohos.application.Ability' import UIAbility from '@ohos.app.ability.UIAbility'
let kvManager; let kvManager;
export default class MyAbilityStage extends AbilityStage { export default class EntryAbility extends UIAbility {
onCreate() { onCreate() {
console.log("MyAbilityStage onCreate") console.log("MyAbilityStage onCreate")
let context = this.context let context = this.context
...@@ -2847,7 +2847,7 @@ try { ...@@ -2847,7 +2847,7 @@ try {
### get ### get
get(key: string, callback: AsyncCallback<boolean | string| number | Uint8Array>): void get(key: string, callback: AsyncCallback&lt;boolean | string | number | Uint8Array&gt;): void
Obtains the value of the specified key. This API uses an asynchronous callback to return the result. Obtains the value of the specified key. This API uses an asynchronous callback to return the result.
...@@ -2898,7 +2898,7 @@ try { ...@@ -2898,7 +2898,7 @@ try {
### get ### get
get(key: string): Promise&lt;boolean | string| number | Uint8Array&gt; get(key: string): Promise&lt;boolean | string | number | Uint8Array&gt;
Obtains the value of the specified key. This API uses a promise to return the result. Obtains the value of the specified key. This API uses a promise to return the result.
...@@ -4849,7 +4849,7 @@ Before calling any method in **DeviceKVStore**, you must use [getKVStore](#getkv ...@@ -4849,7 +4849,7 @@ Before calling any method in **DeviceKVStore**, you must use [getKVStore](#getkv
### get ### get
get(key: string, callback: AsyncCallback<boolean | string| number | Uint8Array>): void get(key: string, callback: AsyncCallback&lt;boolean | string | number | Uint8Array&gt;): void
Obtains the value of the specified key for this device. This API uses an asynchronous callback to return the result. Obtains the value of the specified key for this device. This API uses an asynchronous callback to return the result.
...@@ -4900,7 +4900,7 @@ try { ...@@ -4900,7 +4900,7 @@ try {
### get ### get
get(key: string): Promise&lt;boolean | string| number | Uint8Array&gt; get(key: string): Promise&lt;boolean | string | number | Uint8Array&gt;
Obtains the value of the specified key for this device. This API uses a promise to return the result. Obtains the value of the specified key for this device. This API uses a promise to return the result.
...@@ -4952,7 +4952,7 @@ try { ...@@ -4952,7 +4952,7 @@ try {
### get ### get
get(deviceId: string, key: string, callback: AsyncCallback&lt;boolean|string|number|Uint8Array&gt;): void get(deviceId: string, key: string, callback: AsyncCallback&lt;boolean | string | number | Uint8Array&gt;): void
Obtains a string value that matches the specified device ID and key. This API uses an asynchronous callback to return the result. Obtains a string value that matches the specified device ID and key. This API uses an asynchronous callback to return the result.
...@@ -5004,7 +5004,7 @@ try { ...@@ -5004,7 +5004,7 @@ try {
### get ### get
get(deviceId: string, key: string): Promise&lt;boolean|string|number|Uint8Array&gt; get(deviceId: string, key: string): Promise&lt;boolean | string | number | Uint8Array&gt;
Obtains a string value that matches the specified device ID and key. This API uses a promise to return the result. Obtains a string value that matches the specified device ID and key. This API uses a promise to return the result.
......
# @system.storage (Data Storage) # @system.storage (Data Storage)
> **NOTE**<br/> > **NOTE**
> >
> - The APIs of this module are no longer maintained since API Version 6, and you are advised to use [`@ohos.data.storage`](js-apis-data-storage.md). From API Version 9, you are advised to use [`@ohos.data.preferences`](js-apis-data-preferences.md). > - The APIs of this module are no longer maintained since API version 6, and you are advised to use [`@ohos.data.storage`](js-apis-data-storage.md). From API version 9, you are advised to use [`@ohos.data.preferences`](js-apis-data-preferences.md).
> >
> - The initial APIs of this module are supported since API version 3. Newly added APIs will be marked with a superscript to indicate their earliest API version. > - The initial APIs of this module are supported since API version 3. Newly added APIs will be marked with a superscript to indicate their earliest API version.
>
> - The APIs of this module can be used only in the FA model. > - The APIs of this module can be used only in the FA model.
## Modules to Import ## Modules to Import
```js ```js
import storage from '@system.storage'; import storage from '@system.storage';
``` ```
## storage.get ## storage.get
get(Object): void get(options: GetStorageOptions): void
Reads the value stored in the cache based on the specified key. Reads the value stored in the cache based on the specified key.
...@@ -25,13 +24,9 @@ Reads the value stored in the cache based on the specified key. ...@@ -25,13 +24,9 @@ Reads the value stored in the cache based on the specified key.
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| -------- | -------- | -------- | -------- | | ------- | -------------------- | ---- | ---------- |
| key | string | Yes| Key of the data to read.| | options | [GetStorageOptions](#getstorageoptions) | Yes | API configuration.|
| default | string | No| Default value returned when the **key** does not exist.|
| success | Function | No| Called to return the value obtained when **storage.get()** is successful.|
| fail | Function | No| Called when **storage.get()** fails. In the callback, **data** indicates the error information, and **code** indicates the error code.|
| complete | Function | No| Called when **storage.get()** is complete.|
**Example** **Example**
...@@ -54,10 +49,9 @@ export default { ...@@ -54,10 +49,9 @@ export default {
} }
``` ```
## storage.set ## storage.set
set(Object): void set(options: SetStorageOptions): void
Sets the value in the cache based on the specified key. Sets the value in the cache based on the specified key.
...@@ -65,13 +59,9 @@ Sets the value in the cache based on the specified key. ...@@ -65,13 +59,9 @@ Sets the value in the cache based on the specified key.
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| -------- | -------- | -------- | -------- | | ------- | ------------------- | ---- | ---------- |
| key | string | Yes| Key of the data to set.| | options | [SetStorageOptions](#setstorageoptions) | Yes | API configuration.|
| value | string | Yes| New value to set. The length must be less than 128 bytes.|
| success | Function | No| Called when **storage.set()** is successful.|
| fail | Function | No| Called when **storage.set()** fails. In the callback, **data** indicates the error information, and **code** indicates the error code.|
| complete | Function | No| Called when **storage.set()** is complete.|
**Example** **Example**
...@@ -92,10 +82,9 @@ export default { ...@@ -92,10 +82,9 @@ export default {
} }
``` ```
## storage.clear ## storage.clear
clear(Object): void clear(options?: ClearStorageOptions): void
Clears the key-value pairs from the cache. Clears the key-value pairs from the cache.
...@@ -103,11 +92,9 @@ Clears the key-value pairs from the cache. ...@@ -103,11 +92,9 @@ Clears the key-value pairs from the cache.
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| -------- | -------- | -------- | -------- | | ------- | ------------------------------------------- | ---- | -------------- |
| success | Function | No| Called when **storage.clear()** is successful.| | options | [ClearStorageOptions](#clearstorageoptions) | No | API configuration.|
| fail | Function | No| Called when **storage.clear()** fails. In the callback, **data** indicates the error information, and **code** indicates the error code.|
| complete | Function | No| Called when **storage.clear()** is complete.|
**Example** **Example**
...@@ -126,10 +113,9 @@ export default { ...@@ -126,10 +113,9 @@ export default {
} }
``` ```
## storage.delete ## storage.delete
delete(Object): void delete(options: DeleteStorageOptions): void
Deletes the key-value pair based on the specified key. Deletes the key-value pair based on the specified key.
...@@ -137,12 +123,9 @@ Deletes the key-value pair based on the specified key. ...@@ -137,12 +123,9 @@ Deletes the key-value pair based on the specified key.
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| -------- | -------- | -------- | -------- | | ------- | --------------------------------------------- | ---- | -------------- |
| key | string | Yes| Key of the data to delete.| | options | [DeleteStorageOptions](#deletestorageoptions) | Yes | API configuration.|
| success | Function | No| Called when **storage.delete()** is successful.|
| fail | Function | No| Called when **storage.delete()** fails. In the callback, **data** indicates the error information, and **code** indicates the error code.|
| complete | Function | No| Called when **storage.delete()** is complete.|
**Example** **Example**
...@@ -161,3 +144,52 @@ export default { ...@@ -161,3 +144,52 @@ export default {
} }
} }
``` ```
## GetStorageOptions
**System capability**: SystemCapability.DistributedDataManager.Preferences.Core
| Name | Type | Mandatory| Description |
| -------- | ---------------- | ---- | ------------------- |
| key | string | Yes | Key of the target data. |
| default | string | No | Default value returned when the specified key does not exist. |
| success | (data: any) => void | No | Called to return the result when **storage.get()** is called successfully. **data** is the value indexed by the specified key. |
| fail | (data: string, code: number) => void | No | Called to return the result when **storage.get()** fails to be called. **data** is the error information, and **code** indicates the error code. |
| complete | () => void | No | Called when **storage.get()** is complete. |
## SetStorageOptions
**System capability**: SystemCapability.DistributedDataManager.Preferences.Core
| Name | Type | Mandatory| Description |
| -------- | ------------------- | ---- | -------------------- |
| key | string | Yes | Key of the data to set. |
| value | string | Yes | New value to set. The length must be less than 128 bytes. |
| success | () => void | No | Called when **storage.set()** is called successfully. |
| fail | (data: string, code: number) => void | No | Called to return the result when **storage.set()** fails to be called. **data** is the error information, and **code** indicates the error code. |
| complete | () => void | No | Called when **storage.set()** is complete. |
## ClearStorageOptions
**System capability**: SystemCapability.DistributedDataManager.Preferences.Core
| Name | Type | Mandatory| Description |
| -------- | --------------------- | ---- | -------------------- |
| success | () => void | No | Called when **storage.clear()** is called successfully. |
| fail | (data: string, code: number) => void | No | Called to return the result when **storage.clear()** fails to be called. **data** is the error information, and **code** indicates the error code. |
| complete | () => void | No | Called when **storage.clear()** is complete. |
## DeleteStorageOptions
**System capability**: SystemCapability.DistributedDataManager.Preferences.Core
| Name | Type | Mandatory| Description |
| -------- | -------------------- | ---- | ------------------ |
| key | string | Yes | Key of the data to delete. |
| success | () => void | No | Called when **storage.delete()** is called successfully. |
| fail | (data: string, code: number) => void | No | Called to return the result when **storage.delete()** fails to be called. **data** is the error information, and **code** indicates the error code. |
| complete | () => void | No | Called when **storage.delete()** is complete. |
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册