diff --git a/api/@ohos.data.unifiedDataChannel.d.ts b/api/@ohos.data.unifiedDataChannel.d.ts index 1c353be3b0ce7e92beefddd339774ea15070a5db..d3a08cb5576d1d5a6eca3f13d36fd6b531413340 100644 --- a/api/@ohos.data.unifiedDataChannel.d.ts +++ b/api/@ohos.data.unifiedDataChannel.d.ts @@ -53,21 +53,24 @@ declare namespace unifiedDataChannel { * @enum { number } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum ShareOptions { /** * IN_APP indicates that only use in the same app is allowed. * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ IN_APP, /** * CROSS_APP indicates that use in any app in this device is allowed. * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CROSS_APP } @@ -80,7 +83,8 @@ declare namespace unifiedDataChannel { * @returns { UnifiedData } Return the UnifiedData required. * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type GetDelayData = (type: string) => UnifiedData; @@ -107,7 +111,8 @@ declare namespace unifiedDataChannel { * * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ class UnifiedDataProperties { /** @@ -115,7 +120,8 @@ declare namespace unifiedDataChannel { * @type { ?Record } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ extras?: Record; @@ -124,7 +130,8 @@ declare namespace unifiedDataChannel { * @type { ?string } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ tag?: string; /** @@ -133,7 +140,8 @@ declare namespace unifiedDataChannel { * @readonly * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly timestamp?: Date; /** @@ -142,7 +150,8 @@ declare namespace unifiedDataChannel { * @type { ?ShareOptions } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ shareOptions?: ShareOptions; @@ -151,7 +160,8 @@ declare namespace unifiedDataChannel { * @type { ?GetDelayData } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getDelayData?: GetDelayData; } @@ -256,7 +266,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ addRecord(record: UnifiedRecord): void; /** @@ -363,7 +374,8 @@ declare namespace unifiedDataChannel { * @type { Record } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ summary: Record; /** @@ -378,7 +390,8 @@ declare namespace unifiedDataChannel { * @type { number } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ totalSize: number; } @@ -428,7 +441,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ getType(): string; @@ -493,7 +507,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ getValue(): ValueType; @@ -566,7 +581,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ class Text extends UnifiedRecord { /** @@ -590,7 +606,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ details?: Record; } @@ -617,7 +634,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ class PlainText extends Text { /** @@ -641,7 +659,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ textContent: string; /** @@ -692,7 +711,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ class Hyperlink extends Text { /** @@ -716,7 +736,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ url: string; /** @@ -740,7 +761,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ description?: string; } @@ -767,7 +789,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ class HTML extends Text { /** @@ -791,7 +814,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ htmlContent: string; /** @@ -815,7 +839,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ plainContent?: string; } @@ -842,7 +867,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ class File extends UnifiedRecord { /** @@ -866,7 +892,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ details?: Record; /** @@ -890,7 +917,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ uri: string; } @@ -917,7 +945,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ class Image extends File { /** @@ -941,7 +970,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ imageUri: string; } @@ -968,7 +998,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ class Video extends File { /** @@ -992,7 +1023,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ videoUri: string; } @@ -1019,7 +1051,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ class Audio extends File { /** @@ -1043,7 +1076,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ audioUri: string; } @@ -1070,7 +1104,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ class Folder extends File { /** @@ -1094,7 +1129,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ folderUri: string; } @@ -1114,7 +1150,8 @@ declare namespace unifiedDataChannel { * @extends UnifiedRecord * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ class SystemDefinedRecord extends UnifiedRecord { /** @@ -1129,7 +1166,8 @@ declare namespace unifiedDataChannel { * @type { ?Record } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ details?: Record; } @@ -1149,7 +1187,8 @@ declare namespace unifiedDataChannel { * @extends SystemDefinedRecord * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ class SystemDefinedForm extends SystemDefinedRecord { /** @@ -1164,7 +1203,8 @@ declare namespace unifiedDataChannel { * @type { number } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ formId: number; /** @@ -1179,7 +1219,8 @@ declare namespace unifiedDataChannel { * @type { string } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ formName: string; /** @@ -1194,7 +1235,8 @@ declare namespace unifiedDataChannel { * @type { string } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ bundleName: string; /** @@ -1209,7 +1251,8 @@ declare namespace unifiedDataChannel { * @type { string } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ abilityName: string; /** @@ -1224,7 +1267,8 @@ declare namespace unifiedDataChannel { * @type { string } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ module: string; } @@ -1244,7 +1288,8 @@ declare namespace unifiedDataChannel { * @extends SystemDefinedRecord * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ class SystemDefinedAppItem extends SystemDefinedRecord { /** @@ -1259,7 +1304,8 @@ declare namespace unifiedDataChannel { * @type { string } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ appId: string; /** @@ -1274,7 +1320,8 @@ declare namespace unifiedDataChannel { * @type { string } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ appName: string; /** @@ -1289,7 +1336,8 @@ declare namespace unifiedDataChannel { * @type { string } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ appIconId: string; /** @@ -1304,7 +1352,8 @@ declare namespace unifiedDataChannel { * @type { string } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ appLabelId: string; /** @@ -1319,7 +1368,8 @@ declare namespace unifiedDataChannel { * @type { string } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ bundleName: string; /** @@ -1334,7 +1384,8 @@ declare namespace unifiedDataChannel { * @type { string } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ abilityName: string; } @@ -1354,7 +1405,8 @@ declare namespace unifiedDataChannel { * @extends SystemDefinedRecord * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ class SystemDefinedPixelMap extends SystemDefinedRecord { /** @@ -1369,7 +1421,8 @@ declare namespace unifiedDataChannel { * @type { Uint8Array } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ rawData: Uint8Array; } @@ -1389,7 +1442,8 @@ declare namespace unifiedDataChannel { * @extends UnifiedRecord * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ class ApplicationDefinedRecord extends UnifiedRecord { /** @@ -1406,7 +1460,8 @@ declare namespace unifiedDataChannel { * @type { string } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ applicationDefinedType: string; /** @@ -1421,7 +1476,8 @@ declare namespace unifiedDataChannel { * @type { Uint8Array } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ rawData: Uint8Array; } @@ -1439,7 +1495,8 @@ declare namespace unifiedDataChannel { * @enum { string } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ enum Intention { /** @@ -1453,7 +1510,8 @@ declare namespace unifiedDataChannel { * * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ DATA_HUB = 'DataHub', @@ -1470,7 +1528,8 @@ declare namespace unifiedDataChannel { * * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @stagemodelonly - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ DRAG = 'Drag' } @@ -1484,12 +1543,13 @@ declare namespace unifiedDataChannel { /** * Describe the optional arguments of data operation * - * @typedef { object } + * @interface Options * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - type Options = { + interface Options { /** * Indicates the target Intention * @@ -1499,9 +1559,11 @@ declare namespace unifiedDataChannel { /** * Indicates the target Intention * + * @type { Intention } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ intention?: Intention; @@ -1514,12 +1576,14 @@ declare namespace unifiedDataChannel { /** * Indicates the unique identifier of target UnifiedData * + * @type { string } * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ key?: string; - }; + } /** * Defines the types of file conflict options when getting data from the UDMF. @@ -1772,7 +1836,8 @@ declare namespace unifiedDataChannel { *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function insertData(options: Options, data: UnifiedData, callback: AsyncCallback): void; @@ -1797,7 +1862,8 @@ declare namespace unifiedDataChannel { *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function insertData(options: Options, data: UnifiedData): Promise; @@ -1870,7 +1936,8 @@ declare namespace unifiedDataChannel { *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function queryData(options: Options, callback: AsyncCallback>): void; @@ -1893,7 +1960,8 @@ declare namespace unifiedDataChannel { *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function queryData(options: Options): Promise>;