应用级变量的状态管理

状态管理模块提供了应用程序的数据存储能力、持久化数据管理能力、UIAbility数据存储能力和应用程序需要的环境状态。

说明：

本模块首批接口从API version 7开始支持，后续版本的新增接口，采用上角标单独标记接口的起始版本。

本文中T和S的含义如下：

类型	描述
T	Class，number，boolean，string和这些类型的数组形式。
S	number，boolean，string。

AppStorage

AppStorage具体UI使用说明，详见AppStorage(应用全局的UI状态存储)

link¹⁰⁺

static link<T>(propName: string): SubscribedAbstractProperty<T>

与AppStorage中对应的propName建立双向数据绑定。如果给定的propName在AppStorage中存在，返回AppStorage中propName对应属性的双向绑定数据。

双向绑定数据的修改会同步回AppStorage中，AppStorage会将变化同步到所有绑定该propName的数据和自定义组件中。

如果AppStorage中不存在propName，则返回undefined。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。

返回值：

类型	描述
SubscribedAbstractProperty<T>	返回双向绑定的数据，如果AppStorage中不存在对应的propName，则返回undefined。

示例：

AppStorage.setOrCreate('PropA', 47);
let linkToPropA1: SubscribedAbstractProperty<number> = AppStorage.link('PropA');
let linkToPropA2: SubscribedAbstractProperty<number> = AppStorage.link('PropA'); // linkToPropA2.get() == 47
linkToPropA1.set(48); // 双向同步: linkToPropA1.get() == linkToPropA2.get() == 48

setAndLink¹⁰⁺

static setAndLink<T>(propName: string, defaultValue: T): SubscribedAbstractProperty<T>

与link接口类似，如果给定的propName在AppStorage中存在，则返回该propName对应的属性的双向绑定数据。如果不存在，则使用defaultValue在AppStorage中创建和初始化propName对应的属性，返回其双向绑定数据。defaultValue必须为T类型，且不能为undefined或null。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。
defaultValue	T	是	当propName在AppStorage中不存在时，使用defaultValue在AppStorage中初始化对应的propName，defaultValue不能为undefined或null。

返回值：

类型	描述
SubscribedAbstractProperty<T>	SubscribedAbstractProperty<T>的实例，和AppStorage中propName对应属性的双向绑定的数据。

示例：

AppStorage.setOrCreate('PropA', 47);
let link1: SubscribedAbstractProperty<number> = AppStorage.setAndLink('PropB', 49); // Create PropB 49
let link2: SubscribedAbstractProperty<number> = AppStorage.setAndLink('PropA', 50); // PropA exists, remains 47

prop¹⁰⁺

static prop<T>(propName: string): SubscribedAbstractProperty<T>

与AppStorage中对应的propName建立单向属性绑定。如果给定的propName在AppStorage中存在，则返回与AppStorage中propName对应属性的单向绑定数据。如果AppStorage中不存在propName，则返回undefined。单向绑定数据的修改不会被同步回AppStorage中。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。

返回值：

类型	描述
SubscribedAbstractProperty<T>	返回单向绑定的数据，如果AppStorage中不存在对应的propName，则返回undefined。

示例：

AppStorage.setOrCreate('PropA', 47);
let prop1: SubscribedAbstractProperty<number> = AppStorage.prop('PropA');
let prop2: SubscribedAbstractProperty<number> = AppStorage.prop('PropA');
prop1.set(1); // one-way sync: prop1.get()=1; but prop2.get() == 47

setAndProp¹⁰⁺

static setAndProp<T>(propName: string, defaultValue: T): SubscribedAbstractProperty<T>

与prop接口类似。如果给定的propName在AppStorage中存在，则返回该propName对应的属性的单向绑定数据。如果不存在，则使用defaultValue在AppStorage中创建和初始化propName对应的属性，返回其单向绑定数据。defaultValue必须为T类型，且不能为undefined或null。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。
defaultValue	T	是	当propName在AppStorage中不存在时，使用defaultValue在AppStorage中初始化对应的propName，defaultValue不能为undefined或null。

返回值：

类型	描述
SubscribedAbstractProperty<T>	SubscribedAbstractProperty<T>的实例。

示例：

AppStorage.setOrCreate('PropA', 47);
let prop: SubscribedAbstractProperty<number> = AppStorage.setAndProp('PropB', 49); // PropA -> 47, PropB -> 49

has¹⁰⁺

static has(propName: string): boolean

判断propName对应的属性是否在AppStorage中存在。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。

返回值：

类型	描述
boolean	如果propName对应的属性在AppStorage中存在，则返回true。不存在则返回false。

示例：

AppStorage.has('simpleProp');

get¹⁰⁺

static get<T>(propName: string): T | undefined

获取propName在AppStorage中对应的属性值。如果不存在则返回undefined。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。

返回值：

类型	描述
T \| undefined	AppStorage中propName对应的属性，如果不存在则返回undefined。

示例：

AppStorage.setOrCreate('PropA', 47);
let value: number = AppStorage.get('PropA') as number; // 47

set¹⁰⁺

static set<T>(propName: string, newValue: T): boolean

在AppStorage中设置propName对应属性的值。如果newValue的值和propName对应属性的值相同，即不需要做赋值操作，状态变量不会通知UI刷新propName对应属性的值。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。
newValue	T	是	属性值，不能为undefined或null。

返回值：

类型	描述
boolean	如果AppStorage中不存在propName对应的属性，或者设置的newValue是undefined或者null，返回false。设置成功则返回true。

