diff --git a/api/@ohos.data.unifiedDataChannel.d.ts b/api/@ohos.data.unifiedDataChannel.d.ts index f7137aba69dc901301ee969ed9e085717dba6f5e..f111323a3fc3085ae2bcbce30b0591db69c2532b 100644 --- a/api/@ohos.data.unifiedDataChannel.d.ts +++ b/api/@ohos.data.unifiedDataChannel.d.ts @@ -219,10 +219,22 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since arkts {'1.1':'14', '1.2':'20'} - * @arkts 1.1&1.2 + * @since 14 */ constructor(record: UnifiedRecord); + + /** + * Create unified data with a record + * + * @param { UnifiedRecord } record - Record will add into unified data. + * @throws { BusinessError } 401 - Parameter error. Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.UDMF.Core + * @since 20 + * @arkts 1.2 + */ + constructor ctorWithRecord(record: UnifiedRecord); + /** * Create a empty unified data. * @@ -240,6 +252,12 @@ declare namespace unifiedDataChannel { * @arkts 1.1&1.2 */ constructor(); + + /** + * @arkts 1.2 + */ + overload constructor { ctorWithRecord }; + /** * Add a record into unified data * @@ -502,11 +520,30 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since arkts {'1.1':'14', '1.2':'20'} - * @arkts 1.1&1.2 + * @since 14 */ constructor(type: string, value: ValueType); + /** + * Create unified record by type and value. + * + * @param { string } type - indicates to data type of unified record. It can not be empty. When type of value is + * object, parameter type must be pixel-map or want UTD type. + * @param { ValueType } value - indicates to value of unified record. + * @throws { BusinessError } 401 - Parameter error. Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.UDMF.Core + * @since 20 + * @arkts 1.2 + */ + constructor ctorWithValueType(type: string, value: ValueType); + + /** + * @arkts 1.2 + */ + overload constructor { ctorWithValueType }; + /** * Get the value of unified record. * @@ -3597,11 +3634,24 @@ declare namespace unifiedDataChannel { *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ function insertData(options: Options, data: UnifiedData, callback: AsyncCallback): void; + /** + * Insert data into unified data channel by Intention + * + * @param { Options } options - fill the intention field to indicate the target {@link Intention}. + * @param { UnifiedData } data - {@link UnifiedData} data object to insert into target intention. + * @param { AsyncCallback } callback - {string}: the unique identifier. + * @throws { BusinessError } 401 - Parameter error. Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.UDMF.Core + * @since 20 + * @arkts 1.2 + */ + function insertDataWithCallback(options: Options, data: UnifiedData, callback: AsyncCallback): void; + /** * Insert data into unified data channel by Intention * @@ -3623,11 +3673,29 @@ declare namespace unifiedDataChannel { *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ function insertData(options: Options, data: UnifiedData): Promise; + /** + * Insert data into unified data channel by Intention + * + * @param { Options } options - fill the intention field to indicate the target {@link Intention}. + * @param { UnifiedData } data - {@link UnifiedData} data object to insert into target intention. + * @returns { Promise } {string}: the unique identifier. + * @throws { BusinessError } 401 - Parameter error. Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.UDMF.Core + * @since 20 + * @arkts 1.2 + */ + function insertDataReturnsPromise(options: Options, data: UnifiedData): Promise; + + /** + * @arkts 1.2 + */ + overload insertData { insertDataWithCallback, insertDataReturnsPromise }; + /** * Update data to unified data channel by Unique Identifier * @@ -3701,11 +3769,25 @@ declare namespace unifiedDataChannel { *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ function queryData(options: Options, callback: AsyncCallback>): void; + /** + * Query data of unified data channel by Intention or Unique Identifier + * + * @param { Options } options - fill the intention or unique identifier field to indicate the target {@link Intention} + * or {@link UnifiedData}. + * @param { AsyncCallback> } callback - {Array}: the target {@link UnifiedData} object + * array. + * @throws { BusinessError } 401 - Parameter error. Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.UDMF.Core + * @since 20 + * @arkts 1.2 + */ + function queryDataWithCallback(options: Options, callback: AsyncCallback>): void; + /** * Query data of unified data channel by Intention or Unique Identifier * @@ -3727,11 +3809,29 @@ declare namespace unifiedDataChannel { *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ function queryData(options: Options): Promise>; + /** + * Query data of unified data channel by Intention or Unique Identifier + * + * @param { Options } options - fill the intention or unique identifier field to indicate the target {@link Intention} + * or {@link UnifiedData}. + * @returns { Promise> } {Array}: the target {@link UnifiedData} object array. + * @throws { BusinessError } 401 - Parameter error. Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.UDMF.Core + * @since 20 + * @arkts 1.2 + */ + function queryDataReturnsPromise(options: Options): Promise>; + + /** + * @arkts 1.2 + */ + overload queryData { queryDataWithCallback, queryDataReturnsPromise }; + /** * Delete data of unified data channel by Intention or Unique Identifier *