diff --git a/api/@ohos.data.distributedKVStore.d.ts b/api/@ohos.data.distributedKVStore.d.ts index 4201976b1b22b9edef4cfce903951e5820f51ee2..1918c77d90ff2a9c622f11e3c59a86d705350e72 100644 --- a/api/@ohos.data.distributedKVStore.d.ts +++ b/api/@ohos.data.distributedKVStore.d.ts @@ -540,8 +540,9 @@ declare namespace distributedKVStore { * A constructor used to create a FieldNode instance with the specified field. * name Indicates the field node name. * - * @param { string } name - * @throws { BusinessError } 401 - Parameter error. + * @param { string } name - It can not be empty. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @since 9 */ @@ -553,7 +554,8 @@ declare namespace distributedKVStore { * * @param { FieldNode } child - The field node to append. * @returns { boolean } Returns true if the child node is successfully added to this {@code FieldNode} and false otherwise. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect Parameters types. * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @since 9 */ @@ -662,7 +664,8 @@ declare namespace distributedKVStore { * the destination position will be entry 1. The valid final position after moving forwards starts with 0. If the * final position is invalid, false will be returned. * @returns { boolean } Returns true if the operation succeeds; return false otherwise. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -673,7 +676,8 @@ declare namespace distributedKVStore { * * @param { number } position - Indicates the absolute position. * @returns { boolean } Returns true if the operation succeeds; return false otherwise. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -758,7 +762,9 @@ declare namespace distributedKVStore { * @param { string } field - Indicates the field, which cannot contain ^. * @param { number | string | boolean } value - Indicates the value to be compared. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -770,7 +776,9 @@ declare namespace distributedKVStore { * @param { string } field - Indicates the field, which cannot contain ^. * @param { number | string | boolean } value - Indicates the value to be compared. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -783,7 +791,9 @@ declare namespace distributedKVStore { * @param { string } field - Indicates the field, which cannot contain ^. * @param { number | string | boolean } value - Indicates the value to be compared. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -795,7 +805,9 @@ declare namespace distributedKVStore { * @param { string } field - Indicates the field, which cannot contain ^. * @param { number | string } value - Indicates the value to be compared. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -808,7 +820,9 @@ declare namespace distributedKVStore { * @param { string } field - Indicates the field, which cannot contain ^. * @param { number | string } value - Indicates the value to be compared. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -821,7 +835,9 @@ declare namespace distributedKVStore { * @param { string } field - Indicates the field, which cannot contain ^. * @param { number | string } value - Indicates the value to be compared. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -832,7 +848,9 @@ declare namespace distributedKVStore { * * @param { string } field - Indicates the field, which cannot contain ^. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -844,7 +862,9 @@ declare namespace distributedKVStore { * @param { string } field - Indicates the field, which cannot contain ^. * @param { number[] } valueList - Indicates the int value list. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -856,7 +876,9 @@ declare namespace distributedKVStore { * @param { string } field - Indicates the field, which cannot contain ^. * @param { string[] } valueList - Indicates the string value list. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -868,7 +890,9 @@ declare namespace distributedKVStore { * @param { string } field - Indicates the field, which cannot contain ^. * @param { number[] } valueList - Indicates the int value list. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -880,7 +904,9 @@ declare namespace distributedKVStore { * @param { string } field - Indicates the field, which cannot contain ^. * @param { string[] } valueList - Indicates the string value list. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -892,7 +918,9 @@ declare namespace distributedKVStore { * @param { string } field - Indicates the field, which cannot contain ^. * @param { string } value - Indicates the string value. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -904,7 +932,9 @@ declare namespace distributedKVStore { * @param { string } field - Indicates the field, which cannot contain ^. * @param { string } value - Indicates the string value. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -935,7 +965,9 @@ declare namespace distributedKVStore { * * @param { string } field - Indicates the field, which cannot contain ^. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -946,7 +978,9 @@ declare namespace distributedKVStore { * * @param { string } field - Indicates the field, which cannot contain ^. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -958,7 +992,8 @@ declare namespace distributedKVStore { * @param { number } total - Indicates the number of results. * @param { number } offset - Indicates the start position. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -969,7 +1004,8 @@ declare namespace distributedKVStore { * * @param { string } field - Indicates the specified field. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -1002,7 +1038,8 @@ declare namespace distributedKVStore { * * @param { string } prefix - Indicates the specified key prefix. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -1013,7 +1050,8 @@ declare namespace distributedKVStore { * * @param { string } index - Indicates the index to set. * @returns { Query } Returns the {@coed Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -1022,9 +1060,11 @@ declare namespace distributedKVStore { /** * Add device ID key prefix.Used by {@code DeviceKVStore}. * - * @param { string } deviceId - Specify device id to query from. + * @param { string } deviceId - Specify device id to query from, It can not be empty. * @returns { Query } Returns the {@code Query} object with device ID prefix added. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -1064,7 +1104,9 @@ declare namespace distributedKVStore { * Spaces before and after the key will be cleared. * @param { Uint8Array | string | number | boolean } value - Indicates the value to be inserted. * @param { AsyncCallback } callback - the callback of put. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -1078,7 +1120,9 @@ declare namespace distributedKVStore { * Spaces before and after the key will be cleared. * @param { Uint8Array | string | number | boolean } value - Indicates the value to be inserted. * @param { AsyncCallback } callback - the callback of put. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. @@ -1095,7 +1139,9 @@ declare namespace distributedKVStore { * Spaces before and after the key will be cleared. * @param { Uint8Array | string | number | boolean } value - Indicates the value to be inserted. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -1109,7 +1155,9 @@ declare namespace distributedKVStore { * Spaces before and after the key will be cleared. * @param { Uint8Array | string | number | boolean } value - Indicates the value to be inserted. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. @@ -1123,7 +1171,8 @@ declare namespace distributedKVStore { * * @param { Entry[] } entries - Indicates the key-value pairs to be inserted in batches. * @param { AsyncCallback } callback - the callback of putBatch. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -1134,7 +1183,8 @@ declare namespace distributedKVStore { * * @param { Entry[] } entries - Indicates the key-value pairs to be inserted in batches. * @param { AsyncCallback } callback - the callback of putBatch. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. @@ -1148,7 +1198,8 @@ declare namespace distributedKVStore { * * @param { Entry[] } entries - Indicates the key-value pairs to be inserted in batches. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -1159,7 +1210,8 @@ declare namespace distributedKVStore { * * @param { Entry[] } entries - Indicates the key-value pairs to be inserted in batches. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. @@ -1173,7 +1225,8 @@ declare namespace distributedKVStore { * * @param { Array } value - Indicates the ValuesBucket array to be inserted. * @param { AsyncCallback } callback - the callback of putBatch. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -1187,7 +1240,8 @@ declare namespace distributedKVStore { * * @param { Array } value - Indicates the ValuesBucket array to be inserted. * @param { AsyncCallback } callback - the callback of putBatch. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -1204,7 +1258,8 @@ declare namespace distributedKVStore { * * @param { Array } value - Indicates the ValuesBucket array to be inserted. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -1218,7 +1273,8 @@ declare namespace distributedKVStore { * * @param { Array } value - Indicates the ValuesBucket array to be inserted. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -1236,7 +1292,9 @@ declare namespace distributedKVStore { * @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}. * Spaces before and after the key will be cleared. * @param { AsyncCallback } callback - the callback of delete. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -1248,7 +1306,9 @@ declare namespace distributedKVStore { * @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}. * Spaces before and after the key will be cleared. * @param { AsyncCallback } callback - the callback of delete. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. @@ -1263,7 +1323,9 @@ declare namespace distributedKVStore { * @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}. * Spaces before and after the key will be cleared. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -1275,7 +1337,9 @@ declare namespace distributedKVStore { * @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}. * Spaces before and after the key will be cleared. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. @@ -1289,7 +1353,8 @@ declare namespace distributedKVStore { * * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates. * @param { AsyncCallback } callback - the callback of delete. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -1303,7 +1368,8 @@ declare namespace distributedKVStore { * * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates. * @param { AsyncCallback } callback - the callback of delete. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -1320,7 +1386,8 @@ declare namespace distributedKVStore { * * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -1334,7 +1401,8 @@ declare namespace distributedKVStore { * * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -1349,9 +1417,11 @@ declare namespace distributedKVStore { /** * Deletes key-value pairs in batches from the {@code SingleKVStore} database. * - * @param { string[] } keys - Indicates the key-value pairs to be deleted in batches. + * @param { string[] } keys - Indicates the key-value pairs to be deleted in batches, It can not be empty. * @param { AsyncCallback } callback - the callback of deleteBatch. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -1360,9 +1430,11 @@ declare namespace distributedKVStore { /** * Deletes key-value pairs in batches from the {@code SingleKVStore} database. * - * @param { string[] } keys - Indicates the key-value pairs to be deleted in batches. + * @param { string[] } keys - Indicates the key-value pairs to be deleted in batches, It can not be empty. * @param { AsyncCallback } callback - the callback of deleteBatch. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. @@ -1374,9 +1446,11 @@ declare namespace distributedKVStore { /** * Deletes key-value pairs in batches from the {@code SingleKVStore} database. * - * @param { string[] } keys - Indicates the key-value pairs to be deleted in batches. + * @param { string[] } keys - Indicates the key-value pairs to be deleted in batches, It can not be empty. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -1385,9 +1459,11 @@ declare namespace distributedKVStore { /** * Deletes key-value pairs in batches from the {@code SingleKVStore} database. * - * @param { string[] } keys - Indicates the key-value pairs to be deleted in batches. + * @param { string[] } keys - Indicates the key-value pairs to be deleted in batches, It can not be empty. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. @@ -1403,7 +1479,8 @@ declare namespace distributedKVStore { * * @param { string } deviceId - Identifies the device whose data is to be removed and the value cannot be the current device ID. * @param { AsyncCallback } callback - the callback of removeDeviceData. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @since 9 @@ -1417,7 +1494,8 @@ declare namespace distributedKVStore { * * @param { string } deviceId - Identifies the device whose data is to be removed and the value cannot be the current device ID. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @since 9 @@ -1430,7 +1508,9 @@ declare namespace distributedKVStore { * @param { string } key - Indicates the key. The length must be less than {@code MAX_KEY_LENGTH}. * @param { AsyncCallback } callback - * {Uint8Array|string|boolean|number}: the returned value specified by the key. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100004 - Not found. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -1445,7 +1525,9 @@ declare namespace distributedKVStore { * @param { string } key - Indicates the key. The length must be less than {@code MAX_KEY_LENGTH}. * @returns { Promise } * {Uint8Array|string|boolean|number}: the returned value specified by the key. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100004 - Not found. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -1460,7 +1542,8 @@ declare namespace distributedKVStore { * @param { string } keyPrefix - Indicates the key prefix to match. * @param { AsyncCallback } callback - {Entry[]}: the list of all key-value pairs * that match the specified key prefix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -1474,7 +1557,8 @@ declare namespace distributedKVStore { * @param { string } keyPrefix - Indicates the key prefix to match. * @returns { Promise } {Entry[]}: the list of all key-value pairs that match the * specified key prefix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -1488,7 +1572,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @param { AsyncCallback } callback - {Entry[]}: the list of all key-value pairs * matching the specified {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -1502,7 +1587,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @returns { Promise } {Entry[]}: the list of all key-value pairs matching the * specified {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -1520,7 +1606,8 @@ declare namespace distributedKVStore { * @param { string } keyPrefix - Indicates the key prefix to match. * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified keyPrefix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -1536,7 +1623,8 @@ declare namespace distributedKVStore { * @param { string } keyPrefix - Indicates the key prefix to match. * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified keyPrefix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -1555,7 +1643,8 @@ declare namespace distributedKVStore { * @param { string } keyPrefix - Indicates the key prefix to match. * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified keyPrefix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -1571,7 +1660,8 @@ declare namespace distributedKVStore { * @param { string } keyPrefix - Indicates the key prefix to match. * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified keyPrefix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -1586,7 +1676,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -1598,7 +1689,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -1613,7 +1705,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -1625,7 +1718,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -1640,7 +1734,8 @@ declare namespace distributedKVStore { * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates. * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified {@code dataSharePredicates.DataSharePredicates} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -1655,7 +1750,8 @@ declare namespace distributedKVStore { * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates. * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified {@code dataSharePredicates.DataSharePredicates} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100003 - Database corrupted. @@ -1673,7 +1769,8 @@ declare namespace distributedKVStore { * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates. * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified {@code dataSharePredicates.DataSharePredicates} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -1688,7 +1785,8 @@ declare namespace distributedKVStore { * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates. * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified {@code dataSharePredicates.DataSharePredicates} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100003 - Database corrupted. @@ -1705,7 +1803,8 @@ declare namespace distributedKVStore { * * @param { KVStoreResultSet } resultSet - Indicates the {@code KVStoreResultSet} object to close. * @param { AsyncCallback } callback - the callback of closeResultSet. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -1716,7 +1815,8 @@ declare namespace distributedKVStore { * * @param { KVStoreResultSet } resultSet - Indicates the {@code KVStoreResultSet} object to close. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -1728,7 +1828,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @param { AsyncCallback } callback - {number}: the number of results matching the * specified {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -1742,7 +1843,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @returns { Promise } {number}: the number of results matching the specified * {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -1753,9 +1855,11 @@ declare namespace distributedKVStore { /** * Backs up a database in the specified filename. * - * @param { string } file - Indicates the database backup filename. + * @param { string } file - Indicates the database backup filename, It can not be empty and + * The length must be less than {@code MAX_KEY_LENGTH}. * @param { AsyncCallback } callback - the callback of backup. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 @@ -1765,9 +1869,11 @@ declare namespace distributedKVStore { /** * Backs up a database in the specified filename. * - * @param { string } file - Indicates the database backup filename. + * @param { string } file - Indicates the database backup filename, It can not be empty and + * The length must be less than {@code MAX_KEY_LENGTH}. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 @@ -1777,9 +1883,11 @@ declare namespace distributedKVStore { /** * Restores a database from a specified database file. * - * @param { string } file - Indicates the database backup filename. + * @param { string } file - Indicates the database backup filename, It can not be empty and + * The length must be less than {@code MAX_KEY_LENGTH}. * @param { AsyncCallback } callback - the callback of restore. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 @@ -1789,9 +1897,11 @@ declare namespace distributedKVStore { /** * Restores a database from a specified database file. * - * @param { string } file - Indicates the database backup filename. + * @param { string } file - Indicates the database backup filename, It can not be empty and + * The length must be less than {@code MAX_KEY_LENGTH}. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 @@ -1801,11 +1911,13 @@ declare namespace distributedKVStore { /** * Delete database backup files based on the specified filenames. * - * @param { Array } files - Indicates the backup filenames to be deleted. + * @param { Array } files - Indicates the backup filenames to be deleted, It can not be empty and + * The length must be less than {@code MAX_KEY_LENGTH}. * @param { AsyncCallback> } callback - {Array<[string, number]>}: * the list of backup file and it's corresponding delete result which 0 means delete success * and otherwise failed. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -1814,10 +1926,12 @@ declare namespace distributedKVStore { /** * Delete database backup files based on the specified filenames. * - * @param { Array } files - Indicates the backup filenames to be deleted. + * @param { Array } files - Indicates the backup filenames to be deleted, It can not be empty and + * The length must be less than {@code MAX_KEY_LENGTH}. * @returns { Promise> } {Array<[string, number]>}: the list of backup * file and it's corresponding delete result which 0 means delete success and otherwise failed. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -1911,7 +2025,8 @@ declare namespace distributedKVStore { * @param { boolean } enabled - Specifies whether to enable synchronization. The value true * means to enable synchronization, and false means the opposite. * @param { AsyncCallback } callback - the callback of enableSync. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -1923,7 +2038,8 @@ declare namespace distributedKVStore { * @param { boolean } enabled - Specifies whether to enable synchronization. The value true * means to enable synchronization, and false means the opposite. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -1937,7 +2053,8 @@ declare namespace distributedKVStore { * @param { string[] } remoteSupportLabels - Indicates the labels of the devices with which * data will be synchronized. * @param { AsyncCallback } callback - the callback of setSyncRange. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -1951,7 +2068,8 @@ declare namespace distributedKVStore { * @param { string[] } remoteSupportLabels - Indicates the labels of the devices with which * data will be synchronized. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -1963,7 +2081,8 @@ declare namespace distributedKVStore { * @param { number } defaultAllowedDelayMs - Indicates the default delay allowed for the * database synchronization, in milliseconds. * @param { AsyncCallback } callback - the callback of setSyncParam. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -1975,7 +2094,8 @@ declare namespace distributedKVStore { * @param { number } defaultAllowedDelayMs - Indicates the default delay allowed for the * database synchronization, in milliseconds. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -1989,7 +2109,8 @@ declare namespace distributedKVStore { * @param { SyncMode } mode - Indicates the synchronization mode. The value can be {@code PUSH}, * {@code PULL}, or {@code PUSH_PULL}. * @param { number } delayMs - Indicates the delay allowed for the synchronization, in milliseconds. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100004 - Not found. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -2006,7 +2127,8 @@ declare namespace distributedKVStore { * @param { SyncMode } mode - Indicates the synchronization mode. The value can be {@code PUSH}, * {@code PULL}, or {@code PUSH_PULL}. * @param { number } delayMs - Indicates the delay allowed for the synchronization, in milliseconds. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100004 - Not found. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -2022,7 +2144,8 @@ declare namespace distributedKVStore { * @param { SubscribeType } type - Indicates the subscription type, which is defined in {@code SubscribeType}. * @param { Callback } listener - {ChangeNotification}: the {@code ChangeNotification} * object indicates the data change events in the distributed database. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -2036,7 +2159,8 @@ declare namespace distributedKVStore { * @param { SubscribeType } type - Indicates the subscription type, which is defined in {@code SubscribeType}. * @param { Callback } listener - {ChangeNotification}: the {@code ChangeNotification} * object indicates the data change events in the distributed database. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -2052,7 +2176,8 @@ declare namespace distributedKVStore { * @param { Callback> } syncCallback - {Array<[string, number]>}: the * deviceId and it's corresponding synchronization result which 0 means synchronization success * and otherwise failed. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -2064,7 +2189,8 @@ declare namespace distributedKVStore { * @param { 'dataChange' } event - The unsubscribe event name, fixed as 'dataChange', indicates the data change event. * @param { Callback } listener - {ChangeNotification}: the {@code ChangeNotification} * object indicates the data change events in the distributed database. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 @@ -2078,7 +2204,8 @@ declare namespace distributedKVStore { * @param { Callback> } syncCallback - {Array<[string, number]>}: the * deviceId and it's corresponding synchronization result which 0 means synchronization success * and otherwise failed. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -2125,7 +2252,9 @@ declare namespace distributedKVStore { * @param { string } key - Indicates the key. The length must be less than {@code MAX_KEY_LENGTH}. * @param { AsyncCallback } callback - * {Uint8Array|string|boolean|number}: the returned value specified by the local device ID and specified key. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100004 - Not found. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -2140,7 +2269,9 @@ declare namespace distributedKVStore { * @param { string } key - Indicates the key. The length must be less than {@code MAX_KEY_LENGTH}. * @returns { Promise } * {Uint8Array|string|boolean|number}: the returned value specified by the local device ID and specified key. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100004 - Not found. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -2153,10 +2284,12 @@ declare namespace distributedKVStore { * Obtains the value matching a specified device ID and key. * * @param { string } deviceId - Indicates the device to be queried. - * @param { string } key - Indicates the key of the value to be queried. + * @param { string } key - Indicates the key of the value to be queried. The length must be less than {@code MAX_KEY_LENGTH}. * @param { AsyncCallback } callback - * {boolean | string | number | Uint8Array}: the returned value specified by the deviceId and key. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100004 - Not found. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -2169,10 +2302,12 @@ declare namespace distributedKVStore { * Obtains the value matching a specified device ID and key. * * @param { string } deviceId - Indicates the device to be queried. - * @param { string } key - Indicates the key of the value to be queried. + * @param { string } key - Indicates the key of the value to be queried. The length must be less than {@code MAX_KEY_LENGTH}. * @returns { Promise } * {Uint8Array|string|boolean|number}: the returned value specified by the deviceId and key. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100004 - Not found. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -2187,7 +2322,8 @@ declare namespace distributedKVStore { * @param { string } keyPrefix - Indicates the key prefix to match. * @param { AsyncCallback } callback - {Entry[]}: the list of all key-value pairs * that match the local device ID and specified key prefix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -2201,7 +2337,8 @@ declare namespace distributedKVStore { * @param { string } keyPrefix - Indicates the key prefix to match. * @returns { Promise } {Entry[]}: the list of all key-value pairs that match the * local device ID and specified key prefix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -2216,7 +2353,8 @@ declare namespace distributedKVStore { * @param { string } keyPrefix - Indicates the key prefix to match. * @param { AsyncCallback } callback - {Entry[]}: the list of all key-value pairs * that match the specified deviceId and key prefix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore @@ -2231,7 +2369,8 @@ declare namespace distributedKVStore { * @param { string } keyPrefix - Indicates the key prefix to match. * @returns { Promise } {Entry[]}: the list of all key-value pairs that match the * specified deviceId and key prefix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore @@ -2245,7 +2384,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @param { AsyncCallback } callback - {Entry[]}: the list of all key-value pairs * matching the local device ID and specified {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -2259,7 +2399,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @returns { Promise } {Entry[]}: the list of all key-value pairs matching the local device ID and * specified {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -2274,7 +2415,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @param { AsyncCallback } callback - {Entry[]}: the list of all key-value pairs * matching the specified deviceId and {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore @@ -2289,7 +2431,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @returns { Promise } {Entry[]}: the list of all key-value pairs matching the * specified deviceId and {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore @@ -2307,7 +2450,8 @@ declare namespace distributedKVStore { * @param { string } keyPrefix - Indicates the key prefix to match. * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the local device ID and specified keyPrefix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -2323,7 +2467,8 @@ declare namespace distributedKVStore { * @param { string } keyPrefix - Indicates the key prefix to match. * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the local device ID and specified keyPrefix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -2342,7 +2487,8 @@ declare namespace distributedKVStore { * @param { string } keyPrefix - Indicates the key prefix to match. * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the local device ID and specified keyPrefix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -2358,7 +2504,8 @@ declare namespace distributedKVStore { * @param { string } keyPrefix - Indicates the key prefix to match. * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the local device ID and specified keyPrefix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -2378,7 +2525,8 @@ declare namespace distributedKVStore { * @param { string } keyPrefix - Indicates the key prefix to match. * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified deviceId and keyPrefix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore @@ -2395,7 +2543,8 @@ declare namespace distributedKVStore { * @param { string } keyPrefix - Indicates the key prefix to match. * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified deviceId and keyPrefix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -2415,7 +2564,8 @@ declare namespace distributedKVStore { * @param { string } keyPrefix - Indicates the key prefix to match. * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified deviceId and keyPrefix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore @@ -2432,7 +2582,8 @@ declare namespace distributedKVStore { * @param { string } keyPrefix - Indicates the key prefix to match. * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified deviceId and keyPrefix. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -2447,7 +2598,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the local device ID and specified {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -2459,7 +2611,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the local device ID and specified {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -2474,7 +2627,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the local device ID and specified {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -2486,7 +2640,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the local device ID and specified {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -2502,7 +2657,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified deviceId and {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore @@ -2515,7 +2671,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified deviceId and {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -2531,7 +2688,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified deviceId and {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore @@ -2544,7 +2702,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified deviceId and {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -2559,7 +2718,8 @@ declare namespace distributedKVStore { * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates. * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the local device ID and specified {@code dataSharePredicates.DataSharePredicates} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -2574,7 +2734,8 @@ declare namespace distributedKVStore { * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates. * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the local device ID and specified {@code dataSharePredicates.DataSharePredicates} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100003 - Database corrupted. @@ -2592,7 +2753,8 @@ declare namespace distributedKVStore { * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates. * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the local device ID and specified {@code dataSharePredicates.DataSharePredicates} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -2607,7 +2769,8 @@ declare namespace distributedKVStore { * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates. * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the local device ID and specified {@code dataSharePredicates.DataSharePredicates} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100003 - Database corrupted. @@ -2626,7 +2789,8 @@ declare namespace distributedKVStore { * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates. * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified deviceId and {@code dataSharePredicates.DataSharePredicates} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -2642,7 +2806,8 @@ declare namespace distributedKVStore { * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates. * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified deviceId and {@code dataSharePredicates.DataSharePredicates} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100003 - Database corrupted. @@ -2665,7 +2830,8 @@ declare namespace distributedKVStore { * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates. * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified deviceId and {@code dataSharePredicates.DataSharePredicates} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. @@ -2681,7 +2847,8 @@ declare namespace distributedKVStore { * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates. * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} * object matching the specified deviceId and {@code dataSharePredicates.DataSharePredicates} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. * @throws { BusinessError } 15100001 - Over max limits. * @throws { BusinessError } 15100003 - Database corrupted. @@ -2699,7 +2866,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @param { AsyncCallback } callback - {number}: the number of results matching the * local device ID and specified {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -2713,7 +2881,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @returns { Promise } {number}: the number of results matching the local device ID and specified * {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -2728,7 +2897,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @param { AsyncCallback } callback - {number}: the number of results matching the * specified deviceId and {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore @@ -2743,7 +2913,8 @@ declare namespace distributedKVStore { * @param { Query } query - Indicates the {@code Query} object. * @returns { Promise } {number}: the number of results matching the specified * deviceId and {@code Query} object. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. * @throws { BusinessError } 15100003 - Database corrupted. * @throws { BusinessError } 15100005 - Database or result set already closed. * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore @@ -2758,9 +2929,11 @@ declare namespace distributedKVStore { * to create a {@link KVManager} instance. * * @param { KVManagerConfig } config - Indicates the KVStore configuration information, - * including the package name and context. + * including the package name and context, and package name can not be empty. * @returns { KVManager } : the {@code KVManager} instance. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -2783,7 +2956,9 @@ declare namespace distributedKVStore { * @param { Options } options - Indicates the {@code Options} object used for creating and * obtaining the KVStore database. * @param { AsyncCallback } callback - {T}: the {@code SingleKVStore} or {@code DeviceKVStore} instance. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100002 - Open existed database with changed options. * @throws { BusinessError } 15100003 - Database corrupted. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -2800,7 +2975,9 @@ declare namespace distributedKVStore { * @param { Options } options - Indicates the {@code Options} object used for creating and * obtaining the KVStore database. * @returns { Promise } {T}: the {@code SingleKVStore} or {@code DeviceKVStore} instance. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @throws { BusinessError } 15100002 - Open existed database with changed options. * @throws { BusinessError } 15100003 - Database corrupted. * @syscap SystemCapability.DistributedDataManager.KVStore.Core @@ -2816,11 +2993,12 @@ declare namespace distributedKVStore { * method, release the resources created for the database, for example, {@code KVStoreResultSet} for KVStore, otherwise * closing the database will fail. * - * @param { string } appId - Identifies the application that the database belong to. + * @param { string } appId - Identifies the application that the database belong to, and cannot exceed 256 characters. * @param { string } storeId - Identifies the KVStore database to close. The storeId can consist of only letters, digits, * and underscores (_), and cannot exceed 128 characters. * @param { AsyncCallback } callback - the callback of closeKVStore. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -2834,11 +3012,12 @@ declare namespace distributedKVStore { * method, release the resources created for the database, for example, {@code KVStoreResultSet} for KVStore, otherwise * closing the database will fail. * - * @param { string } appId - Identifies the application that the database belong to. + * @param { string } appId - Identifies the application that the database belong to, and cannot exceed 256 characters. * @param { string } storeId - Identifies the KVStore database to close. The storeId can consist of only letters, digits, * and underscores (_), and cannot exceed 128 characters. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -2850,11 +3029,12 @@ declare namespace distributedKVStore { *

You can use this method to delete a KVStore database not in use. After the database is deleted, all its data will be * lost. * - * @param { string } appId - Identifies the application that the database belong to. + * @param { string } appId - Identifies the application that the database belong to, and cannot exceed 256 characters. * @param { string } storeId - Identifies the KVStore database to delete. The storeId can consist of only letters, digits, * and underscores (_), and cannot exceed 128 characters. * @param { AsyncCallback } callback - the callback of deleteKVStore. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. * @throws { BusinessError } 15100004 - Not found. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 @@ -2867,11 +3047,12 @@ declare namespace distributedKVStore { *

You can use this method to delete a KVStore database not in use. After the database is deleted, all its data will be * lost. * - * @param { string } appId - Identifies the application that the database belong to. + * @param { string } appId - Identifies the application that the database belong to, and cannot exceed 256 characters. * @param { string } storeId - Identifies the KVStore database to delete. The storeId can consist of only letters, digits, * and underscores (_), and cannot exceed 128 characters. * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. * @throws { BusinessError } 15100004 - Not found. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 @@ -2882,9 +3063,10 @@ declare namespace distributedKVStore { * Obtains the storeId of all KVStore databases that are created by using the {@code getKVStore} method and not deleted by * calling the {@code deleteKVStore} method. * - * @param { string } appId - Identifies the application that obtains the databases. + * @param { string } appId - Identifies the application that obtains the databases, and cannot exceed 256 characters. * @param { AsyncCallback } callback - {string[]}: the storeId of all created KVStore databases. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -2894,9 +3076,10 @@ declare namespace distributedKVStore { * Obtains the storeId of all KVStore databases that are created by using the {@code getKVStore} method and not deleted by * calling the {@code deleteKVStore} method. * - * @param { string } appId - Identifies the application that obtains the databases. + * @param { string } appId - Identifies the application that obtains the databases, and cannot exceed 256 characters. * @returns { Promise } {string[]}: the storeId of all created KVStore databases. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified. + *
2.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.Core * @since 9 */ @@ -2909,7 +3092,9 @@ declare namespace distributedKVStore { * * @param { 'distributedDataServiceDie' } event - Subscribed event name, fixed as 'distributedDataServiceDie', as a service status change events. * @param { Callback } deathCallback - callback to be invoked when the data manager service is terminated. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @since 9 */ @@ -2922,7 +3107,9 @@ declare namespace distributedKVStore { * * @param { 'distributedDataServiceDie' } event - Unsubscribe event name, fixed as 'distributedDataServiceDie', as a service status change events. * @param { Callback } deathCallback - the data manager service is terminated callback which has been registered. - * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore * @since 9 */