示例：

AppStorage.setOrCreate('PropA', 48);
let res: boolean = AppStorage.set('PropA', 47) // true
let res1: boolean = AppStorage.set('PropB', 47) // false

setOrCreate¹⁰⁺

static setOrCreate<T>(propName: string, newValue: T): void

如果propName已经在AppStorage中存在，并且newValue和propName对应属性的值不同，则设置propName对应属性的值为newValue，否则状态变量不会通知UI刷新propName对应属性的值。如果propName不存在，则创建propName属性，值为newValue。setOrCreate只可以创建单个AppStorage的键值对，如果想创建多个AppStorage键值对，可以多次调用此方法。

newValue不能为undefined或null。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。
newValue	T	是	属性值，不能为undefined或null。

示例：

AppStorage.setOrCreate('simpleProp', 121);

delete¹⁰⁺

static delete(propName: string): boolean

在AppStorage中删除propName对应的属性。

在AppStorage中删除该属性的前提是必须保证该属性没有订阅者。如果有订阅者，则返回false。如果没有订阅者则删除成功并返回true。

属性的订阅者为link、prop等接口绑定的propName，以及@StorageLink('propName')和@StorageProp('propName')。如果自定义组件中使用@StorageLink('propName')和@StorageProp('propName')或者SubscribedAbstractProperty实例依旧对propName有同步关系，则该属性不能从AppStorage中删除。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。

返回值：

类型	描述
boolean	如果AppStorage中有对应的属性，且该属性已经没有订阅者，则删除成功，返回true。如果属性不存在，或者该属性还存在订阅者，则返回false。

示例：

AppStorage.setOrCreate('PropA', 47);
AppStorage.link<number>('PropA');
let res: boolean = AppStorage.delete('PropA'); // false, PropA still has a subscriber

AppStorage.setOrCreate('PropB', 48);
let res1: boolean = AppStorage.delete('PropB'); // true, PropB is deleted from AppStorage successfully

keys¹⁰⁺

static keys(): IterableIterator<string>

返回AppStorage中所有的属性名。

系统能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

类型	描述
IterableIterator<string>	AppStorage中所有的属性名。

示例：

AppStorage.setOrCreate('PropB', 48);
let keys: IterableIterator<string> = AppStorage.keys();

clear¹⁰⁺

static clear(): boolean

删除AppStorage中所有属性。删除所有属性的前提是，AppStorage已经没有任何订阅者。如果有订阅者，clear将不会生效并返回false。如果没有订阅者，则删除成功，并返回true。

订阅者的含义参考delete。

系统能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

类型	描述
boolean	如果AppStorage中的属性已经没有订阅者则删除成功，返回true。否则返回false。

示例：

AppStorage.setOrCreate('PropA', 47);
let res: boolean = AppStorage.clear(); // true, there are no subscribers

size¹⁰⁺

static size(): number

返回AppStorage中的属性数量。

系统能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

类型	描述
number	返回AppStorage中属性的数量。

示例：

AppStorage.setOrCreate('PropB', 48);
let res: number = AppStorage.size(); // 1

Link^(deprecated)

static Link(propName: string): any

与AppStorage中对应的propName建立双向数据绑定。如果给定的propName在AppStorage中存在，返回与AppStorage中propName对应属性的双向绑定数据。

双向绑定数据的修改会同步回AppStorage中，AppStorage会将变化同步到所有绑定该propName的数据和自定义组件中。

如果AppStorage中不存在propName，则返回undefined。

说明：
从API version 7 开始支持，从API version 10 开始废弃，推荐使用link10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。

返回值：

类型	描述
any	返回双向绑定的数据，如果AppStorage中不存在对应的propName，则返回undefined。

示例：

AppStorage.SetOrCreate('PropA', 47);
let linkToPropA1: SubscribedAbstractProperty<number> = AppStorage.Link('PropA');
let linkToPropA2: SubscribedAbstractProperty<number> = AppStorage.Link('PropA'); // linkToPropA2.get() == 47
linkToPropA1.set(48); // 双向同步: linkToPropA1.get() == linkToPropA2.get() == 48

SetAndLink^(deprecated)

static SetAndLink<T>(propName: string, defaultValue: T): SubscribedAbstractProperty<T>

与Link接口类似，如果给定的propName在AppStorage中存在，则返回该propName对应的属性的双向绑定数据。如果不存在，则使用defaultValue在AppStorage中创建和初始化propName对应的属性，并返回其双向绑定数据。defaultValue必须为T类型，且不能为undefined或null。

说明：
从API version 7 开始支持，从API version 10 开始废弃，推荐使用setAndLink10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。
defaultValue	T	是	当propName在AppStorage中不存在，使用defaultValue在AppStorage中初始化对应的propName，defaultValue不能为undefined或null。

返回值：

类型	描述
SubscribedAbstractProperty<T>	SubscribedAbstractProperty<T>的实例，和AppStorage中propName对应属性的双向绑定的数据。

示例：

AppStorage.SetOrCreate('PropA', 47);
let link1: SubscribedAbstractProperty<number> = AppStorage.SetAndLink('PropB', 49); // Create PropB 49
let link2: SubscribedAbstractProperty<number> = AppStorage.SetAndLink('PropA', 50); // PropA exists, remains 47

Prop^(deprecated)

static Prop(propName: string): any

说明：
Prop仅支持简单类型。从API version 7 开始支持，从API version 10 开始废弃，推荐使用prop10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。

返回值：

