openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2025-03-01 13:46:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Changes storage to preferences

Browse Source 
Signed-off-by: PaDaBoo <xuejianwu@huawei.com>
This commit is contained in:
PaDaBoo 2022-02-21 17:32:43 +08:00
parent f0f66970a7
commit b1588f3091
2 changed files with 214 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

199
api/@ohos.data.preferences.d.ts vendored Normal file
View File

@ -0,0 +1,199 @@
/*
* 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.
*
* <p>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<Preferences>): void;
function getPreferences(context: Context, name: string): Promise<Preferences>;
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache which is performed by removePreferencesFromCache and deletes the
* preferences file.
*
* <p>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>): void;
function deletePreferences(context: Context, name: string): Promise<void>;
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache.
*
* <p>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>): void;
function removePreferencesFromCache(context: Context, name: string): Promise<void>;
/**
* Provides interfaces to obtain and modify preferences data.
*
* <p>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.
*
* <p>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<ValueType>): void;
get(key: string, defValue: ValueType): Promise<ValueType>;
/**
* 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>): boolean;
has(key: string): Promise<boolean>;
/**
* Sets an int value for the key in the {@link Preferences} object.
*
* <p>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.
* <tt>MAX_KEY_LENGTH</tt>.
* @throws BusinessError if invoked failed
* @since 8
*/
put(key: string, value: ValueType, callback: AsyncCallback<void>): void;
put(key: string, value: ValueType): Promise<void>;
/**
* Deletes the preferences with a specified key from the {@link Preferences} object.
*
* <p>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.
* <tt>MAX_KEY_LENGTH</tt>.
* @throws BusinessError if invoked failed
* @since 8
*/
delete(key: string, callback: AsyncCallback<void>): void;
delete(key: string): Promise<void>;
/**
* Clears all preferences from the {@link Preferences} object.
*
* <p>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>): void;
clear(): Promise<void>;
/**
* Asynchronously saves the {@link Preferences} object to the file.
*
* @throws BusinessError if invoked failed
* @since 8
*/
flush(callback: AsyncCallback<void>): void;
flush(): Promise<void>;
/**
* 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;

15
api/@ohos.data.storage.d.ts vendored
View File

@ -19,6 +19,7 @@ import { AsyncCallback, Callback } from './basic';
*
* @name storage
* @since 5
* @deprecated since 8, please use @ohos.data.preferences instead.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
*
*/
@ -33,7 +34,9 @@ declare namespace storage {
* @return Returns the {@link Storage} instance matching the specified storage file name.
* @throws BusinessError if invoked failed
* @since 5
* @deprecated since 8, please use @ohos.data.preferences instead.
*/
function getStorageSync(path: string): Storage;
function getStorage(path: string, callback: AsyncCallback<Storage>): void;
function getStorage(path: string): Promise<Storage>;
@ -50,6 +53,7 @@ declare namespace storage {
* @param path Indicates the path of storage file
* @throws BusinessError if invoked failed
* @since 5
* @deprecated since 8, please use @ohos.data.preferences instead.
*/
function deleteStorageSync(path: string): void;
function deleteStorage(path: string, callback: AsyncCallback<void>): void;
@ -66,6 +70,7 @@ declare namespace storage {
* @param path Indicates the path of storage file.
* @throws BusinessError if invoked failed
* @since 5
* @deprecated since 8, please use @ohos.data.preferences instead.
*/
function removeStorageFromCacheSync(path: string): void;
function removeStorageFromCache(path: string, callback: AsyncCallback<void>): void;
@ -82,6 +87,7 @@ declare namespace storage {
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
*
* @since 5
* @deprecated since 8, please use @ohos.data.preferences instead.
*/
interface Storage {
/**
@ -94,6 +100,7 @@ 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 5
* @deprecated since 8, please use @ohos.data.preferences instead.
*/
getSync(key: string, defValue: ValueType): ValueType;
get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>): void;
@ -107,6 +114,7 @@ declare namespace storage {
* returns {@code false} otherwise.
* @throws BusinessError if invoked failed
* @since 5
* @deprecated since 8, please use @ohos.data.preferences instead.
*/
hasSync(key: string): boolean;
has(key: string, callback: AsyncCallback<boolean>): boolean;
@ -123,6 +131,7 @@ declare namespace storage {
* <tt>MAX_KEY_LENGTH</tt>.
* @throws BusinessError if invoked failed
* @since 5
* @deprecated since 8, please use @ohos.data.preferences instead.
*/
putSync(key: string, value: ValueType): void;
put(key: string, value: ValueType, callback: AsyncCallback<void>): void;
@ -138,6 +147,7 @@ declare namespace storage {
* <tt>MAX_KEY_LENGTH</tt>.
* @throws BusinessError if invoked failed
* @since 5
* @deprecated since 8, please use @ohos.data.preferences instead.
*/
deleteSync(key: string): void;
delete(key: string, callback: AsyncCallback<void>): void;
@ -151,6 +161,7 @@ declare namespace storage {
*
* @throws BusinessError if invoked failed
* @since 5
* @deprecated since 8, please use @ohos.data.preferences instead.
*/
clearSync(): void;
clear(callback: AsyncCallback<void>): void;
@ -161,6 +172,7 @@ declare namespace storage {
*
* @throws BusinessError if invoked failed
* @since 5
* @deprecated since 8, please use @ohos.data.preferences instead.
*/
flushSync(): void;
flush(callback: AsyncCallback<void>): void;
@ -172,6 +184,7 @@ declare namespace storage {
* @param callback Indicates the callback when storage changes.
* @throws BusinessError if invoked failed
* @since 5
* @deprecated since 8, please use @ohos.data.preferences instead.
*/
on(type: 'change', callback: Callback<StorageObserver>): void;
@ -181,6 +194,7 @@ declare namespace storage {
* @param callback Indicates the registered callback.
* @throws BusinessError if invoked failed
* @since 5
* @deprecated since 8, please use @ohos.data.preferences instead.
*/
off(type: 'change', callback: Callback<StorageObserver>): void;
}
@ -196,6 +210,7 @@ declare namespace storage {
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
*
* @since 5
* @deprecated since 8, please use @ohos.data.preferences instead.
*/
interface StorageObserver {
/**