From 4d0579e0d5219833146e24b4489a2ab0ae0543cc Mon Sep 17 00:00:00 2001 From: li_juntao Date: Mon, 7 Mar 2022 14:56:00 +0800 Subject: [PATCH 1/2] add @system.storage.d.ts Signed-off-by: li_juntao --- api/@system.storage.d.ts | 160 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 160 insertions(+) create mode 100644 api/@system.storage.d.ts diff --git a/api/@system.storage.d.ts b/api/@system.storage.d.ts new file mode 100644 index 0000000000..e2f25b3e95 --- /dev/null +++ b/api/@system.storage.d.ts @@ -0,0 +1,160 @@ +/* + * Copyright (c) 2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +export interface GetStorageOptions { + /** + * Content index. + * For liteWearable and smartVision, the value contains a maximum of 32 characters and cannot contain special characters such as \/"*+,:;<=>?[]|\x7F. + * @since 3 + */ + key: string; + + /** + * Default value returned when the key does not exist. + * If this parameter is not specified, an empty string is returned. + * @since 3 + */ + default?: string; + + /** + * Called when the stored content is read successfully. + * @since 3 + */ + success?: (data: any) => void; + + /** + * Called when the stored content fails to be read. + * @since 3 + */ + fail?: (data: string, code: number) => void; + + /** + * Called when the execution is completed. + * @since 3 + */ + complete?: () => void; +} + +export interface SetStorageOptions { + /** + * Index of the stored content to be modified. + * For liteWearable and smartVision, the value contains a maximum of 32 characters and cannot contain special characters such as \/"*+,:;<=>?[]|\x7F. + * @since 3 + */ + key: string; + + /** + * Target storage content. If the content is an empty string, the data item with the key as the index will be deleted. + * @since 3 + */ + value: string; + + /** + * Called when the stored content is modified successfully. + * @since 3 + */ + success?: () => void; + + /** + * Called when the stored content fails to be modified. + * @since 3 + */ + fail?: (data: string, code: number) => void; + + /** + * Called when the execution is completed. + * @since 3 + */ + complete?: () => void; +} + +/** + * @devices tv, phone, tablet, wearable, liteWearable, smartVision + */ +export interface ClearStorageOptions { + /** + * Called when the stored content is cleared successfully. + * @since 3 + */ + success?: () => void; + + /** + * Called when the stored content fails to be cleared. + * @since 3 + */ + fail?: (data: string, code: number) => void; + + /** + * Called when the execution is completed. + * @since 3 + */ + complete?: () => void; +} + +export interface DeleteStorageOptions { + /** + * Content index. + * For liteWearable and smartVision, the value contains a maximum of 32 characters and cannot contain special characters such as \/"*+,:;<=>?[]|\x7F. + * @since 3 + */ + key: string; + + /** + * Called when the stored content is deleted successfully. + * @since 3 + */ + success?: () => void; + + /** + * Called when the stored content fails to be deleted. + * @since 3 + */ + fail?: (data: string, code: number) => void; + + /** + * Called when the execution is completed. + * @since 3 + */ + complete?: () => void; +} + +/** + * @Syscap SysCap.ACE.UIEngine + */ +export default class Storage { + /** + * Reads the stored content. + * @param options Options. + */ + static get(options: GetStorageOptions): void; + + /** + * Modifies the stored content. + * @param options Options. + */ + static set(options: SetStorageOptions): void; + + /** + * Clears the stored content. + * @param options Options. + */ + static clear(options?: ClearStorageOptions): void; + + /** + * Deletes the stored content. + * @param options Options. + */ + static delete(options: DeleteStorageOptions): void; +} -- Gitee From 803fbe1bfd9ecd40cf2fc344cd0275c0fe3dffec Mon Sep 17 00:00:00 2001 From: li_juntao Date: Mon, 7 Mar 2022 16:08:26 +0800 Subject: [PATCH 2/2] add @system.storage.d.ts Signed-off-by: li_juntao --- api/@system.storage.d.ts | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/api/@system.storage.d.ts b/api/@system.storage.d.ts index e2f25b3e95..26a49d9557 100644 --- a/api/@system.storage.d.ts +++ b/api/@system.storage.d.ts @@ -13,6 +13,11 @@ * limitations under the License. */ +/** + * @import import storage from '@system.storage'; + * @since 3 + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + */ export interface GetStorageOptions { /** * Content index. @@ -47,6 +52,11 @@ export interface GetStorageOptions { complete?: () => void; } +/** + * @import import storage from '@system.storage'; + * @since 3 + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + */ export interface SetStorageOptions { /** * Index of the stored content to be modified. @@ -81,7 +91,9 @@ export interface SetStorageOptions { } /** - * @devices tv, phone, tablet, wearable, liteWearable, smartVision + * @import import storage from '@system.storage'; + * @since 3 + * @syscap SystemCapability.DistributedDataManager.Preferences.Core */ export interface ClearStorageOptions { /** @@ -103,6 +115,11 @@ export interface ClearStorageOptions { complete?: () => void; } +/** + * @import import storage from '@system.storage'; + * @since 3 + * @syscap SystemCapability.DistributedDataManager.Preferences.Core + */ export interface DeleteStorageOptions { /** * Content index. @@ -131,7 +148,9 @@ export interface DeleteStorageOptions { } /** - * @Syscap SysCap.ACE.UIEngine + * @import import storage from '@system.storage'; + * @since 3 + * @syscap SystemCapability.DistributedDataManager.Preferences.Core */ export default class Storage { /** -- Gitee