类型	描述
any	返回单向绑定的数据，如果AppStorage中不存在对应的propName，则返回undefined。

示例：

AppStorage.SetOrCreate('PropA', 47);
let prop1: SubscribedAbstractProperty<number> = AppStorage.Prop('PropA');
let prop2: SubscribedAbstractProperty<number> = AppStorage.Prop('PropA');
prop1.set(1); // one-way sync: prop1.get()=1; but prop2.get() == 47

SetAndProp^(deprecated)

static SetAndProp<S>(propName: string, defaultValue: S): SubscribedAbstractProperty<S>

与Prop接口类似。如果给定的propName在AppStorage中存在，则返回该propName对应的属性的单向绑定数据。如果不存在，则使用defaultValue在AppStorage中创建和初始化propName对应的属性，返回其单向绑定数据。defaultValue必须为S类型，且不能为undefined或null。

说明：
从API version 7 开始支持，从API version 10 开始废弃，推荐使用setAndProp10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。
defaultValue	S	是	当propName在AppStorage中不存在时，使用defaultValue在AppStorage中初始化对应的propName，defaultValue不能为undefined或null。

返回值：

类型	描述
SubscribedAbstractProperty<S>	SubscribedAbstractProperty<S>的实例。

示例：

AppStorage.SetOrCreate('PropA', 47);
let prop: SubscribedAbstractProperty<number> = AppStorage.SetAndProp('PropB', 49); // PropA -> 47, PropB -> 49

Has^(deprecated)

static Has(propName: string): boolean

判断propName对应的属性是否在AppStorage中存在。

说明：
从API version 7 开始支持，从API version 10 开始废弃，推荐使用has10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。

返回值：

类型	描述
boolean	如果propName对应的属性在AppStorage中存在，则返回true。不存在则返回false。

示例：

AppStorage.Has('simpleProp');

Get^(deprecated)

static Get<T>(propName: string): T | undefined

获取propName在AppStorage中对应的属性值。如果不存在则返回undefined。

说明：
从API version 7 开始支持，从API version 10 开始废弃，推荐使用get10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。

返回值：

类型	描述
T \| undefined	AppStorage中propName对应的属性值，如果不存在则返回undefined。

示例：

AppStorage.SetOrCreate('PropA', 47);
let value: number = AppStorage.Get('PropA') as number; // 47

Set^(deprecated)

static Set<T>(propName: string, newValue: T): boolean

在AppStorage中设置propName对应属性的值。

说明：
从API version 7 开始支持，从API version 10 开始废弃，推荐使用set10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。
newValue	T	是	属性值，不能为undefined或null。

返回值：

类型	描述
boolean	如果AppStorage中不存在propName对应的属性，或者设置的newValue是undefined或者null，返回false。设置成功则返回true。

示例：

AppStorage.SetOrCreate('PropA', 48);
let res: boolean = AppStorage.Set('PropA', 47) // true
let res1: boolean = AppStorage.Set('PropB', 47) // false

SetOrCreate^(deprecated)

static SetOrCreate<T>(propName: string, newValue: T): void

如果propName已经在AppStorage中存在，则设置propName对应是属性的值为newValue。如果不存在，则创建propName属性，值为newValue。

newValue不能为undefined或null。

说明：
从API version 7 开始支持，从API version 10 开始废弃，推荐使用setOrCreate10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。
newValue	T	是	属性值，不能为undefined或null。

示例：

AppStorage.SetOrCreate('simpleProp', 121);

Delete^(deprecated)

static Delete(propName: string): boolean

在AppStorage中删除propName对应的属性。

在AppStorage中删除该属性的前提是必须保证该属性没有订阅者。如果有订阅者，则返回false。如果没有订阅者则删除成功并返回true。

属性的订阅者为Link、Prop等接口绑定的propName，以及@StorageLink('propName')和@StorageProp('propName')。如果自定义组件中使用@StorageLink('propName')和@StorageProp('propName')或者SubscribedAbstractProperty实例依旧对propName有同步关系，则该属性不能从AppStorage中删除。

说明：
从API version 7 开始支持，从API version 10 开始废弃，推荐使用delete10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。

返回值：

类型	描述
boolean	如果AppStorage中有对应的属性，且该属性已经没有订阅者，则删除成功，返回true。如果属性不存在，或者该属性还存在订阅者，则返回false。

示例：

AppStorage.SetOrCreate('PropA', 47);
AppStorage.Link('PropA');
let res: boolean = AppStorage.Delete('PropA'); // false, PropA still has a subscriber

AppStorage.SetOrCreate('PropB', 48);
let res1: boolean = AppStorage.Delete('PropB'); // true, PropB is deleted from AppStorage successfully

Keys^(deprecated)

static Keys(): IterableIterator<string>

返回AppStorage中所有的属性名。

说明：
从API version 7 开始支持，从API version 10 开始废弃，推荐使用keys10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

类型	描述
IterableIterator<string>	AppStorage中所有的属性名。

示例：

AppStorage.SetOrCreate('PropB', 48);
let keys: IterableIterator<string> = AppStorage.Keys();

staticClear^(deprecated)

static staticClear(): boolean

删除所有的属性。

说明：
从API version 7 开始支持，从API version 9 开始废弃，推荐使用clear10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

类型	描述
boolean	删除所有的属性，如果当前有状态变量依旧引用此属性，返回false。

示例：

let simple = AppStorage.staticClear();

Clear^(deprecated)

static Clear(): boolean

