!12821 分布式数据增加接口type描述

Merge pull request !12821 from 张琼洁/master

api/@ohos.data.preferences.d.ts

@@ -65,7 +65,7 @@ declare namespace preferences {
    */
   /**
    * Indicates possible value types
-   * 
+   *
    * @typedef {number | string | boolean | Array<number> | Array<string> | Array<boolean> | Uint8Array}
    * @syscap SystemCapability.DistributedDataManager.Preferences.Core
    * @atomicservice
@@ -73,7 +73,7 @@ declare namespace preferences {
    */
   /**
    * Indicates possible value types
-   * 
+   *
    * @typedef {number | string | boolean | Array<number> | Array<string> | Array<boolean> | Uint8Array | object | bigint}
    * @syscap SystemCapability.DistributedDataManager.Preferences.Core
    * @atomicservice
@@ -108,7 +108,6 @@ declare namespace preferences {
   /**
    * Maximum length of a key.
    *
-   * @constant
    * @syscap SystemCapability.DistributedDataManager.Preferences.Core
    * @crossplatform
    * @atomicservice
@@ -143,7 +142,6 @@ declare namespace preferences {
   /**
    * Maximum length of a value.
    *
-   * @constant
    * @syscap SystemCapability.DistributedDataManager.Preferences.Core
    * @crossplatform
    * @atomicservice
@@ -179,6 +177,7 @@ declare namespace preferences {
     /**
      * The preferences file name.
      *
+     * @type { string }
      * @syscap SystemCapability.DistributedDataManager.Preferences.Core
      * @crossplatform
      * @atomicservice
@@ -196,6 +195,7 @@ declare namespace preferences {
     /**
      * Application Group Id.
      *
+     * @type { ?(string | null | undefined) }
      * @syscap SystemCapability.DistributedDataManager.Preferences.Core
      * @StageModelOnly
      * @atomicservice

api/@ohos.data.relationalStore.d.ts

@@ -114,6 +114,7 @@ declare namespace relationalStore {
     /**
      * The name of asset.
      *
+     * @type { string }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @crossplatform
      * @since 10
@@ -123,6 +124,7 @@ declare namespace relationalStore {
     /**
      * The uri of asset.
      *
+     * @type { string }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @crossplatform
      * @since 10
@@ -132,6 +134,7 @@ declare namespace relationalStore {
     /**
      * The path of asset.
      *
+     * @type { string }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @crossplatform
      * @since 10
@@ -141,6 +144,7 @@ declare namespace relationalStore {
     /**
      * The create time of asset.
      *
+     * @type { string }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @crossplatform
      * @since 10
@@ -150,6 +154,7 @@ declare namespace relationalStore {
     /**
      * The modify time of asset.
      *
+     * @type { string }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @crossplatform
      * @since 10
@@ -159,6 +164,7 @@ declare namespace relationalStore {
     /**
      * The size of asset.
      *
+     * @type { string }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @crossplatform
      * @since 10
@@ -168,6 +174,7 @@ declare namespace relationalStore {
     /**
      * The status of asset.
      *
+     * @type { ?AssetStatus }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @crossplatform
      * @since 10
@@ -287,6 +294,7 @@ declare namespace relationalStore {
     /**
      * The database name.
      *
+     * @type { string }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @crossplatform
      * @since 10
@@ -296,6 +304,7 @@ declare namespace relationalStore {
     /**
      * Specifies the security level of the database.
      *
+     * @type { SecurityLevel }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @crossplatform
      * @since 9
@@ -305,6 +314,7 @@ declare namespace relationalStore {
     /**
      * Specifies whether the database is encrypted.
      *
+     * @type { ?boolean }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @since 9
      */
@@ -313,6 +323,7 @@ declare namespace relationalStore {
     /**
      * The data group id of application.
      *
+     * @type { ?string }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @StageModelOnly
      * @since 10
@@ -432,6 +443,7 @@ declare namespace relationalStore {
     /**
      * Describes the total number of data to sync.
      *
+     * @type { number }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @since 10
      */
@@ -440,6 +452,7 @@ declare namespace relationalStore {
     /**
      * Describes the number of successfully synced data.
      *
+     * @type { number }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @since 10
      */
@@ -448,6 +461,7 @@ declare namespace relationalStore {
     /**
      * Describes the number of data failed to sync.
      *
+     * @type { number }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @since 10
      */
@@ -456,6 +470,7 @@ declare namespace relationalStore {
     /**
      * Describes the number of data remained to sync.
      *
+     * @type { number }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @since 10
      */
@@ -473,6 +488,7 @@ declare namespace relationalStore {
     /**
      * Describes the {@code Statistic} details of the upload process.
      *
+     * @type { Statistic }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @since 10
      */
@@ -481,6 +497,7 @@ declare namespace relationalStore {
     /**
      * Describes the {@code Statistic} details of the download process.
      *
+     * @type { Statistic }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @since 10
      */
@@ -571,6 +588,7 @@ declare namespace relationalStore {
     /**
      * Describes the status of data sync progress.
      *
+     * @type { Progress }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @since 10
      */
@@ -579,6 +597,7 @@ declare namespace relationalStore {
     /**
      * Describes the code of data sync progress.
      *
+     * @type { ProgressCode }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @since 10
      */
@@ -860,6 +879,7 @@ declare namespace relationalStore {
     /**
      * Indicates the changed table
      *
+     * @type { string }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @since 10
      */
@@ -868,6 +888,7 @@ declare namespace relationalStore {
     /**
      * Indicates the changed type
      *
+     * @type { ChangeType }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @since 10
      */
@@ -877,6 +898,7 @@ declare namespace relationalStore {
      * Indicates if there is a string primary key, the inserted will keep data's primary keys
      * otherwise it will keep the data's rowid.
      *
+     * @type { Array<string> | Array<number> }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @since 10
      */
@@ -886,6 +908,7 @@ declare namespace relationalStore {
      * Indicates if there is a string primary key, the updated will keep data's primary keys
      * otherwise it will keep the data's rowid.
      *
+     * @type { Array<string> | Array<number> }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @since 10
      */
@@ -895,6 +918,7 @@ declare namespace relationalStore {
      * Indicates if there is a string primary key, the deleted will keep data's primary keys
      * otherwise it will keep the data's rowid.
      *
+     * @type { Array<string> | Array<number> }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @since 10
      */
@@ -986,6 +1010,7 @@ declare namespace relationalStore {
     /**
      * Specifies whether the database auto sync.
      *
+     * @type { boolean }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @since 10
      */
@@ -2008,6 +2033,7 @@ declare namespace relationalStore {
      * The column names are returned as a string array, in which the strings are in the same order
      * as the columns in the result set.
      *
+     * @type { Array<string> }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @crossplatform
      * @since 10
@@ -2027,6 +2053,7 @@ declare namespace relationalStore {
      * The returned number is equal to the length of the string array returned by the
      * columnNames method.
      *
+     * @type { number }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @crossplatform
      * @since 10
@@ -2042,6 +2069,7 @@ declare namespace relationalStore {
     /**
      * Obtains the number of rows in the result set.
      *
+     * @type { number }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @crossplatform
      * @since 10
@@ -2059,6 +2087,7 @@ declare namespace relationalStore {
      * Obtains the current index of the result set.
      * The result set index starts from 0.
      *
+     * @type { number }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @crossplatform
      * @since 10
@@ -2074,6 +2103,7 @@ declare namespace relationalStore {
     /**
      * Checks whether the cursor is positioned at the first row.
      *
+     * @type { boolean }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @crossplatform
      * @since 10
@@ -2089,6 +2119,7 @@ declare namespace relationalStore {
     /**
      * Checks whether the cursor is positioned at the last row.
      *
+     * @type { boolean }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @crossplatform
      * @since 10
@@ -2104,6 +2135,7 @@ declare namespace relationalStore {
     /**
      * Checks whether the cursor is positioned after the last row.
      *
+     * @type { boolean }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @crossplatform
      * @since 10
@@ -2119,6 +2151,7 @@ declare namespace relationalStore {
     /**
      * Checks whether the cursor is positioned before the first row.
      *
+     * @type { boolean }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @crossplatform
      * @since 10
@@ -2136,6 +2169,7 @@ declare namespace relationalStore {
      * Checks whether the current result set is closed.
      * If the result set is closed by calling the close method, true will be returned.
      *
+     * @type { boolean }
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @crossplatform
      * @since 10
@@ -3172,6 +3206,7 @@ declare namespace relationalStore {
      * Set RdbStore version. The version number must be an integer greater than 0.
      * Obtains the RdbStore version.
      *
+     * @type { number }
      * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
      * <br>2. Incorrect parameter types.
      * @throws { BusinessError } 801 - Capability not supported.
@@ -3197,7 +3232,6 @@ declare namespace relationalStore {
      * Set whether the database is rebuilt.
      *
      * @type {RebuildType}
-     * @readonly
      * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
      * @since 12
      */

api/@ohos.data.sendablePreferences.d.ets

@@ -36,7 +36,6 @@ declare namespace sendablePreferences {
   /**
    * Maximum length of a key.
    *
-   * @constant
    * @syscap SystemCapability.DistributedDataManager.Preferences.Core
    * @atomicservice
    * @since 12
@@ -46,7 +45,6 @@ declare namespace sendablePreferences {
   /**
    * Maximum length of a value.
    *
-   * @constant
    * @syscap SystemCapability.DistributedDataManager.Preferences.Core
    * @atomicservice
    * @since 12
@@ -65,6 +63,7 @@ declare namespace sendablePreferences {
     /**
      * Name of the preferences file.
      *
+     * @type { string }
      * @syscap SystemCapability.DistributedDataManager.Preferences.Core
      * @atomicservice
      * @since 12
@@ -74,6 +73,7 @@ declare namespace sendablePreferences {
     /**
      * Application group ID.
      *
+     * @type { ?(string | null) }
      * @syscap SystemCapability.DistributedDataManager.Preferences.Core
      * @StageModelOnly
      * @atomicservice