From 5dc3992eb21dc14f9a6c334f71b559245ad4ef47 Mon Sep 17 00:00:00 2001 From: yangliu Date: Tue, 15 Feb 2022 16:06:56 +0800 Subject: [PATCH] Signed-off-by: yangliu Changes to be committed: modified: api/@ohos.data.dataAbility.d.ts modified: api/@ohos.data.distributedData.d.ts modified: api/@ohos.data.distributedDataObject.d.ts modified: api/@ohos.data.rdb.d.ts modified: api/@ohos.data.storage.d.ts modified: api/data/rdb/resultSet.d.ts --- api/@ohos.data.dataAbility.d.ts | 96 ++--- api/@ohos.data.distributedData.d.ts | 479 ++++++++-------------- api/@ohos.data.distributedDataObject.d.ts | 26 +- api/@ohos.data.rdb.d.ts | 181 +++----- api/@ohos.data.storage.d.ts | 12 +- api/data/rdb/resultSet.d.ts | 72 ++-- 6 files changed, 287 insertions(+), 579 deletions(-) diff --git a/api/@ohos.data.dataAbility.d.ts b/api/@ohos.data.dataAbility.d.ts index a2bf9e193..260afab40 100644 --- a/api/@ohos.data.dataAbility.d.ts +++ b/api/@ohos.data.dataAbility.d.ts @@ -19,8 +19,7 @@ import rdb from './@ohos.data.rdb'; * Provides predicates for implementing diverse query methods. * * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @import import data_dataAbility from '@ohos.data.dataAbility'; * @permission N/A */ @@ -30,8 +29,7 @@ declare namespace dataAbility { * * @note This method is similar to = of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param name Indicates the table name. * @param dataAbilityPredicates Indicates the dataAbility predicates. * @return Returns an RdbPredicates. @@ -42,8 +40,7 @@ declare namespace dataAbility { * Manages relational database configurations. * * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @import import data_dataAbility from '@ohos.data.dataAbility'; * @permission N/A */ @@ -54,8 +51,7 @@ declare namespace dataAbility { * * @note This method is similar to = of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name in the database table. * @param value Indicates the value to match with the DataAbilityPredicates. * @return Returns the DataAbilityPredicates that match the specified field. @@ -68,8 +64,7 @@ declare namespace dataAbility { * * @note This method is similar to != of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name in the database table. * @param value Indicates the value to match with the DataAbilityPredicates. * @return Returns the DataAbilityPredicates that match the specified field. @@ -81,8 +76,7 @@ declare namespace dataAbility { * * @note This method is similar to ( of the SQL statement and needs to be used together with endWrap(). * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @return Returns the DataAbilityPredicates with the left parenthesis. */ beginWrap(): DataAbilityPredicates; @@ -93,8 +87,7 @@ declare namespace dataAbility { * @note This method is similar to ) of the SQL statement and needs to be used together * with beginWrap(). * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @return Returns the DataAbilityPredicates with the right parenthesis. */ endWrap(): DataAbilityPredicates; @@ -104,8 +97,7 @@ declare namespace dataAbility { * * @note This method is similar to or of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @return Returns the DataAbilityPredicates with the or condition. */ or(): DataAbilityPredicates; @@ -115,8 +107,7 @@ declare namespace dataAbility { * * @note This method is similar to and of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @return Returns the DataAbilityPredicates with the and condition. */ and(): DataAbilityPredicates; @@ -127,8 +118,7 @@ declare namespace dataAbility { * * @note This method is similar to contains of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name in the database table. * @param value Indicates the value to match with the DataAbilityPredicates. * @return Returns the DataAbilityPredicates that match the specified field. @@ -141,8 +131,7 @@ declare namespace dataAbility { * * @note This method is similar to value% of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name in the database table. * @param value Indicates the value to match with the DataAbilityPredicates. * @return Returns the DataAbilityPredicates that match the specified field. @@ -155,8 +144,7 @@ declare namespace dataAbility { * * @note This method is similar to %value of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name in the database table. * @param value Indicates the value to match with the DataAbilityPredicates. * @return Returns the DataAbilityPredicates that match the specified field. @@ -168,8 +156,7 @@ declare namespace dataAbility { * * @note This method is similar to is null of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name in the database table. * @return Returns the DataAbilityPredicates that match the specified field. */ @@ -180,8 +167,7 @@ declare namespace dataAbility { * * @note This method is similar to is not null of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name in the database table. * @return Returns the DataAbilityPredicates that match the specified field. */ @@ -193,8 +179,7 @@ declare namespace dataAbility { * * @note This method is similar to like of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name in the database table. * @param value Indicates the value to match with the DataAbilityPredicates. The percent sign (%) in the value * is a wildcard (like * in a regular expression). @@ -208,8 +193,7 @@ declare namespace dataAbility { * * @note Different from like, the input parameters of this method are case-sensitive. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name in the database table. * @param value Indicates the value to match with DataAbilityPredicates. * @return Returns the SQL statement with the specified DataAbilityPredicates. @@ -221,8 +205,7 @@ declare namespace dataAbility { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name. * @param low Indicates the minimum value. * @param high Indicates the maximum value. @@ -236,8 +219,7 @@ declare namespace dataAbility { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name in the database table. * @param low Indicates the minimum value to match with DataAbilityPredicates}. * @param high Indicates the maximum value to match with DataAbilityPredicates}. @@ -250,8 +232,7 @@ declare namespace dataAbility { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name. * @param value Indicates the String field. * @return Returns the SQL query statement with the specified DataAbilityPredicates. @@ -263,8 +244,7 @@ declare namespace dataAbility { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name. * @param value Indicates the String field. * @return Returns the SQL query statement with the specified DataAbilityPredicates. @@ -276,8 +256,7 @@ declare namespace dataAbility { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name. * @param value Indicates the String field. * @return Returns the SQL query statement with the specified DataAbilityPredicates. @@ -289,8 +268,7 @@ declare namespace dataAbility { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name. * @param value Indicates the String field. * @return Returns the SQL query statement with the specified DataAbilityPredicates. @@ -303,8 +281,7 @@ declare namespace dataAbility { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name for sorting the return list. * @return Returns the SQL query statement with the specified DataAbilityPredicates. */ @@ -316,8 +293,7 @@ declare namespace dataAbility { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name for sorting the return list. * @return Returns the SQL query statement with the specified DataAbilityPredicates. */ @@ -328,8 +304,7 @@ declare namespace dataAbility { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @return Returns the SQL query statement with the specified DataAbilityPredicates. */ distinct(): DataAbilityPredicates; @@ -339,8 +314,7 @@ declare namespace dataAbility { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param value Indicates the max length of the return list. * @return Returns the SQL query statement with the specified DataAbilityPredicates. * @throws IllegalPredicateException Throws this exception if DataAbilityPredicates are added to a wrong position. @@ -352,8 +326,7 @@ declare namespace dataAbility { * * @note Use this method together with limit(int). * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param rowOffset Indicates the start position of the returned result. The value is a positive integer. * @return Returns the SQL query statement with the specified AbsPredicates. */ @@ -364,8 +337,7 @@ declare namespace dataAbility { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param fields Indicates the specified columns by which query results are grouped. * @return Returns the DataAbilityPredicates with the specified columns by which query results are grouped. */ @@ -376,8 +348,7 @@ declare namespace dataAbility { * * @note Before using this method, you need to create an index column. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param indexName Indicates the name of the index column. * @return Returns DataAbilityPredicates with the specified index column. */ @@ -389,8 +360,7 @@ declare namespace dataAbility { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name in the database table. * @param values Indicates the values to match with DataAbilityPredicates. * @return Returns DataAbilityPredicates that matches the specified field. @@ -403,8 +373,7 @@ declare namespace dataAbility { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @param field Indicates the column name in the database table. * @param values Indicates the values to match with DataAbilityPredicates. * @return Returns DataAbilityPredicates that matches the specified field. @@ -414,8 +383,7 @@ declare namespace dataAbility { /** * Indicates possible value types * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @import import data_rdb from '@ohos.data.rdb'; * @permission N/A */ diff --git a/api/@ohos.data.distributedData.d.ts b/api/@ohos.data.distributedData.d.ts index efc483eb3..220ac0194 100644 --- a/api/@ohos.data.distributedData.d.ts +++ b/api/@ohos.data.distributedData.d.ts @@ -17,8 +17,7 @@ import { AsyncCallback, Callback } from './basic'; /** * Providers interfaces to creat a {@link KVManager} istances. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -28,8 +27,7 @@ declare namespace distributedData { * Provides configuration information for {@link KVManager} instances, * including the caller's package name and distributed network type. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -37,8 +35,7 @@ declare namespace distributedData { /** * Indicates the user information * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -47,8 +44,7 @@ declare namespace distributedData { /** * Indicates the bundleName * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -62,8 +58,7 @@ declare namespace distributedData { * and checking whether two users are the same. * * @since 7 - * @SYscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -71,8 +66,7 @@ declare namespace distributedData { /** * Indicates the user ID to set * @since 7 - * @SYscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -81,8 +75,7 @@ declare namespace distributedData { /** * Indicates the user type to set * @since 7 - * @SYscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -93,8 +86,7 @@ declare namespace distributedData { * Enumerates user types. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -102,8 +94,7 @@ declare namespace distributedData { /** * Indicates a user that logs in to different devices using the same account. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -113,8 +104,7 @@ declare namespace distributedData { /** * KVStore constants * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -122,8 +112,7 @@ declare namespace distributedData { /** * max key length. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -132,8 +121,7 @@ declare namespace distributedData { /** * max value length. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -142,8 +130,7 @@ declare namespace distributedData { /** * max device coordinate key length. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -152,8 +139,7 @@ declare namespace distributedData { /** * max store id length. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -162,8 +148,7 @@ declare namespace distributedData { /** * max query length. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -172,8 +157,7 @@ declare namespace distributedData { /** * max batch operation size. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -186,8 +170,7 @@ declare namespace distributedData { *

{@code ValueType} is obtained based on the value. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -195,8 +178,7 @@ declare namespace distributedData { /** * Indicates that the value type is string. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -205,8 +187,7 @@ declare namespace distributedData { /** * Indicates that the value type is int. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -215,8 +196,7 @@ declare namespace distributedData { /** * Indicates that the value type is float. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -225,8 +205,7 @@ declare namespace distributedData { /** * Indicates that the value type is byte array. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A * */ @@ -235,8 +214,7 @@ declare namespace distributedData { /** * Indicates that the value type is boolean. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A * */ @@ -245,8 +223,7 @@ declare namespace distributedData { /** * Indicates that the value type is double. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -257,8 +234,7 @@ declare namespace distributedData { * Obtains {@code Value} objects stored in a {@link KVStore} database. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -266,8 +242,7 @@ declare namespace distributedData { /** * Indicates value type * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A * @see ValueType @@ -278,8 +253,7 @@ declare namespace distributedData { /** * Indicates value * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -290,8 +264,7 @@ declare namespace distributedData { * Provides key-value pairs stored in the distributed database. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -299,8 +272,7 @@ declare namespace distributedData { /** * Indicates key * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -308,8 +280,7 @@ declare namespace distributedData { /** * Indicates value * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -323,8 +294,7 @@ declare namespace distributedData { * from the parameters in callback methods upon data insertion, update, or deletion. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -332,8 +302,7 @@ declare namespace distributedData { /** * Indicates data addition records. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -341,8 +310,7 @@ declare namespace distributedData { /** * Indicates data update records. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -350,8 +318,7 @@ declare namespace distributedData { /** * Indicates data deletion records. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -359,8 +326,7 @@ declare namespace distributedData { /** * Indicates from device id. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -371,8 +337,7 @@ declare namespace distributedData { * Indicates the database synchronization mode. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -380,8 +345,7 @@ declare namespace distributedData { /** * Indicates that data is only pulled from the remote end. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -389,8 +353,7 @@ declare namespace distributedData { /** * Indicates that data is only pushed from the local end. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -398,8 +361,7 @@ declare namespace distributedData { /** * Indicates that data is pushed from the local end, and then pulled from the remote end. * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -410,8 +372,7 @@ declare namespace distributedData { * Describes the subscription type. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -419,8 +380,7 @@ declare namespace distributedData { /** * Subscription to local data changes * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -429,8 +389,7 @@ declare namespace distributedData { /** * Subscription to remote data changes * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -439,8 +398,7 @@ declare namespace distributedData { /** * Subscription to both local and remote data changes * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -451,8 +409,7 @@ declare namespace distributedData { * Describes the {@code KVStore} type. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -460,8 +417,7 @@ declare namespace distributedData { /** * Device-collaborated database, as specified by {@code DeviceKVStore} * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -470,8 +426,7 @@ declare namespace distributedData { /** * Single-version database, as specified by {@code SingleKVStore} * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -480,8 +435,7 @@ declare namespace distributedData { /** * Multi-version database, as specified by {@code MultiKVStore} * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -492,8 +446,7 @@ declare namespace distributedData { * Describes the {@code KVStore} type. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -502,8 +455,7 @@ declare namespace distributedData { * NO_LEVEL: mains not set the security level. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -514,8 +466,7 @@ declare namespace distributedData { * There is no impact even if the data is leaked. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -526,8 +477,7 @@ declare namespace distributedData { * There are some low impact, when the data is leaked. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -538,8 +488,7 @@ declare namespace distributedData { * There are some major impact, when the data is leaked. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -550,8 +499,7 @@ declare namespace distributedData { * There are some severity impact, when the data is leaked. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -562,8 +510,7 @@ declare namespace distributedData { * There are some critical impact, when the data is leaked. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -577,8 +524,7 @@ declare namespace distributedData { * whether to encrypt the database, and the database type. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -586,8 +532,7 @@ declare namespace distributedData { /** * Indicates whether to createa database when the database file does not exist * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -595,8 +540,7 @@ declare namespace distributedData { /** * Indicates setting whether database files are encrypted * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -604,8 +548,7 @@ declare namespace distributedData { /** * Indicates setting whether to back up database files * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -613,8 +556,7 @@ declare namespace distributedData { /** * Indicates setting whether database files are automatically synchronized * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -622,8 +564,7 @@ declare namespace distributedData { /** * Indicates setting the databse type * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -631,8 +572,7 @@ declare namespace distributedData { /** * Indicates setting the database security level * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -645,8 +585,7 @@ declare namespace distributedData { * You can create Schema objects and put them in Options when creating or opening the database. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -656,8 +595,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore */ constructor() /** @@ -665,8 +603,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @returns Returns the schema in json format. */ toJsonString():string; @@ -682,8 +619,7 @@ declare namespace distributedData { *

The leaf node must have a value; the non-leaf node must have a child {@code FieldNode}. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -694,8 +630,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore */ constructor(name: string) /** @@ -705,8 +640,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param child The field node to append. * @returns Returns true if the child node is successfully added to this {@code FieldNode}; returns false otherwise. */ @@ -716,8 +650,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @returns Returns the field name. */ toJson(): string; @@ -730,8 +663,7 @@ declare namespace distributedData { * methods for moving the data read position in the result set. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -741,8 +673,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @returns Returns the number of lines. */ getCount(): number; @@ -751,8 +682,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @returns Returns the current read position. The read position starts with 0. */ getPosition(): number; @@ -762,8 +692,7 @@ declare namespace distributedData { *

If the result set is empty, false is returned. * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @returns Returns true if the operation succeeds; return false otherwise. */ moveToFirst(): boolean; @@ -773,8 +702,7 @@ declare namespace distributedData { *

If the result set is empty, false is returned. * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @returns Returns true if the operation succeeds; return false otherwise. */ moveToLast(): boolean; @@ -784,8 +712,7 @@ declare namespace distributedData { *

If the result set is empty or the data in the last line is being read, false is returned. * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @returns Returns true if the operation succeeds; return false otherwise. */ moveToNext(): boolean; @@ -795,8 +722,7 @@ declare namespace distributedData { *

If the result set is empty or the data in the first line is being read, false is returned. * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @returns Returns true if the operation succeeds; return false otherwise. */ moveToPrevious(): boolean; @@ -805,8 +731,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param offset Indicates the relative offset to the current position. Anegative offset indicates moving backwards, and a * positive offset indicates moving forewards. Forexample, if the current position is entry 1 and thisoffset is 2, * the destination position will be entry 3; ifthe current position is entry 3 and this offset is -2, @@ -820,8 +745,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param position Indicates the absolute position. * @returns Returns true if the operation succeeds; return false otherwise. */ @@ -831,8 +755,8 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @returns Returns true if the read position is the first line; returns false otherwise. */ isFirst(): boolean; @@ -840,8 +764,7 @@ declare namespace distributedData { * Checks whether the read position is the last line. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @returns Returns true if the read position is the last line; returns false otherwise. */ isLast(): boolean; @@ -849,8 +772,7 @@ declare namespace distributedData { * Checks whether the read position is before the last line. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @returns Returns true if the read position is before the first line; returns false otherwise. */ isBeforeFirst(): boolean; @@ -858,8 +780,7 @@ declare namespace distributedData { * Checks whether the read position is after the last line. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @returns Returns true if the read position is after the last line; returns false otherwise. */ isAfterLast(): boolean; @@ -867,8 +788,7 @@ declare namespace distributedData { * Obtains a key-value pair. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @returns Returns a key-value pair. */ getEntry(): Entry; @@ -883,8 +803,7 @@ declare namespace distributedData { *

This class also provides methods for adding predicates to the {@code Query} instance. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -894,16 +813,14 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore */ constructor() /** * Resets this {@code Query} object. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @returns Returns the reset {@code Query} object. */ @@ -912,8 +829,7 @@ declare namespace distributedData { * Constructs a {@code Query} object to query entries with the specified field whose value is equal to the specified long value. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param field Indicates the field, which must start with $. and cannot contain ^. * @param value IIndicates the long value. @@ -925,8 +841,7 @@ declare namespace distributedData { * Constructs a {@code Query} object to query entries with the specified field whose value is not equal to the specified int value. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param field Indicates the field, which must start with $. and cannot contain ^. * @param value Indicates the int value. @@ -939,8 +854,7 @@ declare namespace distributedData { * specified int value. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param field Indicates the field, which must start with $. and cannot contain ^. * @param value Indicates the int value. @@ -952,8 +866,7 @@ declare namespace distributedData { * Constructs a {@code Query} object to query entries with the specified field whose value is less than the specified int value. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param field Indicates the field, which must start with $. and cannot contain ^. * @param value Indicates the int value. @@ -965,8 +878,7 @@ declare namespace distributedData { * Constructs a {@code Query} object to query entries with the specified field whose value is greater than or equal to the * specified int value. * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param field Indicates the field, which must start with $. and cannot contain ^. * @param value Indicates the int value. @@ -979,8 +891,7 @@ declare namespace distributedData { * specified int value. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param field Indicates the field, which must start with $. and cannot contain ^. * @param value Indicates the int value. @@ -992,8 +903,7 @@ declare namespace distributedData { * Constructs a {@code Query} object to query entries with the specified field whose value is null. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param field Indicates the field, which must start with $. and cannot contain ^. * @returns Returns the {@coed Query} object. @@ -1004,8 +914,7 @@ declare namespace distributedData { * Constructs a {@code Query} object to query entries with the specified field whose value is within the specified int value list. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param field Indicates the field, which must start with $. and cannot contain ^. * @param valueList Indicates the int value list. @@ -1016,8 +925,8 @@ declare namespace distributedData { /** * Constructs a {@code Query} object to query entries with the specified field whose value is within the specified string value list. * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @import N/A * @param field Indicates the field, which must start with $. and cannot contain ^. * @param valueList Indicates the string value list. @@ -1028,8 +937,7 @@ declare namespace distributedData { /** * Constructs a {@code Query} object to query entries with the specified field whose value is not within the specified int value list. * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param field Indicates the field, which must start with $. and cannot contain ^. * @param valueList Indicates the int value list. @@ -1041,8 +949,7 @@ declare namespace distributedData { * Constructs a {@code Query} object to query entries with the specified field whose value is not within the specified string value list. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param field Indicates the field, which must start with $. and cannot contain ^. * @param valueList Indicates the string value list. @@ -1054,8 +961,7 @@ declare namespace distributedData { * Constructs a {@code Query} object to query entries with the specified field whose value is similar to the specified string value. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param field Indicates the field, which must start with $. and cannot contain ^. * @param value Indicates the string value. @@ -1067,8 +973,7 @@ declare namespace distributedData { * Constructs a {@code Query} object to query entries with the specified field whose value is not similar to the specified string value. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param field Indicates the field, which must start with $. and cannot contain ^. * @param value Indicates the string value. @@ -1082,8 +987,7 @@ declare namespace distributedData { *

Multiple predicates should be connected using the and or or condition. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @returns Returns the {@coed Query} object. */ @@ -1094,8 +998,7 @@ declare namespace distributedData { *

Multiple predicates should be connected using the and or or condition. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @returns Returns the {@coed Query} object. */ @@ -1104,8 +1007,7 @@ declare namespace distributedData { * Constructs a {@code Query} object to sort the query results in ascending order. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param field Indicates the field, which must start with $. and cannot contain ^. * @returns Returns the {@coed Query} object. @@ -1116,8 +1018,7 @@ declare namespace distributedData { * Constructs a {@code Query} object to sort the query results in descending order. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param field Indicates the field, which must start with $. and cannot contain ^. * @returns Returns the {@coed Query} object. @@ -1128,8 +1029,7 @@ declare namespace distributedData { * Constructs a {@code Query} object to specify the number of results and the start position. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param total Indicates the number of results. * @param offset Indicates the start position. @@ -1140,8 +1040,7 @@ declare namespace distributedData { * Creates a {@code query} condition with a specified field that is not null. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param field Indicates the specified field. * @returns Returns the {@coed Query} object. @@ -1155,8 +1054,7 @@ declare namespace distributedData { * whole to combine with other query conditions. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @returns Returns the {@coed Query} object. */ @@ -1168,8 +1066,7 @@ declare namespace distributedData { * whole to combine with other query conditions. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @returns Returns the {@coed Query} object. */ @@ -1178,8 +1075,7 @@ declare namespace distributedData { * Creates a query condition with a specified key prefix. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param prefix Indicates the specified key prefix. * @returns Returns the {@coed Query} object. @@ -1190,8 +1086,7 @@ declare namespace distributedData { * Sets a specified index that will be preferentially used for query. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param index Indicates the index to set. * @returns Returns the {@coed Query} object. @@ -1202,8 +1097,7 @@ declare namespace distributedData { * Add device ID key prefix.Used by {@code DeviceKVStore}. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param deviceId Specify device id to query from. * @return Returns the {@code Query} object with device ID prefix added. @@ -1217,8 +1111,7 @@ declare namespace distributedData { * The String length should be no longer than 500kb. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @return String representing this {@code Query}. */ @@ -1234,8 +1127,7 @@ declare namespace distributedData { * including {@code SingleKVStore}. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A * @version 1 @@ -1248,8 +1140,7 @@ declare namespace distributedData { * * @note N/A * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param key Indicates the key. The length must be less than {@code MAX_KEY_LENGTH}. * Spaces before and after the key will be cleared. * @param value Indicates the string value, which must be less than 4 MB as a UTF-8 byte array. @@ -1265,8 +1156,7 @@ declare namespace distributedData { * * @note N/A * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param key Indicates the key. The length must be less than {@code MAX_KEY_LENGTH}. * Spaces before and after the key will be cleared. * @throws Throws this exception if any of the following errors @@ -1282,8 +1172,7 @@ declare namespace distributedData { * * @note N/A * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param type Indicates the subscription type, which is defined in {@code SubscribeType}. * @param observer Indicates the observer of data change events in the distributed database. * @throws Throws this exception if any of the following errors @@ -1297,8 +1186,7 @@ declare namespace distributedData { * * @note N/A * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @throws Throws this exception if any of the following errors * occurs: {@code SERVER_UNAVAILABLE}, {@code IPC_ERROR}, * {@code DB_ERROR}, and {@code STORE_ALREADY_SUBSCRIBE}. @@ -1310,8 +1198,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param observer Indicates the data change observer registered by {#subscribe(SubscribeType, KvStoreObserver)}. * @throws Throws this exception if any of the following errors * occurs: {@code SERVER_UNAVAILABLE}, {@code IPC_ERROR}, @@ -1324,8 +1211,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param entries Indicates the key-value pairs to be inserted in batches. * @throws Throws this exception if a database error occurs. */ @@ -1337,8 +1223,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param keys Indicates the key-value pairs to be deleted in batches. * @throws Throws this exception if a database error occurs. */ @@ -1352,8 +1237,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @throws Throws this exception if a database error occurs. */ startTransaction(callback: AsyncCallback): void; @@ -1364,8 +1248,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param callback * @throws Throws this exception if a database error occurs. */ @@ -1377,8 +1260,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @throws Throws this exception if a database error occurs. */ rollback(callback: AsyncCallback): void; @@ -1389,8 +1271,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param enabled Specifies whether to enable synchronization. The value true means to enable * synchronization, and false means the opposite. * @throws Throws this exception if an internal service error occurs. @@ -1405,8 +1286,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param localLabels Indicates the synchronization labels of the local device. * @param remoteSupportLabels Indicates the labels of the devices with which data will be synchronized. * @throws Throws this exception if an internal service error occurs. @@ -1426,8 +1306,7 @@ declare namespace distributedData { * synchronous transactions, or data search using snapshots. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A * @version 1 @@ -1437,8 +1316,7 @@ declare namespace distributedData { * Obtains the {@code String} value of a specified key. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param key Indicates the key of the boolean value to be queried. * @throws Throws this exception if any of the following errors occurs:{@code INVALID_ARGUMENT}, @@ -1451,8 +1329,7 @@ declare namespace distributedData { * Obtains all key-value pairs that match a specified key prefix. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param keyPrefix Indicates the key prefix to match. * @returns Returns the list of all key-value pairs that match the specified key prefix. @@ -1466,8 +1343,7 @@ declare namespace distributedData { * Obtains the list of key-value pairs matching the specified {@code Query} object. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param query Indicates the {@code Query} object. * @returns Returns the list of key-value pairs matching the specified {@code Query} object. @@ -1485,8 +1361,7 @@ declare namespace distributedData { * in a timely manner. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param keyPrefix Indicates the key prefix to match. * @throws Throws this exception if any of the following errors occurs:{@code INVALID_ARGUMENT}, @@ -1499,8 +1374,7 @@ declare namespace distributedData { * Obtains the {@code KvStoreResultSet} object matching the specified {@code Query} object. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param query Indicates the {@code Query} object. * @throws Throws this exception if any of the following errors occurs:{@code INVALID_ARGUMENT}, @@ -1513,8 +1387,7 @@ declare namespace distributedData { * Closes a {@code KvStoreResultSet} object returned by getResultSet. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param resultSet Indicates the {@code KvStoreResultSet} object to close. * @throws Throws this exception if any of the following errors occurs:{@code INVALID_ARGUMENT}, @@ -1527,8 +1400,7 @@ declare namespace distributedData { * Obtains the number of results matching the specified {@code Query} object. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @param query Indicates the {@code Query} object. * @returns Returns the number of results matching the specified {@code Query} object. @@ -1542,8 +1414,7 @@ declare namespace distributedData { * void removeDeviceData​({@link String} deviceId) throws {@link KvStoreException} * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A */ removeDeviceData(deviceId: string, callback: AsyncCallback): void; @@ -1554,8 +1425,7 @@ declare namespace distributedData { * * @note N/A * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param deviceIdList Indicates the list of devices to which to synchronize the database. * @param mode Indicates the synchronization mode. The value can be {@code PUSH}, {@code PULL}, or {@code PUSH_PULL}. * @param allowedDelayMs Indicates the delay allowed for the synchronization, in milliseconds. @@ -1571,8 +1441,7 @@ declare namespace distributedData { *

Sync result is returned through asynchronous callback. * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param syncCallback Indicates the callback used to send the synchronization result to the caller. * @throws Throws this exception if no {@code SingleKvStore} database is available. */ @@ -1582,8 +1451,7 @@ declare namespace distributedData { * UnRegister Synchronizes SingleKvStore databases callback. * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @throws Throws this exception if no {@code SingleKvStore} database is available. */ off(event: 'syncComplete', syncCallback?: Callback>): void; @@ -1594,8 +1462,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param defaultAllowedDelayMs Indicates the default delay allowed for the database synchronization, in milliseconds. * @throws Throws this exception if any of the following errors occurs:{@code INVALID_ARGUMENT}, * {@code SERVER_UNAVAILABLE}, {@code IPC_ERROR}, and {@code DB_ERROR}. @@ -1608,8 +1475,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @returns SecurityLevel {@code SecurityLevel} the security level of the database. * @throws Throws this exception if any of the following errors occurs:{@code SERVER_UNAVAILABLE}, * {@code IPC_ERROR}, and {@code DB_ERROR}. @@ -1627,8 +1493,7 @@ declare namespace distributedData { * into the database, the system automatically adds the ID of the device running the application to the key. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A */ @@ -1638,8 +1503,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param deviceId Indicates the device to be queried. * @param key Indicates the key of the value to be queried. * @return Returns the value matching the given criteria. @@ -1654,8 +1518,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param deviceId Identifies the device whose data is to be queried. * @param keyPrefix Indicates the key prefix to match. * @returns Returns the list of all key-value pairs meeting the given criteria. @@ -1670,8 +1533,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param query Indicates the {@code Query} object. * @returns Returns the list of key-value pairs matching the specified {@code Query} object. * @throws Throws this exception if any of the following errors occurs: {@code INVALID_ARGUMENT}, @@ -1685,8 +1547,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param deviceId Indicates the ID of the device to which the key-value pairs belong. * @param query Indicates the {@code Query} object. * @returns Returns the list of key-value pairs matching the specified {@code Query} object. @@ -1704,8 +1565,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param deviceId Identifies the device whose data is to be queried. * @param keyPrefix Indicates the key prefix to match. * @returns Returns the {@code KvStoreResultSet} objects. @@ -1720,8 +1580,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param query Indicates the {@code Query} object. * @returns Returns the {@code KvStoreResultSet} object matching the specified {@code Query} object. * @throws Throws this exception if any of the following errors occurs: {@code INVALID_ARGUMENT}, @@ -1735,8 +1594,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param deviceId Indicates the ID of the device to which the {@code KvStoreResultSet} object belongs. * @param query Indicates the {@code Query} object. * @returns Returns the {@code KvStoreResultSet} object matching the specified {@code Query} object. @@ -1749,8 +1607,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param resultSet Indicates the {@code KvStoreResultSet} object to close. * @throws Throws this exception if any of the following errors occurs: {@code INVALID_ARGUMENT}, * {@code SERVER_UNAVAILABLE}, {@code IPC_ERROR}, {@code DB_ERROR}. @@ -1763,8 +1620,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param query Indicates the {@code Query} object. * @returns Returns the number of results matching the specified {@code Query} object. * @throws Throws this exception if any of the following errors occurs: {@code INVALID_ARGUMENT}, @@ -1778,8 +1634,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param deviceId Indicates the ID of the device to which the results belong. * @param query Indicates the {@code Query} object. * @returns Returns the number of results matching the specified {@code Query} object. @@ -1794,8 +1649,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param deviceId Identifies the device whose data is to be removed. The value cannot be the current device ID. * @throws Throws this exception if any of the following errors occurs: {@code INVALID_ARGUMENT}, * {@code SERVER_UNAVAILABLE}, {@code IPC_ERROR}, {@code DB_ERROR}. @@ -1809,8 +1663,7 @@ declare namespace distributedData { *

This method returns immediately and sync result will be returned through asynchronous callback. * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param deviceIdList Indicates the list of IDs of devices whose * {@code DeviceKVStore} databases are to be synchronized. * @param mode Indicates the synchronization mode, {@code PUSH}, {@code PULL}, or @@ -1825,8 +1678,7 @@ declare namespace distributedData { *

Sync result is returned through asynchronous callback. * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param syncCallback Indicates the callback used to send the synchronization result to the caller. * @throws Throws this exception if no DeviceKVStore database is available. */ @@ -1836,8 +1688,7 @@ declare namespace distributedData { * UnRegister Synchronizes DeviceKVStore databases callback. * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @throws Throws this exception if no DeviceKVStore database is available. */ off(event: 'syncComplete', syncCallback?: Callback>): void; @@ -1851,8 +1702,7 @@ declare namespace distributedData { * * @note N/A * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param config Indicates the {@link KVStore} configuration information, * including the user information and package name. * @return Returns the {@code KVManager} instance. @@ -1865,8 +1715,7 @@ declare namespace distributedData { * Provides interfaces to manage a {@code KVStore} database, including obtaining, closing, and deleting the {@code KVStore}. * * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @import N/A * @permission N/A * @version 1 @@ -1877,8 +1726,7 @@ declare namespace distributedData { * * @note N/A * @since 7 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param options Indicates the options used for creating and obtaining the {@code KVStore} database, * including {@code isCreateIfMissing}, {@code isEncrypt}, and {@code KVStoreType}. * @param storeId Identifies the {@code KVStore} database. @@ -1902,8 +1750,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param kvStore Indicates the {@code KvStore} database to close. * @throws Throws this exception if any of the following errors * occurs:{@code INVALID_ARGUMENT}, {@code ERVER_UNAVAILABLE}, @@ -1922,8 +1769,7 @@ declare namespace distributedData { * lost. * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param storeId Identifies the {@code KvStore} database to delete. * @throws Throws this exception if any of the following errors * occurs: {@code INVALID_ARGUMENT}, @@ -1939,8 +1785,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @returns Returns the storeId of all created {@code KvStore} databases. * @throws Throws this exception if any of the following errors * occurs: {@code SERVER_UNAVAILABLE}, {@code DB_ERROR}, @@ -1954,8 +1799,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param deathCallback device change callback {@code DeviceChangeCallback} * @throws exception maybe occurs. */ @@ -1966,8 +1810,7 @@ declare namespace distributedData { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @param deathCallback device change callback {@code DeviceChangeCallback} which has been registered. * @throws exception maybe occurs. */ diff --git a/api/@ohos.data.distributedDataObject.d.ts b/api/@ohos.data.distributedDataObject.d.ts index b1f2b24c1..c910d1389 100644 --- a/api/@ohos.data.distributedDataObject.d.ts +++ b/api/@ohos.data.distributedDataObject.d.ts @@ -19,8 +19,7 @@ import {AsyncCallback, Callback} from './basic'; * * @name distributedDataObject * @since 8 - * @sysCap - * @devices phone + * @syscap SystemCapability.DistributedDataManager.DataObject.Core */ declare namespace distributedDataObject { /** @@ -43,8 +42,7 @@ declare namespace distributedDataObject { /** * Object create by {@link createDistributedObject}. * - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone + * @syscap SystemCapability.DistributedDataManager.DataObject.Core * @since 8 */ interface DistributedObject { @@ -72,26 +70,6 @@ declare namespace distributedDataObject { * @since 8 */ off(type: 'change', callback?: Callback<{ sessionId: string, fields: Array }>): void; - - /** - * On watch of status - * - * @param callback Indicates the observer of object status changed. - * sessionId: The sessionId of the changed object - * networkId: NetworkId of the changed device - * status: 'online' The object became online on the device and data can be synced to the device - * 'offline' The object became offline on the device and the object can not sync any data - * @since 8 - */ - on(type: 'status', callback: Callback<{ sessionId: string, networkId: string, status: 'online' | 'offline' }>): void; - - /** - * Off watch of status - * - * @param callback If not null, off the callback, if undefined, off all callbacks - * @since 8 - */ - off(type: 'status', callback?: Callback<{ sessionId: string, deviceId: string, status: 'online' | 'offline' }>): void; } } diff --git a/api/@ohos.data.rdb.d.ts b/api/@ohos.data.rdb.d.ts index 809f46e62..8960cd687 100644 --- a/api/@ohos.data.rdb.d.ts +++ b/api/@ohos.data.rdb.d.ts @@ -20,8 +20,7 @@ import Context from "./application/Context"; * Provides methods for rdbStore create and delete. * * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @import import data_rdb from '@ohos.data.rdb'; * @permission N/A */ @@ -34,8 +33,7 @@ declare namespace rdb { * * @note N/A * @since 8 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param context Indicates the context of application or capability. * @param config Indicates the configuration of the database related to this RDB store. The configurations include * the database path, storage mode, and whether the database is read-only. @@ -50,8 +48,7 @@ declare namespace rdb { * * @note N/A * @since 8 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param context Indicates the context of application or capability. * @param name Indicates the database name. * @return Returns true if the database is deleted; returns false otherwise. @@ -63,8 +60,7 @@ declare namespace rdb { * Indicates the database synchronization mode. * * @since 8 - * @Syscap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @import N/A * @permission N/A */ @@ -73,8 +69,7 @@ declare namespace rdb { * Indicates the data is pushed to remote device from local device. * * @since 8 - * @Syscap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @import N/A * @permission N/A */ @@ -84,8 +79,7 @@ declare namespace rdb { * Indicates the data is pulled from remote device to local device. * * @since 8 - * @Syscap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @import N/A * @permission N/A */ @@ -96,8 +90,7 @@ declare namespace rdb { * Describes the subscription type. * * @since 8 - * @Syscap SystemCapability.Data.DATA_DISTRIBUTEDDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @import N/A * @permission N/A */ @@ -105,8 +98,7 @@ declare namespace rdb { /** * Subscription to remote data changes * @since 8 - * @Syscap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @import N/A * @permission N/A */ @@ -119,8 +111,7 @@ declare namespace rdb { * This class provides methods for creating, querying, updating, and deleting RDBs. * * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @import import data_rdb from '@ohos.data.rdb'; * @permission N/A */ @@ -130,8 +121,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param name Indicates the target table. * @param values Indicates the row of data to be inserted into the table. * @return Returns the row ID if the operation is successful; returns -1 otherwise. @@ -144,8 +134,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param values Indicates the row of data to be updated in the database.The key-value pairs are associated with column names of the database table. * @param rdbPredicates Indicates the specified update condition by the instance object of RdbPredicates. * @return Returns the number of affected rows. @@ -158,8 +147,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param rdbPredicates Indicates the specified delete condition by the instance object of RdbPredicates. * @return Returns the number of affected rows. */ @@ -171,8 +159,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param rdbPredicates Indicates the specified query condition by the instance object of RdbPredicates. * @param columns Indicates the columns to query. If the value is null, the query applies to all columns. * @return Returns a ResultSet object if the operation is successful; @@ -185,8 +172,7 @@ declare namespace rdb { * * @note N/A * @since 8 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param sql Indicates the SQL statement to execute. * @param bindArgs Indicates the values of the parameters in the SQL statement. The values are strings. * @return Returns a ResultSet object if the operation is successful; @@ -199,8 +185,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param sql Indicates the SQL statement to execute. * @param bindArgs Indicates the values of the parameters in the SQL statement. The values are strings. */ @@ -212,8 +197,7 @@ declare namespace rdb { * * @note N/A * @since 8 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param newEncryptKey the encrypted key is uint8 form in a vector. */ changeEncryptKey(newEncryptKey:Uint8Array, callback: AsyncCallback):void; @@ -224,8 +208,7 @@ declare namespace rdb { * * @note N/A * @since 8 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core */ beginTransaction(callback: AsyncCallback):void; beginTransaction(): Promise; @@ -235,8 +218,7 @@ declare namespace rdb { * * @note N/A * @since 8 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core */ commit(callback: AsyncCallback):void; commit(): Promise; @@ -246,8 +228,7 @@ declare namespace rdb { * * @note N/A * @since 8 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core */ rollBack(callback: AsyncCallback):void; rollBack(): Promise; @@ -257,9 +238,8 @@ declare namespace rdb { * * @note N/A * @since 8 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param tables the tables name you want to set - * @devices phone, tablet, tv, wearable, car */ setDistributedTables(tables: Array, callback: AsyncCallback): void; setDistributedTables(tables: Array): Promise; @@ -270,11 +250,11 @@ declare namespace rdb { * * @note N/A * @since 8 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param device Indicates the remote device. * @param table Indicates the local table name. * @return the distributed table name. - * @devices phone, tablet, tv, wearable, car + */ obtainDistributedTableName(device: string, table: string, callback: AsyncCallback): void; obtainDistributedTableName(device: string, table: string): Promise; @@ -284,11 +264,11 @@ declare namespace rdb { * * @note N/A * @since 8 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param mode Indicates the synchronization mode. The value can be PUSH, PULL. * @param predicates Constraint synchronized data and devices. * @param callback Indicates the callback used to send the synchronization result to the caller. - * @devices phone, tablet, tv, wearable, car + */ sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback>): void; sync(mode: SyncMode, predicates: RdbPredicates): Promise>; @@ -299,8 +279,7 @@ declare namespace rdb { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param type Indicates the subscription type, which is defined in {@code SubscribeType}. * @param observer Indicates the observer of data change events in the distributed database. */ @@ -311,8 +290,7 @@ declare namespace rdb { * * @note N/A * @since 8 - * @Syscap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param type Indicates the subscription type, which is defined in {@code SubscribeType}. * @param observer Indicates the data change observer already registered . */ @@ -323,8 +301,7 @@ declare namespace rdb { * Indicates possible value types * * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @import import data_rdb from '@ohos.data.rdb'; * @permission N/A */ @@ -334,8 +311,7 @@ declare namespace rdb { * Values in buckets are stored in key-value pairs * * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @import import data_rdb from '@ohos.data.rdb'; * @permission N/A */ @@ -347,8 +323,7 @@ declare namespace rdb { * Manages relational database configurations. * * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @import import data_rdb from '@ohos.data.rdb'; * @permission N/A */ @@ -358,7 +333,7 @@ declare namespace rdb { * Indicates the encryptKey of the database file * * @since 8 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core */ encryptKey: Uint8Array; } @@ -367,8 +342,7 @@ declare namespace rdb { * Manages relational database configurations. * * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @import import data_rdb from '@ohos.data.rdb'; * @permission N/A */ @@ -379,8 +353,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core */ constructor(name: string) @@ -389,8 +362,7 @@ declare namespace rdb { * * @note When query database, this function should not be called. * @since 8 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param devices Indicates specified remote devices. * @return Returns the RdbPredicates self. */ @@ -401,8 +373,7 @@ declare namespace rdb { * * @note When query database, this function should not be called. * @since 8 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @return Returns the RdbPredicates self. */ inAllDevices(): RdbPredicates; @@ -413,8 +384,7 @@ declare namespace rdb { * * @note This method is similar to = of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name in the database table. * @param value Indicates the value to match with the RdbPredicates. * @return Returns the RdbPredicates that match the specified field. @@ -427,8 +397,7 @@ declare namespace rdb { * * @note This method is similar to != of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name in the database table. * @param value Indicates the value to match with the RdbPredicates. * @return Returns the RdbPredicates that match the specified field. @@ -440,8 +409,7 @@ declare namespace rdb { * * @note This method is similar to ( of the SQL statement and needs to be used together with endWrap(). * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @return Returns the RdbPredicates with the left parenthesis. */ beginWrap(): RdbPredicates; @@ -452,8 +420,7 @@ declare namespace rdb { * @note This method is similar to ) of the SQL statement and needs to be used together * with beginWrap(). * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @return Returns the RdbPredicates with the right parenthesis. */ endWrap(): RdbPredicates; @@ -463,8 +430,7 @@ declare namespace rdb { * * @note This method is similar to or of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @return Returns the RdbPredicates with the or condition. */ or(): RdbPredicates; @@ -474,8 +440,7 @@ declare namespace rdb { * * @note This method is similar to and of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @return Returns the RdbPredicates with the and condition. */ and(): RdbPredicates; @@ -486,8 +451,7 @@ declare namespace rdb { * * @note This method is similar to contains of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name in the database table. * @param value Indicates the value to match with the RdbPredicates. * @return Returns the RdbPredicates that match the specified field. @@ -500,8 +464,7 @@ declare namespace rdb { * * @note This method is similar to value% of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name in the database table. * @param value Indicates the value to match with the RdbPredicates. * @return Returns the RdbPredicates that match the specified field. @@ -514,8 +477,7 @@ declare namespace rdb { * * @note This method is similar to %value of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name in the database table. * @param value Indicates the value to match with the RdbPredicates. * @return Returns the RdbPredicates that match the specified field. @@ -527,8 +489,7 @@ declare namespace rdb { * * @note This method is similar to is null of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name in the database table. * @return Returns the RdbPredicates that match the specified field. */ @@ -539,8 +500,7 @@ declare namespace rdb { * * @note This method is similar to is not null of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name in the database table. * @return Returns the RdbPredicates that match the specified field. */ @@ -552,8 +512,7 @@ declare namespace rdb { * * @note This method is similar to like of the SQL statement. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name in the database table. * @param value Indicates the value to match with the RdbPredicates. The percent sign (%) in the value * is a wildcard (like * in a regular expression). @@ -567,8 +526,7 @@ declare namespace rdb { * * @note Different from like, the input parameters of this method are case-sensitive. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name in the database table. * @param value Indicates the value to match with RdbPredicates. * @return Returns the SQL statement with the specified RdbPredicates. @@ -580,8 +538,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name. * @param low Indicates the minimum value. * @param high Indicates the maximum value. @@ -595,8 +552,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name in the database table. * @param low Indicates the minimum value to match with DataAbilityPredicates. * @param high Indicates the maximum value to match with DataAbilityPredicates. @@ -609,8 +565,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name. * @param value Indicates the String field. * @return Returns the SQL query statement with the specified RdbPredicates. @@ -622,8 +577,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name. * @param value Indicates the String field. * @return Returns the SQL query statement with the specified RdbPredicates. @@ -635,8 +589,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name. * @param value Indicates the String field. * @return Returns the SQL query statement with the specified RdbPredicates. @@ -648,8 +601,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name. * @param value Indicates the String field. * @return Returns the SQL query statement with the specified RdbPredicates. @@ -662,8 +614,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name for sorting the return list. * @return Returns the SQL query statement with the specified RdbPredicates. */ @@ -675,8 +626,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name for sorting the return list. * @return Returns the SQL query statement with the specified RdbPredicates. */ @@ -687,8 +637,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @return Returns the SQL query statement with the specified RdbPredicates. */ distinct(): RdbPredicates; @@ -698,8 +647,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param value Indicates the max length of the return list. * @return Returns the SQL query statement with the specified RdbPredicates. */ @@ -710,8 +658,7 @@ declare namespace rdb { * * @note Use this method together with limit(int). * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param rowOffset Indicates the start position of the returned result. The value is a positive integer. * @return Returns the SQL query statement with the specified AbsPredicates. */ @@ -722,8 +669,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param fields Indicates the specified columns by which query results are grouped. * @return Returns the RdbPredicates with the specified columns by which query results are grouped. */ @@ -734,8 +680,7 @@ declare namespace rdb { * * @note Before using this method, you need to create an index column. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param indexName Indicates the name of the index column. * @return Returns RdbPredicates with the specified index column. */ @@ -747,8 +692,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name in the database table. * @param values Indicates the values to match with RdbPredicates. * @return Returns RdbPredicates that matches the specified field. @@ -761,8 +705,7 @@ declare namespace rdb { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param field Indicates the column name in the database table. * @param values Indicates the values to match with RdbPredicates. * @return Returns RdbPredicates that matches the specified field. diff --git a/api/@ohos.data.storage.d.ts b/api/@ohos.data.storage.d.ts index 937ce3ad4..806692fb4 100644 --- a/api/@ohos.data.storage.d.ts +++ b/api/@ohos.data.storage.d.ts @@ -19,8 +19,8 @@ import { AsyncCallback, Callback } from './basic'; * * @name storage * @since 5 - * @sysCap SystemCapability.Data#DATA_APPDATAMGR - * @devices phone, tablet + * @syscap SystemCapability.DistributedDataManager.Preference.Core + * */ declare namespace storage { /** @@ -79,8 +79,8 @@ declare namespace storage { * the file that stores storage data, and use emoveStorageFromCache * to remove the {@link Storage} instance from the memory. * - * @sysCap SystemCapability.Data#DATA_APPDATAMGR - * @devices phone, tablet + * @syscap SystemCapability.DistributedDataManager.Preference.Core + * * @since 5 */ interface Storage { @@ -193,8 +193,8 @@ declare namespace storage { /** * Define the change data information object. * - * @sysCap SystemCapability.Data#DATA_APPDATAMGR - * @devices phone, tablet + * @syscap SystemCapability.DistributedDataManager.Preference.Core + * * @since 5 */ interface StorageObserver { diff --git a/api/data/rdb/resultSet.d.ts b/api/data/rdb/resultSet.d.ts index ac0e5eb6e..2a6e45f99 100755 --- a/api/data/rdb/resultSet.d.ts +++ b/api/data/rdb/resultSet.d.ts @@ -18,8 +18,7 @@ import { AsyncCallback } from '../../basic' * Provides methods for accessing a database result set generated by querying the database. * * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @import import data_rdb from '@ohos.data.rdb'; * @permission N/A */ @@ -30,8 +29,7 @@ interface ResultSet { * @note The column names are returned as a string array, in which the strings are in the same order * as the columns in the result set. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core */ columnNames: Array; @@ -41,8 +39,7 @@ interface ResultSet { * @note The returned number is equal to the length of the string array returned by the * columnCount method. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core */ columnCount: number; @@ -51,8 +48,7 @@ interface ResultSet { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core */ rowCount: number; @@ -61,8 +57,7 @@ interface ResultSet { * * @note The result set index starts from 0. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core */ rowIndex: number; @@ -71,8 +66,7 @@ interface ResultSet { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core */ isAtFirstRow: boolean; @@ -81,8 +75,7 @@ interface ResultSet { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core */ isAtLastRow: boolean; @@ -91,8 +84,7 @@ interface ResultSet { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core */ isEnded: boolean; @@ -102,8 +94,7 @@ interface ResultSet { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core */ isStarted: boolean; @@ -114,8 +105,7 @@ interface ResultSet { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core */ isClosed: boolean; @@ -124,8 +114,7 @@ interface ResultSet { * * @note The column name is passed as an input parameter. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param columnName Indicates the name of the specified column in the result set. * @return Returns the index of the specified column. */ @@ -136,8 +125,7 @@ interface ResultSet { * * @note The column index is passed as an input parameter. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param columnIndex Indicates the index of the specified column in the result set. * @return Returns the name of the specified column. */ @@ -149,8 +137,7 @@ interface ResultSet { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param offset Indicates the offset relative to the current position. * @return Returns true if the result set is moved successfully and does not go beyond the range; * returns false otherwise. @@ -162,8 +149,7 @@ interface ResultSet { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param rowIndex Indicates the index of the specified row, which starts from 0. * @return Returns true if the result set is moved successfully; returns false otherwise. */ @@ -174,8 +160,7 @@ interface ResultSet { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @return Returns true if the result set is moved successfully; * returns false otherwise, for example, if the result set is empty. */ @@ -186,8 +171,7 @@ interface ResultSet { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @return Returns true if the result set is moved successfully; * returns false otherwise, for example, if the result set is empty. */ @@ -198,8 +182,7 @@ interface ResultSet { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @return Returns true if the result set is moved successfully; * returns false otherwise, for example, if the result set is already in the last row. */ @@ -210,8 +193,7 @@ interface ResultSet { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @return Returns true if the result set is moved successfully; * returns false otherwise, for example, if the result set is already in the first row. */ @@ -223,8 +205,7 @@ interface ResultSet { * @note The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null or the specified column is not of the Blob type. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param columnIndex Indicates the specified column index, which starts from 0. * @return Returns the value of the specified column as a byte array. */ @@ -236,8 +217,7 @@ interface ResultSet { * @note The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null or the specified column is not of the string type. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param columnIndex Indicates the specified column index, which starts from 0. * @return Returns the value of the specified column as a string. */ @@ -249,8 +229,7 @@ interface ResultSet { * @note The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null, the specified column is not of the integer type. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param columnIndex Indicates the specified column index, which starts from 0. * @return Returns the value of the specified column as a long. */ @@ -262,8 +241,7 @@ interface ResultSet { * @note The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null, the specified column is not of the double type. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param columnIndex Indicates the specified column index, which starts from 0. * @return Returns the value of the specified column as a double. */ @@ -274,8 +252,7 @@ interface ResultSet { * * @note N/A * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @param columnIndex Indicates the specified column index, which starts from 0. * @return Returns true if the value of the specified column in the current row is null; * returns false otherwise. @@ -287,8 +264,7 @@ interface ResultSet { * * @note Calling this method on the result set will release all of its resources and makes it ineffective. * @since 7 - * @sysCap SystemCapability.Data.DATA_APPDATAMGR - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @return Returns true if the result set is closed; returns false otherwise. */ close(): void;