删除AppStorage中所有属性。删除所有属性的前提是，AppStorage已经没有任何订阅者。如果有订阅者，Clear将不会生效并返回false。如果没有订阅者且删除成功则返回true。

订阅者的含义参考delete。

说明：
从API version 9 开始支持，从API version 10 开始废弃，推荐使用clear10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

类型	描述
boolean	如果AppStorage中的属性已经没有订阅者则删除成功，返回true。否则返回false。

示例：

AppStorage.SetOrCreate('PropA', 47);
let res: boolean = AppStorage.Clear(); // true, there are no subscribers

IsMutable^(deprecated)

static IsMutable(propName: string): boolean

返回AppStorage中propName对应的属性是否是可变的。

说明：
从API version 7 开始支持，从API version 10 开始废弃。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	AppStorage中的属性名。

返回值：

类型	描述
boolean	返回AppStorage中propNam对应的属性是否是可变的。

示例：

AppStorage.SetOrCreate('PropA', 47);
let res: boolean = AppStorage.IsMutable('simpleProp');

Size^(deprecated)

static Size(): number

返回AppStorage中的属性数量。

说明：
从API version 7 开始支持，从API version 10 开始废弃，推荐使用size10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

类型	描述
number	返回AppStorage中属性的数量。

示例：

AppStorage.SetOrCreate('PropB', 48);
let res: number = AppStorage.Size(); // 1

LocalStorage⁹⁺

LocalStorage具体UI使用说明，详见LocalStorage(页面级UI状态存储)

constructor⁹⁺

constructor(initializingProperties?: Object)

创建一个新的LocalStorage实例。使用Object.keys(initializingProperties)返回的属性和其数值，初始化LocalStorage实例。

说明：
从API version 9开始，该接口支持在ArkTS卡片中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
initializingProperties	Object	否	用initializingProperties包含的属性和数值初始化LocalStorage。initializingProperties不能为undefined。

示例：

let para: Record<string, number> = { 'PropA': 47 };
let storage: LocalStorage = new LocalStorage(para);

getShared¹⁰⁺

static getShared(): LocalStorage

获取当前stage共享的LocalStorage实例。

说明：
从API version 9开始，该接口支持在ArkTS卡片中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

**模型约束：**此接口仅可在Stage模型下使用。

返回值：

类型	描述
LocalStorage	返回LocalStorage实例。

示例： getShared具体使用，见在UI页面通过getShared接口获取在通过loadContent共享的LocalStorage实例

has⁹⁺

has(propName: string): boolean

判断propName对应的属性是否在LocalStorage中存在。

说明：
从API version 9开始，该接口支持在ArkTS卡片中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	LocalStorage中的属性名。

返回值：

类型	描述
boolean	如果propName对应的属性在LocalStorage中存在，则返回true。不存在则返回false。

示例：

let para: Record<string, number> = { 'PropA': 47 };
let storage: LocalStorage = new LocalStorage(para);
storage.has('PropA'); // true

get⁹⁺

get<T>(propName: string): T | undefined

获取propName在LocalStorage中对应的属性值。

说明：
从API version 9开始，该接口支持在ArkTS卡片中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	LocalStorage中的属性名。

返回值：

类型	描述
T \| undefined	LocalStorage中propName对应的属性值，如果不存在则返回undefined。

示例：

let para: Record<string, number> = { 'PropA': 47 };
let storage: LocalStorage = new LocalStorage(para);
let value: number = storage.get('PropA') as number; // 47

set⁹⁺

set<T>(propName: string, newValue: T): boolean

在LocalStorage中设置propName对应属性的值。如果newValue的值和propName对应属性的值相同，即不需要做赋值操作，状态变量不会通知UI刷新propName对应属性的值。

说明：
从API version 9开始，该接口支持在ArkTS卡片中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	LocalStorage中的属性名。
newValue	T	是	属性值，不能为undefined或者null。

返回值：

类型	描述
boolean	如果LocalStorage中不存在propName对应的属性，或者设置的newValue是undefined或者null，返回false。设置成功返回true。

示例：

let para: Record<string, number> = { 'PropA': 47 };
let storage: LocalStorage = new LocalStorage(para);
let res: boolean = storage.set('PropA', 47); // true
let res1: boolean = storage.set('PropB', 47); // false

setOrCreate⁹⁺

setOrCreate<T>(propName: string, newValue: T): boolean

如果propName已经在LocalStorage中存在，并且newValue和propName对应属性的值不同，则设置propName对应属性的值为newValue，否则状态变量不会通知UI刷新propName对应属性的值。如果propName不存在，则创建propName属性，值为newValue。setOrCreate只可以创建单个LocalStorage的键值对，如果想创建多个LocalStorage键值对，可以多次调用此方法。

说明：
从API version 9开始，该接口支持在ArkTS卡片中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	LocalStorage中的属性名。
newValue	T	是	属性值，不能为undefined或者null。

返回值：

类型	描述
boolean	如果设置的newValue是undefined或者null，返回false。如果LocalStorage中存在propName，则更新其值为newValue，返回true。如果LocalStorage中不存在propName，则创建propName，并初始化其值为newValue，返回true。

示例：

let para: Record<string, number> = { 'PropA': 47 };
let storage: LocalStorage = new LocalStorage(para);
let res: boolean = storage.setOrCreate('PropA', 121); // true
let res1: boolean = storage.setOrCreate('PropB', 111); // true
let res2: boolean = storage.setOrCreate('PropB', null); // false

link⁹⁺

link<T>(propName: string): SubscribedAbstractProperty<T>

