diff --git a/api/@ohos.data.preferences.d.ts b/api/@ohos.data.preferences.d.ts deleted file mode 100644 index c5755371035728dbc700781e0828ffed10645373..0000000000000000000000000000000000000000 --- a/api/@ohos.data.preferences.d.ts +++ /dev/null @@ -1,199 +0,0 @@ -/* -* 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. -*/ -import { AsyncCallback, Callback } from './basic'; -import Context from "./application/Context"; - -/** - * Provides interfaces to obtain and modify preferences data. - * - * @name preferences - * @since 8 - * @syscap SystemCapability.DistributedDataManager.Preferences.Core - * - */ -declare namespace preferences { - /** - * Obtains a {@link Preferences} instance matching a specified preferences file name. - * - *

The {@link references} instance loads all data of the preferences file and - * resides in the memory. You can use removePreferencesFromCache to remove the instance from the memory. - * - * @param context Indicates the context of application or capability. - * @param name Indicates the preferences file name. - * @return Returns the {@link Preferences} instance matching the specified preferences file name. - * @throws BusinessError if invoked failed - * @since 8 - */ - function getPreferences(context: Context, name: string, callback: AsyncCallback): void; - function getPreferences(context: Context, name: string): Promise; - - /** - * Deletes a {@link Preferences} instance matching a specified preferences file name - * from the cache which is performed by removePreferencesFromCache and deletes the - * preferences file. - * - *

When deleting the {@link Preferences} instance, you must release all references - * of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency - * will occur. - * - * @param context Indicates the context of application or capability. - * @param name Indicates the preferences file name. - * @throws BusinessError if invoked failed - * @since 8 - */ - function deletePreferences(context: Context, name: string, callback: AsyncCallback): void; - function deletePreferences(context: Context, name: string): Promise; - - /** - * Deletes a {@link Preferences} instance matching a specified preferences file name - * from the cache. - * - *

When deleting the {@link Preferences} instance, you must release all references - * of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency - * will occur. - * - * @param context Indicates the context of application or capability. - * @param name Indicates the preferences file name. - * @throws BusinessError if invoked failed - * @since 8 - */ - function removePreferencesFromCache(context: Context, name: string, callback: AsyncCallback): void; - function removePreferencesFromCache(context: Context, name: string): Promise; - - /** - * Provides interfaces to obtain and modify preferences data. - * - *

The preferences data is stored in a file, which matches only one {@link Preferences} instance in the memory. - * You can use getPreferences to obtain the {@link Preferences} instance matching - * the file that stores preferences data, and use emovePreferencesFromCache - * to remove the {@link Preferences} instance from the memory. - * - * @syscap SystemCapability.DistributedDataManager.Preferences.Core - * - * @since 8 - */ - interface Preferences { - /** - * Obtains the value of a preferences in the int format. - * - *

If the value is {@code null} or not in the int format, the default value is returned. - * - * @param key Indicates the key of the preferences. It cannot be {@code null} or empty. - * @param defValue Indicates the default value to return. - * @return Returns the value matching the specified key if it is found; returns the default value otherwise. - * @throws BusinessError if invoked failed - * @since 8 - */ - get(key: string, defValue: ValueType, callback: AsyncCallback): void; - get(key: string, defValue: ValueType): Promise; - - /** - * Checks whether the {@link Preferences} object contains a preferences matching a specified key. - * - * @param key Indicates the key of the preferences to check for. - * @return Returns {@code true} if the {@link Preferences} object contains a preferences with the specified key; - * returns {@code false} otherwise. - * @throws BusinessError if invoked failed - * @since 8 - */ - has(key: string, callback: AsyncCallback): boolean; - has(key: string): Promise; - - /** - * Sets an int value for the key in the {@link Preferences} object. - * - *

You can call the {@link #flush} method to save the {@link Preferences} object to the - * file. - * - * @param key Indicates the key of the preferences to modify. It cannot be {@code null} or empty. - * @param value Indicates the value of the preferences. - * MAX_KEY_LENGTH. - * @throws BusinessError if invoked failed - * @since 8 - */ - put(key: string, value: ValueType, callback: AsyncCallback): void; - put(key: string, value: ValueType): Promise; - - /** - * Deletes the preferences with a specified key from the {@link Preferences} object. - * - *

You can call the {@link #flush} method to save the {@link Preferences} object to the - * file. - * - * @param key Indicates the key of the preferences to delete. It cannot be {@code null} or empty. - * MAX_KEY_LENGTH. - * @throws BusinessError if invoked failed - * @since 8 - */ - delete(key: string, callback: AsyncCallback): void; - delete(key: string): Promise; - - /** - * Clears all preferences from the {@link Preferences} object. - * - *

You can call the {@link #flush} method to save the {@link Preferences} object to the - * file. - * - * @throws BusinessError if invoked failed - * @since 8 - */ - clear(callback: AsyncCallback): void; - clear(): Promise; - - /** - * Asynchronously saves the {@link Preferences} object to the file. - * - * @throws BusinessError if invoked failed - * @since 8 - */ - flush(callback: AsyncCallback): void; - flush(): Promise; - - /** - * Registers an observer to listen for the change of a {@link Preferences} object. - * - * @param callback Indicates the callback when preferences changes. - * @throws BusinessError if invoked failed - * @since 8 - */ - on(type: 'change', callback: Callback<{ key: string }>): void; - - /** - * Unregisters an existing observer. - * - * @param callback Indicates the registered callback. - * @throws BusinessError if invoked failed - * @since 8 - */ - off(type: 'change', callback: Callback<{ key: string }>): void; - } - - /** - * Indicates possible value types - */ - type ValueType = number | string | boolean; - - /** - * Indicates the maximum length of a key (80 characters). - */ - const MAX_KEY_LENGTH: 80; - - /** - * Indicates the maximum length of a string (8192 characters). - */ - const MAX_VALUE_LENGTH: 8192; -} - -export default preferences; \ No newline at end of file diff --git a/api/@ohos.data.storage.d.ts b/api/@ohos.data.storage.d.ts index e0d4107e06d10319817f9d4e264863eb28240f50..37f2a0432e39801084f936f622dfa3a6dbe07b26 100644 --- a/api/@ohos.data.storage.d.ts +++ b/api/@ohos.data.storage.d.ts @@ -19,7 +19,6 @@ import { AsyncCallback, Callback } from './basic'; * * @name storage * @since 6 - * @deprecated since 9, please use @ohos.data.preferences instead. * @syscap SystemCapability.DistributedDataManager.Preferences.Core * */ @@ -34,7 +33,6 @@ declare namespace storage { * @return Returns the {@link Storage} instance matching the specified storage file name. * @throws BusinessError if invoked failed * @since 6 - * @deprecated since 9, please use @ohos.data.preferences instead. */ function getStorageSync(path: string): Storage; @@ -53,7 +51,6 @@ declare namespace storage { * @param path Indicates the path of storage file * @throws BusinessError if invoked failed * @since 6 - * @deprecated since 9, please use @ohos.data.preferences instead. */ function deleteStorageSync(path: string): void; function deleteStorage(path: string, callback: AsyncCallback): void; @@ -70,7 +67,6 @@ declare namespace storage { * @param path Indicates the path of storage file. * @throws BusinessError if invoked failed * @since 6 - * @deprecated since 9, please use @ohos.data.preferences instead. */ function removeStorageFromCacheSync(path: string): void; function removeStorageFromCache(path: string, callback: AsyncCallback): void; @@ -87,7 +83,6 @@ declare namespace storage { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * * @since 6 - * @deprecated since 9, please use @ohos.data.preferences instead. */ interface Storage { /** @@ -100,7 +95,6 @@ declare namespace storage { * @return Returns the value matching the specified key if it is found; returns the default value otherwise. * @throws BusinessError if invoked failed * @since 6 - * @deprecated since 9, please use @ohos.data.preferences instead. */ getSync(key: string, defValue: ValueType): ValueType; get(key: string, defValue: ValueType, callback: AsyncCallback): void; @@ -114,7 +108,6 @@ declare namespace storage { * returns {@code false} otherwise. * @throws BusinessError if invoked failed * @since 6 - * @deprecated since 9, please use @ohos.data.preferences instead. */ hasSync(key: string): boolean; has(key: string, callback: AsyncCallback): boolean; @@ -131,7 +124,6 @@ declare namespace storage { * MAX_KEY_LENGTH. * @throws BusinessError if invoked failed * @since 6 - * @deprecated since 9, please use @ohos.data.preferences instead. */ putSync(key: string, value: ValueType): void; put(key: string, value: ValueType, callback: AsyncCallback): void; @@ -147,7 +139,6 @@ declare namespace storage { * MAX_KEY_LENGTH. * @throws BusinessError if invoked failed * @since 6 - * @deprecated since 9, please use @ohos.data.preferences instead. */ deleteSync(key: string): void; delete(key: string, callback: AsyncCallback): void; @@ -161,7 +152,6 @@ declare namespace storage { * * @throws BusinessError if invoked failed * @since 6 - * @deprecated since 9, please use @ohos.data.preferences instead. */ clearSync(): void; clear(callback: AsyncCallback): void; @@ -172,7 +162,6 @@ declare namespace storage { * * @throws BusinessError if invoked failed * @since 6 - * @deprecated since 9, please use @ohos.data.preferences instead. */ flushSync(): void; flush(callback: AsyncCallback): void; @@ -184,7 +173,6 @@ declare namespace storage { * @param callback Indicates the callback when storage changes. * @throws BusinessError if invoked failed * @since 6 - * @deprecated since 9, please use @ohos.data.preferences instead. */ on(type: 'change', callback: Callback): void; @@ -194,7 +182,6 @@ declare namespace storage { * @param callback Indicates the registered callback. * @throws BusinessError if invoked failed * @since 6 - * @deprecated since 9, please use @ohos.data.preferences instead. */ off(type: 'change', callback: Callback): void; } @@ -210,7 +197,6 @@ declare namespace storage { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * * @since 6 - * @deprecated since 9, please use @ohos.data.preferences instead. */ interface StorageObserver { /**