提交 06292a1b 编写于 作者: J jiangbo

jiangbo91@huawei.com

local_storage开发文档
Signed-off-by: Njiangbo <jiangbo91@huawei.com>
Change-Id: Idfd8f68d29652462ba042ed5941dc555da3902a2
上级 dc324577
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
![icon-note.gif](https://gitee.com/BoJiang4702/docs/raw/master/zh-cn/application-dev/reference/arkui-ts/public_sys-resources/icon-note.gif) **说明:** 该组件从API version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ![icon-note.gif](https://gitee.com/BoJiang4702/docs/raw/master/zh-cn/application-dev/reference/arkui-ts/public_sys-resources/icon-note.gif) **说明:** 该组件从API version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
LocalStorage是应用程序中的存储单元,它的生命周期跟随其关联的Ability。且LocalStorage为应用程序范围内的可变状态属性和非可变状态属性提供存储,可变状态属性和非可变状态属性是构建应用程序UI的一部分。如一个Ability的UI。 LocalStorage是应用程序中的存储单元,生命周期跟随其关联的Ability。LocalStorage为应用程序范围内的可变状态属性和非可变状态属性提供存储,可变状态属性和非可变状态属性是构建应用程序UI的一部分,如一个Ability的UI。
应用层:一个应用程序可以创建多个LocalStorage实例,应用程序的每一个Ability对应一个LocalStorage实例。 应用层:一个应用程序可以创建多个LocalStorage实例,应用程序的每一个Ability对应一个LocalStorage实例。
...@@ -22,7 +22,7 @@ Ability: 一个应用程序可以拥有多个Ability,一个Ability中的所 ...@@ -22,7 +22,7 @@ Ability: 一个应用程序可以拥有多个Ability,一个Ability中的所
## LocalStorage接口 ## LocalStorage接口
### Constructor ### constructor
constructor(initializingProperties?: Object) constructor(initializingProperties?: Object)
...@@ -118,17 +118,15 @@ get<T>(propName: string): T ...@@ -118,17 +118,15 @@ get<T>(propName: string): T
### Link ### Link
link<T>(propName: string, linkUser?: T, subscribersName?: string): T link<T>(propName: string): T
与localStorage双向数据绑定。 与localStorage双向数据绑定。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 类型 | 必填 | 默认值 | 参数描述 |
| --------------- | ------ | :--: | ------ | ---------------------- | | -------- | ------ | :--: | ------ | ---------------------- |
| propName | string | 是 | - | 要双向绑定的属性名称。 | | propName | string | 是 | - | 要双向绑定的属性名称。 |
| linkUser | T | 否 | - | 无 |
| subscribersName | string | 否 | - | 无 |
**返回值:** **返回值:**
...@@ -140,18 +138,16 @@ get<T>(propName: string): T ...@@ -140,18 +138,16 @@ get<T>(propName: string): T
### SetAndLink ### SetAndLink
setAndLink<T>(propName: string, defaultValue: T, linkUser?: T, subscribersName?: string): T setAndLink<T>(propName: string, defaultValue: T): T
与link接口类似,双向数据绑定localStorage。 与link接口类似,双向数据绑定localStorage。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 类型 | 必填 | 默认值 | 参数描述 |
| --------------- | ------ | :--: | ------ | ----------------------- | | ------------ | ------ | :--: | ------ | ----------------------- |
| propName | string | 是 | - | 传入要进行创建的key值。 | | propName | string | 是 | - | 传入要进行创建的key值。 |
| defaultValue | T | 是 | - | 要进行设置的默认值。 | | defaultValue | T | 是 | - | 要进行设置的默认值。 |
| linkUser | T | 否 | - | 无 |
| subscribersName | string | 否 | - | 无 |
**返回值:** **返回值:**
...@@ -163,40 +159,36 @@ get<T>(propName: string): T ...@@ -163,40 +159,36 @@ get<T>(propName: string): T
### Prop ### Prop
prop<T>(propName: string, propUser?: T, subscribersName?: string): T prop<T>(propName: string): T
单向属性绑定的一种。更新组件的状态。 单向属性绑定的一种。更新组件的状态。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 类型 | 必填 | 默认值 | 参数描述 |
| --------------- | ------ | :--: | ------ | --------------------------- | | -------- | ------ | :--: | ------ | --------------------------- |
| propName | string | 是 | - | 传入要单向数据绑定的key值。 | | propName | string | 是 | - | 传入要单向数据绑定的key值。 |
| propUser | T | 否 | - | 无 |
| subscribersName | string | 否 | - | 无 |
**返回值:** **返回值:**
| 类型 | 描述 | | 类型 | 描述 |
| ----- | ------------------------------------------------------------ | | ------------------------------------ | ------------------------------------------------------------ |
| @Prop | 如果存在具有给定键的属性,返回此属性的单向数据绑定。该单向绑定意味着只能通过LocalStorage将属性的更改同步到变量或组件。该方法返回的变量为不可变变量,适用于可变和不可变的状态变量。如果此键的属性不存在则返回undefined。 | | [@Prop](ts-component-states-prop.md) | 如果存在具有给定键的属性,返回此属性的单向数据绑定。该单向绑定意味着只能通过LocalStorage将属性的更改同步到变量或组件。该方法返回的变量为不可变变量,适用于可变和不可变的状态变量。如果此键的属性不存在则返回undefined。 |
### SetAndProp ### SetAndProp
setAndProp<T>(propName: string, defaultValue: T, propUser?: T, subscribersName?: string): T setAndProp<T>(propName: string, defaultValue: T): T
与Prop接口类似,存在localStorage的单向数据绑定prop值 与Prop接口类似,存在localStorage的单向数据绑定prop值
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 类型 | 必填 | 默认值 | 参数描述 |
| --------------- | ------ | :--: | ------ | --------------------------- | | ------------ | ------ | :--: | ------ | --------------------------- |
| propName | string | 是 | - | 要保存的的键值对中的key值。 | | propName | string | 是 | - | 要保存的的键值对中的key值。 |
| defaultValue | S | 是 | - | 创建的默认值。 | | defaultValue | S | 是 | - | 创建的默认值。 |
| propUser | T | 否 | - | 无 |
| subscribersName | string | 否 | - | 无 |
**返回值:** **返回值:**
...@@ -266,7 +258,7 @@ clear(): boolean ...@@ -266,7 +258,7 @@ clear(): boolean
| ------- | ------------------------------------------------------------ | | ------- | ------------------------------------------------------------ |
| boolean | 删除所有的属性,如果当前有状态变量依旧引用此属性,返回false。 | | boolean | 删除所有的属性,如果当前有状态变量依旧引用此属性,返回false。 |
### 示例1(在一个Ability创建的LocalStorage): ### 示例1(在一个Ability创建的LocalStorage)
```javascript ```javascript
import Ability from '@ohos.appLication.Ability' import Ability from '@ohos.appLication.Ability'
...@@ -296,7 +288,7 @@ export default class MainAbility extends Ability { ...@@ -296,7 +288,7 @@ export default class MainAbility extends Ability {
} }
``` ```
@Component组件获取数据 @Component组件获取数据
``` ```
let storage = LocalStorage.GetShared() let storage = LocalStorage.GetShared()
...@@ -318,7 +310,7 @@ struct LocalStorageComponent { ...@@ -318,7 +310,7 @@ struct LocalStorageComponent {
} }
``` ```
### 示例2(在Entry页面定义LocalStorage): ### 示例2(在Entry页面定义LocalStorage)
``` ```
let storage = new LocalStorage({"PropA":47}); let storage = new LocalStorage({"PropA":47});
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册