如果给定的propName在LocalStorage实例中存在，则返回与LocalStorage中propName对应属性的双向绑定数据。

双向绑定数据的修改会被同步回LocalStorage中，LocalStorage会将变化同步到所有绑定该propName的数据和Component中。

如果LocalStorage中不存在propName，则返回undefined。

说明：
从API version 9开始，该接口支持在ArkTS卡片中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	LocalStorage中的属性名。

返回值：

类型	描述
SubscribedAbstractProperty<T>	SubscribedAbstractProperty<T>的实例，与LocalStorage中propName对应属性的双向绑定的数据，如果LocalStorage中不存在对应的propName，则返回undefined。

示例：

let para: Record<string, number> = { 'PropA': 47 };
let storage: LocalStorage = new LocalStorage(para);
let linkToPropA1: SubscribedAbstractProperty<number> = storage.link('PropA');
let linkToPropA2: SubscribedAbstractProperty<number> = storage.link('PropA'); // linkToPropA2.get() == 47
linkToPropA1.set(48); // 双向同步: linkToPropA1.get() == linkToPropA2.get() == 48

setAndLink⁹⁺

setAndLink<T>(propName: string, defaultValue: T): SubscribedAbstractProperty<T>

与link接口类似，如果给定的propName在LocalStorage中存在，则返回该propName对应的属性的双向绑定数据。如果不存在，则使用defaultValue在LocalStorage中创建和初始化propName对应的属性，返回其双向绑定数据。defaultValue必须为T类型，且不能为undefined或null。

说明：
从API version 9开始，该接口支持在ArkTS卡片中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	LocalStorage中的属性名。
defaultValue	T	是	当propName在LocalStorage中不存在时，使用defaultValue在LocalStorage中初始化对应的propName，defaultValue不能为undefined或null。

返回值：

类型	描述
SubscribedAbstractProperty<T>	SubscribedAbstractProperty<T>的实例，与LocalStorage中propName对应属性的双向绑定的数据。

示例：

let para: Record<string, number> = { 'PropA': 47 };
let storage: LocalStorage = new LocalStorage(para);
let link1: SubscribedAbstractProperty<number> = storage.setAndLink('PropB', 49); // Create PropB 49
let link2: SubscribedAbstractProperty<number> = storage.setAndLink('PropA', 50); // PropA exists, remains 47

prop⁹⁺

prop<S>(propName: string): SubscribedAbstractProperty<S>

如果给定的propName在LocalStorage中存在，则返回与LocalStorage中propName对应属性的单向绑定数据。如果LocalStorage中不存在propName，则返回undefined。单向绑定数据的修改不会被同步回LocalStorage中。

说明：
从API version 9开始，该接口支持在ArkTS卡片中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	LocalStorage中的属性名。

返回值：

类型	描述
SubscribedAbstractProperty<S>	SubscribedAbstractProperty<S>的实例，和LocalStorage中propName对应属性的单向绑定的数据。如果LocalStorage中不存在对应的propName，则返回undefined。

示例：

let para: Record<string, number> = { 'PropA': 47 };
let storage: LocalStorage = new LocalStorage(para);
let prop1: SubscribedAbstractProperty<number> = storage.prop('PropA');
let prop2: SubscribedAbstractProperty<number> = storage.prop('PropA');
prop1.set(1); // one-way sync: prop1.get()=1; but prop2.get() == 47

setAndProp⁹⁺

setAndProp<S>(propName: string, defaultValue: S): SubscribedAbstractProperty<S>

与prop接口类似。如果propName在LocalStorage中存在，则返回该propName对应的属性的单向绑定数据。如果不存在，则使用defaultValue在LocalStorage中创建和初始化propName对应的属性，返回其单向绑定数据。defaultValue必须为S类型，且不能为undefined或null。

说明：
从API version 9开始，该接口支持在ArkTS卡片中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	LocalStorage中的属性名。
defaultValue	S	是	当propName在LocalStorage中不存在，使用defaultValue在LocalStorage中初始化对应的propName，defaultValue不能为undefined或null。

返回值：

类型	描述
SubscribedAbstractProperty<S>	SubscribedAbstractProperty<S>的实例，和LocalStorage中propName对应属性的单向绑定的数据。

示例：

let para: Record<string, number> = { 'PropA': 47 };
let storage: LocalStorage = new LocalStorage(para);
let prop: SubscribedAbstractProperty<number> = storage.setAndProp('PropB', 49); // PropA -> 47, PropB -> 49

delete⁹⁺

delete(propName: string): boolean

在LocalStorage中删除propName对应的属性。在LocalStorage中删除属性的前提是该属性已经没有订阅者，如果有订阅者，则返回false。如果没有订阅者则删除成功并返回true。

属性的订阅者为link，prop等接口绑定的propName，以及@LocalStorageLink('propName')和@LocalStorageProp('propName')。如果自定义组件中使用@LocalStorageLink('propName')和@LocalStorageProp('propName')或者SubscribedAbstractProperty实例（link和prop接口的返回类型）依旧对propName有同步关系，则该属性不能从LocalStorage中删除。

说明：
从API version 9开始，该接口支持在ArkTS卡片中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
propName	string	是	LocalStorage中的属性名。

返回值：

类型	描述
boolean	如果LocalStorage中有对应的属性，且该属性已经没有订阅者，则删除成功，返回true。如果属性不存在，或者该属性还存在订阅者，则返回false。

示例：

