diff --git a/api/@ohos.data.preferences.d.ts b/api/@ohos.data.preferences.d.ts
index 7355e75a0dffcc60643dba1a72af1d1b431e7225..3129833c98c3b9a78b72c6a1d97e84a109957683 100644
--- a/api/@ohos.data.preferences.d.ts
+++ b/api/@ohos.data.preferences.d.ts
@@ -12,7 +12,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-import { AsyncCallback, Callback } from './basic';
+import {AsyncCallback, Callback} from './basic';
import Context from "./application/Context";
/**
@@ -30,13 +30,27 @@ declare namespace preferences {
*
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 9
+ * @param {Context} context - Indicates the context of application or capability.
+ * @param {string} name - Indicates the preferences file name.
+ * @param {AsyncCallback} callback - the {@link Preferences} instance matching the specified
+ * preferences file name.
+ * @throws {BusinessError} 401 - if the parameter type is incorrect.
+ * @since 9
*/
function getPreferences(context: Context, name: string, callback: AsyncCallback): void;
+
+ /**
+ * 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} context - Indicates the context of application or capability.
+ * @param {string} name - Indicates the preferences file name.
+ * @returns {Promise} the {@link Preferences} instance matching the specified preferences file name.
+ * @throws {BusinessError} 401 - if the parameter type is incorrect.
+ * @since 9
+ */
function getPreferences(context: Context, name: string): Promise;
/**
@@ -48,12 +62,31 @@ declare namespace preferences {
* 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
+ * @param {Context} context - Indicates the context of application or capability.
+ * @param {string} name - Indicates the preferences file name.
+ * @param {AsyncCallback} callback - Indicates the callback function.
+ * @throws {BusinessError} 401 - if the parameter type is incorrect.
+ * @throws {BusinessError} 15500010 - if failed to delete preferences file.
* @since 9
*/
function deletePreferences(context: Context, name: string, callback: AsyncCallback): void;
+
+ /**
+ * 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} context - Indicates the context of application or capability.
+ * @param {string} name - Indicates the preferences file name.
+ * @returns {Promise} a promise object.
+ * @throws {BusinessError} 401 - if the parameter type is incorrect.
+ * @throws {BusinessError} 15500010 - if failed to delete preferences file.
+ * @since 9
+ */
function deletePreferences(context: Context, name: string): Promise;
/**
@@ -64,12 +97,28 @@ declare namespace preferences {
* 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
+ * @param {Context} context - Indicates the context of application or capability.
+ * @param {string} name - Indicates the preferences file name.
+ * @param {AsyncCallback} callback - Indicates the callback function.
+ * @throws {BusinessError} 401 - if the parameter type is incorrect.
* @since 9
*/
function removePreferencesFromCache(context: Context, name: string, callback: AsyncCallback): void;
+
+ /**
+ * 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} context - Indicates the context of application or capability.
+ * @param {string} name - Indicates the preferences file name.
+ * @returns {Promise} a promise object.
+ * @throws {BusinessError} 401 - if the parameter type is incorrect.
+ * @since 9
+ */
function removePreferencesFromCache(context: Context, name: string): Promise;
/**
@@ -77,7 +126,7 @@ declare namespace preferences {
*
*
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
+ * the file that stores preferences data, and use movePreferencesFromCache
* to remove the {@link Preferences} instance from the memory.
*
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
@@ -86,39 +135,71 @@ declare namespace preferences {
*/
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 9
- */
+ * 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 {string} key - Indicates the key of the preferences. It cannot be {@code null} or empty.
+ * @param {ValueType} defValue - Indicates the default value to return.
+ * @param {AsyncCallback} callback - the value matching the specified key if it is found;
+ * returns the default value otherwise.
+ * @throws {BusinessError} 401 - if the parameter type is incorrect.
+ * @since 9
+ */
get(key: string, defValue: ValueType, callback: AsyncCallback): void;
+
+ /**
+ * 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 {string} key - Indicates the key of the preferences. It cannot be {@code null} or empty.
+ * @param {ValueType} defValue - Indicates the default value to return.
+ * @returns {Promise} the value matching the specified key if it is found;
+ * returns the default value otherwise.
+ * @throws {BusinessError} 401 - if the parameter type is incorrect.
+ * @since 9
+ */
get(key: string, defValue: ValueType): Promise;
/**
- * Obtains all the keys and values of a preferences in an object.
- *
- * @return Returns the values and keys in an object.
- * @throws BusinessError if invoked failed
- * @since 9
- */
+ * Obtains all the keys and values of a preferences in an object.
+ *
+ * @param {AsyncCallback