openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2024-10-07 22:24:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add synchronization interface for getPreferences and removePreferencesFromCache

Browse Source 
Signed-off-by: changjiaxing <changjiaxing2@huawei.com>
Change-Id: I7d320565892bca4024a6d3ab2dc32c183448b585
This commit is contained in:
changjiaxing 2023-08-14 10:32:42 +08:00
parent a010579dd5
commit 50c950f52b
1 changed files with 38 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
api/@ohos.data.preferences.d.ts vendored
View File

@ -203,6 +203,25 @@ declare namespace preferences {
*/
function getPreferences(context: Context, options: Options): Promise<Preferences>;
/**
* Obtains a {@link Preferences} instance matching a specified preferences file name.
* This interface is executed synchronously.
* <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 } context - Indicates the context of application or capability.
* @param { Options } options - Indicates the {@link Options} option of preferences file position.
* @returns { Preferences } The {@link Preferences} instance matching the specified preferences file name.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 15501001 - Only supported in stage mode.
* @throws { BusinessError } 15501002 - The data group id is not valid.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
function getPreferencesSync(context: Context, options: Options): Preferences;
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache which is performed by removePreferencesFromCache and deletes the
@ -435,6 +454,25 @@ declare namespace preferences {
*/
function removePreferencesFromCacheSync(context: Context, name: string): void;
/**
* Deletes a {@link Preferences} instance matching a specified preferences file name
* from the cache. This interface is executed synchronously.
* <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 } context - Indicates the context of application or capability.
* @param { Options } options - Indicates the {@link Options} option of preferences file position.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 15501001 - Only supported in stage mode.
* @throws { BusinessError } 15501002 - The data group id is not valid.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
* @crossplatform
* @since 10
*/
function removePreferencesFromCacheSync(context: Context, options: Options): 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.