let para: Record<string, number> = { 'PropA': 47 };
let storage: LocalStorage = new LocalStorage(para);
storage.link<number>('PropA');
let res: boolean = storage.delete('PropA'); // false, PropA still has a subscriber
let res1: boolean = storage.delete('PropB'); // false, PropB is not in storage
storage.setOrCreate('PropB', 48);
let res2: boolean = storage.delete('PropB'); // true, PropB is deleted from storage successfully

keys⁹⁺

keys(): IterableIterator<string>

返回LocalStorage中所有的属性名。

说明：
从API version 9开始，该接口支持在ArkTS卡片中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

类型	描述
IterableIterator<string>	LocalStorage中所有的属性名。

示例：

let para: Record<string, number> = { 'PropA': 47 };
let storage: LocalStorage = new LocalStorage(para);
let keys: IterableIterator<string> = storage.keys();

size⁹⁺

size(): number

返回LocalStorage中的属性数量。

说明：
从API version 9开始，该接口支持在ArkTS卡片中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

类型	描述
number	LocalStorage中属性的的数量。

示例：

let para: Record<string, number> = { 'PropA': 47 };
let storage: LocalStorage = new LocalStorage(para);
let res: number = storage.size(); // 1

clear⁹⁺

clear(): boolean

删除LocalStorage中所有的属性。删除所有属性的前提是已经没有任何订阅者。如果有订阅者，clear不会生效并返回false。如果没有订阅者则删除成功并返回true。

订阅者的含义参考delete

说明：
从API version 9开始，该接口支持在ArkTS卡片中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

类型	描述
boolean	如果LocalStorage中的属性已经没有任何订阅者，则删除成功，并返回true。否则返回false。

示例：

let para: Record<string, number> = { 'PropA': 47 };
let storage: LocalStorage = new LocalStorage(para);
let res: boolean = storage.clear(); // true, there are no subscribers

GetShared^(deprecated)

static GetShared(): LocalStorage

获取当前stage共享的LocalStorage实例。

说明：
从API version 9开始，该接口支持在ArkTS卡片中使用。从API version 10开始废弃，推荐使用getShared10+。

系统能力： SystemCapability.ArkUI.ArkUI.Full

**模型约束：**此接口仅可在Stage模型下使用。

返回值：

类型	描述
LocalStorage	返回LocalStorage实例。

示例：

let storage: LocalStorage = LocalStorage.GetShared();

SubscribedAbstractProperty

get⁹⁺

abstract get(): T

读取从AppStorage/LocalStorage同步属性的数据。

说明：
从API version 9开始，该接口支持在ArkTS卡片中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

类型	描述
T	AppStorage/LocalStorage同步属性的数据。

示例：

AppStorage.setOrCreate('PropA', 47); 
let prop1: SubscribedAbstractProperty<number> = AppStorage.prop('PropA');    
prop1.get(); //  prop1.get()=47

set⁹⁺

abstract set(newValue: T): void

设置AppStorage/LocalStorage同步属性的数据，newValue必须是T类型，不能为undefined或null。

说明：
从API version 9开始，该接口支持在ArkTS卡片中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
newValue	T	是	要设置的数据，不能为undefined或null。

示例：

AppStorage.setOrCreate('PropA', 47);
let prop1: SubscribedAbstractProperty<number> = AppStorage.prop('PropA');
prop1.set(1); //  prop1.get()=1

aboutToBeDeleted¹⁰⁺

abstract aboutToBeDeleted(): void

取消SubscribedAbstractProperty实例对AppStorage/LocalStorage的单/双向同步关系，并无效化SubscribedAbstractProperty实例，即当调用aboutToBeDelted方法之后不能再使用SubscribedAbstractProperty实例调用set或get方法。

系统能力： SystemCapability.ArkUI.ArkUI.Full

示例：

AppStorage.setOrCreate('PropA', 47);
let link = AppStorage.setAndLink('PropB', 49); // PropA -> 47, PropB -> 49
link.aboutToBeDeleted();

PersistentStorage

PersistentStorage具体UI使用说明，详见PersistentStorage(持久化存储UI状态)

PersistPropsOptions

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
key	string	是	属性名。
defaultValue	number \| string \| boolean \| Object	是	在PersistentStorage和AppStorage未查询到时，则使用默认值初始化它。不允许为undefined和null。

persistProp¹⁰⁺

static persistProp<T>(key: string, defaultValue: T): void

将AppStorage中key对应的属性持久化到文件中。该接口的调用通常在访问AppStorage之前。

确定属性的类型和值的顺序如下：

如果PersistentStorage文件中存在key对应的属性，在AppStorage中创建对应的propName，并用在PersistentStorage中找到的key的属性初始化。
如果PersistentStorage文件中没有查询到key对应的属性，则在AppStorage中查找key对应的属性。如果找到key对应的属性，则将该属性持久化。
如果AppStorage中也没查找到key对应的属性，则在AppStorage中创建key对应的属性。用defaultValue初始化其值，并将该属性持久化。

根据上述的初始化流程，如果AppStorage中有该属性，则会使用其值，覆盖掉PersistentStorage文件中的值。由于AppStorage是内存内数据，该行为会导致数据丧失持久化能力。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
key	string	是	属性名。
defaultValue	T	是	在PersistentStorage和AppStorage中未查询到时，则使用默认值进行初始化。不允许为undefined和null。

示例：

persistProp具体使用，见从AppStorage中访问PersistentStorage初始化的属性

deleteProp¹⁰⁺

static deleteProp(key: string): void

persistProp的逆向操作。将key对应的属性从PersistentStorage中删除，后续AppStorage的操作，对PersistentStorage不会再有影响。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
key	string	是	PersistentStorage中的属性名。

示例：

PersistentStorage.deleteProp('highScore');

persistProps¹⁰⁺

static persistProps(props: PersistPropsOptions[]): void

行为和persistProp类似，不同在于可以一次性持久化多个数据，适合在应用启动的时候初始化。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
props	PersistPropsOptions[]	是	持久化数组。

示例：

PersistentStorage.persistProps([{ key: 'highScore', defaultValue: '0' }, { key: 'wightScore', defaultValue: '1' }]);

keys¹⁰⁺

static keys(): Array<string>

返回所有持久化属性的属性名的数组。

系统能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

类型	描述
Array<string>	返回所有持久化属性的属性名的数组。

示例：

let keys: Array<string> = PersistentStorage.keys();

PersistProp^(deprecated)

static PersistProp<T>(key: string, defaultValue: T): void

将AppStorage中key对应的属性持久化到文件中。该接口的调用通常在访问AppStorage之前。

确定属性的类型和值的顺序如下：

如果PersistentStorage文件中存在key对应的属性，在AppStorage中创建对应的propName，并用在PersistentStorage中找到的key的属性初始化。
如果PersistentStorage文件中没有查询到key对应的属性，则在AppStorage中查找key对应的属性。如果找到key对应的属性，则将该属性持久化。
如果AppStorage也没查找到key对应的属性，则在AppStorage中创建key对应的属性。用defaultValue初始化其值，并将该属性持久化。

说明：
从API version 10开始废弃，推荐使用persistProp10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
key	string	是	属性名。
defaultValue	T	是	在PersistentStorage和AppStorage中未查询到时，则使用默认值进行初始化。不允许为undefined和null。

示例：

PersistentStorage.PersistProp('highScore', '0');

DeleteProp^(deprecated)

static DeleteProp(key: string): void

PersistProp的逆向操作。将key对应的属性从PersistentStorage中删除，后续AppStorage的操作，对PersistentStorage不会再有影响。

说明：
从API version 10开始废弃，推荐使用deleteProp10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
key	string	是	PersistentStorage中的属性名。

示例：

PersistentStorage.DeleteProp('highScore');

PersistProps^(deprecated)

static PersistProps(properties: {key: string, defaultValue: any;}[]): void

行为和PersistProp类似，不同在于可以一次性持久化多个数据，适合在应用启动的时候初始化。

说明：
从API version 10开始废弃，推荐使用persistProps10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
properties	{key: string, defaultValue: any}[]	是	持久化数组，启动key为属性名，defaultValue为默认值。规则同PersistProp。

示例：

PersistentStorage.PersistProps([{ key: 'highScore', defaultValue: '0' }, { key: 'wightScore', defaultValue: '1' }]);

Keys^(deprecated)

static Keys(): Array<string>

返回所有持久化属性的属性名的数组。

说明：
从API version 10开始废弃，推荐使用keys10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

类型	描述
Array<string>	返回所有持久化属性的属性名的数组。

示例：

let keys: Array<string> = PersistentStorage.Keys();

Environment

Environment具体使用说明，详见Environment(设备环境查询)

EnvPropsOptions

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
key	string	是	环境变量名称，支持的范围详见内置环境变量说明。
defaultValue	number \| string \| boolean	是	查询不到环境变量key，则使用defaultValue作为默认值存入AppStorage中。

envProp¹⁰⁺

static envProp<S>(key: string, value: S): boolean

将Environment的内置环境变量key存入AppStorage中。如果系统中未查询到Environment环境变量key的值，则使用默认值value，存入成功，返回true。如果AppStorage中已经有对应的key，则返回false。

所以建议在程序启动的时候调用该接口。

在没有调用envProp的情况下，就使用AppStorage读取环境变量是错误的。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
key	string	是	环境变量名称，支持的范围详见内置环境变量说明。
value	S	是	查询不到环境变量key时，则使用value作为默认值存入AppStorage中。

返回值：

类型	描述
boolean	如果key对应的属性在AppStorage中存在，则返回false。不存在则在AppStorage中用value作为默认值创建key对应的属性，返回true。

示例：

envProp具体使用，见从UI中访问Environment参数

envProps¹⁰⁺

static envProps(props: EnvPropsOptions[]): void

和envProp类似，不同点在于参数为数组，可以一次性初始化多个数据。建议在应用启动时调用，将系统环境变量批量存入AppStorage中。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
props	EnvPropsOptions[]	是	系统环境变量和默认值的键值对的数组。

示例：

Environment.envProps([{ key: 'accessibilityEnabled', defaultValue: 'default' }, {
  key: 'languageCode',
  defaultValue: 'en'
}, { key: 'prop', defaultValue: 'hhhh' }]);

keys¹⁰⁺

static keys(): Array<string>

返回环境变量的属性key的数组。

系统能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

类型	描述
Array<string>	返回关联的系统项数组。

示例：

Environment.envProps([{ key: 'accessibilityEnabled', defaultValue: 'default' }, {
  key: 'languageCode',
  defaultValue: 'en'
}, { key: 'prop', defaultValue: 'hhhh' }]);

let keys: Array<string> = Environment.keys(); // accessibilityEnabled, languageCode, prop

EnvProp^(deprecated)

static EnvProp<S>(key: string, value: S): boolean

所以建议在程序启动的时候调用该接口。

在没有调用EnvProp的情况下，就使用AppStorage读取环境变量是错误的。

说明：
从API version 10开始废弃，推荐使用envProp10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
key	string	是	环境变量名称，支持的范围详见内置环境变量说明。
value	S	是	查询不到环境变量key，则使用value作为默认值存入AppStorage中。

返回值：

类型	描述
boolean	如果key对应的属性在AppStorage中存在，则返回false。不存在则在AppStorage中用value作为默认值创建key对应的属性，返回true。

示例：

Environment.EnvProp('accessibilityEnabled', 'default');

EnvProps^(deprecated)

static EnvProps(props: {key: string; defaultValue: any;}[]): void

和EnvProp类似，不同点在于参数为数组，可以一次性初始化多个数据。建议在应用启动时调用，将系统环境变量批量存入AppStorage中。

说明：
从API version 10开始废弃，推荐使用envProps10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	参数描述
props	{key: string, defaultValue: any}[]	是	系统环境变量和默认值的键值对的数组。

示例：

Environment.EnvProps([{ key: 'accessibilityEnabled', defaultValue: 'default' }, {
  key: 'languageCode',
  defaultValue: 'en'
}, { key: 'prop', defaultValue: 'hhhh' }]);

Keys^(deprecated)

static Keys(): Array<string>

返回环境变量的属性key的数组。

说明：
从API version 10开始废弃，推荐使用keys10+替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

类型	描述
Array<string>	返回关联的系统项数组。

示例：

Environment.EnvProps([{ key: 'accessibilityEnabled', defaultValue: 'default' }, {
  key: 'languageCode',
  defaultValue: 'en'
}, { key: 'prop', defaultValue: 'hhhh' }]);

let keys: Array<string> = Environment.Keys(); // accessibilityEnabled, languageCode, prop

内置环境变量说明

key	类型	说明
accessibilityEnabled	string	无障碍屏幕朗读是否启用。当无法获取环境变量中的accessibilityEnabled的值时，将通过envProp、envProps等接口传入的开发者指定的默认值添加到AppStorage中。
colorMode	ColorMode	深浅色模式，可选值为： - ColorMode.LIGHT：浅色模式； - ColorMode.DARK：深色模式。
fontScale	number	字体大小比例。
fontWeightScale	number	字重比例。
layoutDirection	LayoutDirection	布局方向类型，可选值为： - LayoutDirection.LTR：从左到右； - LayoutDirection.RTL：从右到左。
languageCode	string	当前系统语言，小写字母，例如zh。

应用级变量的状态管理

AppStorage

link10+

setAndLink10+

prop10+

setAndProp10+

has10+

get10+

set10+

setOrCreate10+

delete10+

keys10+

clear10+

size10+

Link(deprecated)

SetAndLink(deprecated)

Prop(deprecated)

SetAndProp(deprecated)

Has(deprecated)

Get(deprecated)

Set(deprecated)

SetOrCreate(deprecated)

Delete(deprecated)

Keys(deprecated)

staticClear(deprecated)

Clear(deprecated)

IsMutable(deprecated)

Size(deprecated)

LocalStorage9+

constructor9+

getShared10+

has9+

get9+

set9+

setOrCreate9+

link9+

setAndLink9+

prop9+

setAndProp9+

delete9+

keys9+

size9+

clear9+

GetShared(deprecated)

SubscribedAbstractProperty

get9+

set9+

aboutToBeDeleted10+

PersistentStorage

PersistPropsOptions

persistProp10+

deleteProp10+

persistProps10+

keys10+

PersistProp(deprecated)

DeleteProp(deprecated)

PersistProps(deprecated)

Keys(deprecated)

Environment

EnvPropsOptions

envProp10+

envProps10+

keys10+

EnvProp(deprecated)

EnvProps(deprecated)

Keys(deprecated)

内置环境变量说明

link¹⁰⁺

setAndLink¹⁰⁺

prop¹⁰⁺

setAndProp¹⁰⁺

has¹⁰⁺

get¹⁰⁺

set¹⁰⁺

setOrCreate¹⁰⁺

delete¹⁰⁺

keys¹⁰⁺

clear¹⁰⁺

size¹⁰⁺

Link^(deprecated)

SetAndLink^(deprecated)

Prop^(deprecated)

SetAndProp^(deprecated)

Has^(deprecated)

Get^(deprecated)

Set^(deprecated)

SetOrCreate^(deprecated)

Delete^(deprecated)

Keys^(deprecated)

staticClear^(deprecated)

Clear^(deprecated)

IsMutable^(deprecated)

Size^(deprecated)

LocalStorage⁹⁺

constructor⁹⁺

getShared¹⁰⁺

has⁹⁺

get⁹⁺

set⁹⁺

setOrCreate⁹⁺

link⁹⁺

setAndLink⁹⁺

prop⁹⁺

setAndProp⁹⁺

delete⁹⁺

keys⁹⁺

size⁹⁺

clear⁹⁺

GetShared^(deprecated)

get⁹⁺

set⁹⁺

aboutToBeDeleted¹⁰⁺

persistProp¹⁰⁺

deleteProp¹⁰⁺

persistProps¹⁰⁺

keys¹⁰⁺

PersistProp^(deprecated)

DeleteProp^(deprecated)

PersistProps^(deprecated)

Keys^(deprecated)

envProp¹⁰⁺

envProps¹⁰⁺

keys¹⁰⁺

EnvProp^(deprecated)

EnvProps^(deprecated)

Keys^(deprecated)