@ohos.data.unifiedDataChannel (Unified Data Channel)
As a part of the Unified Data Management Framework (UDMF), the unifiedDataChannel module provides unified data channels and standard data access interfaces for many-to-many data sharing across applications. It also provides definitions for uniform data types, such as text and image, to streamline data interaction between different applications and minimize the workload of data type adaptation. Although the UDMF does not parse user data, you are advised not to transfer sensitive personal data or privacy data due to low-level security of storage path.
NOTE
The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.
Modules to Import
import { unifiedDataChannel } from '@kit.ArkData';
ShareOptions12+
Enumerates the options for using UnifiedData in a device.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Value | Description |
|---|---|---|
| IN_APP | 0 | UnifiedData can be used only in the same application of a device. |
| CROSS_APP | 1 | UnifiedData can be used across applications of a device. |
GetDelayData12+
type GetDelayData = (type: string) => UnifiedData
Defines a function used to obtain a deferred UnifiedData object. Currently, it can be used only in the pasteboard application of the same device.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Identifier of the deferred encapsulation. |
Return value
| Type | Description |
|---|---|
| UnifiedData | UnifiedData object. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
let getDelayData: unifiedDataChannel.GetDelayData = ((type: string) => {
if (type == uniformTypeDescriptor.UniformDataType.PLAIN_TEXT) {
let plainTextDetails : Record<string, string> = {
'attr1': 'value1',
'attr2': 'value2'
}
let plainText : uniformDataStruct.PlainText = {
uniformDataType: 'general.plain-text',
textContent : 'This is a plain text example',
abstract : 'This is abstract',
details : plainTextDetails
}
let text = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT, plainText);
let textData = new unifiedDataChannel.UnifiedData(text);
return textData;
}
return new unifiedDataChannel.UnifiedData();
});
ValueType12+
type ValueType = number | string | boolean | image.PixelMap | Want | ArrayBuffer | object | null | undefined
Enumerates the data field types allowed in a unified data record.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Type | Description |
|---|---|
| number | Number. |
| string | String. |
| boolean | Boolean. |
| image.PixelMap | The value is of the image.PixelMap type. |
| Want | Want. |
| ArrayBuffer | ArrayBuffer. |
| object | Object. |
| null | Null. |
| undefined | Undefined. |
UnifiedDataProperties12+
Defines the properties of the data records in the unified data object, including the timestamp, tag, pasting range, and additional data.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| extras | Record<string, object> | No | Yes | Object of the dictionary type used to set other properties. The default value is an empty dictionary object. |
| tag | string | No | Yes | Customized tag. The default value is an empty string. |
| timestamp | Date | Yes | Yes | Timestamp when UnifiedData is generated. The default value is January 1, 1970 (UTC). |
| shareOptions | ShareOptions | No | Yes | Range, in which UnifiedData can be used. The default value is CROSS_APP. |
| getDelayData | GetDelayData | No | Yes | Callback for obtaining the deferred data. Currently, it can be used only in the pasteboard application of the same device. The default value is undefined. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
let properties = new unifiedDataChannel.UnifiedDataProperties();
properties.extras = {
key: {
title: 'MyTitle',
content: 'MyContent'
}
};
properties.tag = "This is a tag of properties";
properties.shareOptions = unifiedDataChannel.ShareOptions.CROSS_APP;
properties.getDelayData = ((type: string) => {
if (type == uniformTypeDescriptor.UniformDataType.PLAIN_TEXT) {
let plainTextDetails : Record<string, string> = {
'attr1': 'value1',
'attr2': 'value2'
}
let plainText : uniformDataStruct.PlainText = {
uniformDataType: 'general.plain-text',
textContent : 'This is a plain text example',
abstract : 'This is abstract',
details : plainTextDetails
}
let text = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT, plainText);
let textData = new unifiedDataChannel.UnifiedData(text);
return textData;
}
return new unifiedDataChannel.UnifiedData();
});
UnifiedData
Provides APIs for encapsulating a set of data records.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Properties
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| properties12+ | UnifiedDataProperties | No | No | Properties of all the data records in a unified data object, including the timestamp, tag, application range, and additional data. Atomic service API: This API can be used in atomic services since API version 12. |
constructor12+
constructor()
Defines a constructor used to create a UnifiedData object.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Example
let unifiedData = new unifiedDataChannel.UnifiedData();
constructor
constructor(record: UnifiedRecord)
Defines a constructor used to create a UnifiedData object with a data record.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| record | UnifiedRecord | Yes | Data record in the UnifiedData object. It is a UnifiedRecord object or its child class object. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
let plainText : uniformDataStruct.PlainText = {
uniformDataType: 'general.plain-text',
textContent : 'This is a plain text example',
abstract : 'This is abstract'
}
let text = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT, plainText);
let unifiedData = new unifiedDataChannel.UnifiedData(text);
addRecord
addRecord(record: UnifiedRecord): void
Adds a data record to this UnifiedRecord object.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| record | UnifiedRecord | Yes | Data record to add. It is a UnifiedRecord child class object. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
let plainText : uniformDataStruct.PlainText = {
uniformDataType: 'general.plain-text',
textContent : 'This is a plain text example',
abstract : 'This is abstract'
}
let text = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT, plainText);
let unifiedData = new unifiedDataChannel.UnifiedData(text);
let hyperlink : uniformDataStruct.Hyperlink = {
uniformDataType:'general.hyperlink',
url : 'www.XXX.com',
description : 'This is the description of the hyperlink'
}
let link = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.HYPERLINK, hyperlink);
unifiedData.addRecord(link);
getRecords
getRecords(): Array<UnifiedRecord>
Obtains all data records from this UnifiedData object. The data obtained is of the UnifiedRecord type. Before using the data, you need to use getType to obtain the data type and convert the data type to a child class.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Return value
| Type | Description |
|---|---|
| Array<UnifiedRecord> | Records in the UnifiedData object obtained. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
let plainText : uniformDataStruct.PlainText = {
uniformDataType: 'general.plain-text',
textContent : 'This is a plain text example',
abstract : 'This is abstract'
}
let text = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT, plainText);
let unifiedData = new unifiedDataChannel.UnifiedData(text);
let hyperlink : uniformDataStruct.Hyperlink = {
uniformDataType:'general.hyperlink',
url : 'www.XXX.com',
description : 'This is the description of the hyperlink'
}
let link = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.HYPERLINK, hyperlink);
unifiedData.addRecord(link);
let records = unifiedData.getRecords();
for (let i = 0; i < records.length; i++) {
let record = records[i];
let types = record.getTypes();
if (types.includes(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT)) {
let plainText = record.getEntry(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT) as unifiedDataChannel.PlainText;
console.info(`textContent: ${plainText.textContent}`);
} else if (types.includes(uniformTypeDescriptor.UniformDataType.HYPERLINK)) {
let hyperlink = record.getEntry(uniformTypeDescriptor.UniformDataType.HYPERLINK) as unifiedDataChannel.Hyperlink;
console.info(`linkUrl: ${hyperlink.url}`);
}
}
hasType12+
hasType(type: string): boolean
Checks whether this UnifiedData object contains the specified data type, including the data types added by using the addEntry function.
For file types, if the type set of UnifiedData includes general.jpeg, calling the hasType API to check for the general.image type will return true. This is because the general.jpeg type belongs to the general.image type.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Data type to check. For details, see UniformDataType. |
Return value
| Type | Description |
|---|---|
| boolean | Returns true if the specified data type exists; returns false otherwise. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
let plainText : uniformDataStruct.PlainText = {
uniformDataType: 'general.plain-text',
textContent : 'This is a plain text example',
abstract : 'This is abstract'
}
let text = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT, plainText);
let unifiedData = new unifiedDataChannel.UnifiedData(text);
let hyperlink : uniformDataStruct.Hyperlink = {
uniformDataType:'general.hyperlink',
url : 'www.XXX.com',
description : 'This is the description of the hyperlink'
}
let link = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.HYPERLINK, hyperlink);
unifiedData.addRecord(link);
let hasPlainText = unifiedData.hasType(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT);
let hasLink = unifiedData.hasType(uniformTypeDescriptor.UniformDataType.HYPERLINK);
getTypes12+
getTypes(): Array<string>
Obtains the types of all data records in this UnifiedData object.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Return value
| Type | Description |
|---|---|
| Array<string> | Array of the UniformDataType types obtained. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
let plainText : uniformDataStruct.PlainText = {
uniformDataType: 'general.plain-text',
textContent : 'This is a plain text example',
abstract : 'This is abstract'
}
let text = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT, plainText);
let unifiedData = new unifiedDataChannel.UnifiedData(text);
let hyperlink : uniformDataStruct.Hyperlink = {
uniformDataType:'general.hyperlink',
url : 'www.XXX.com',
description : 'This is the description of the hyperlink'
}
let link = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.HYPERLINK, hyperlink);
unifiedData.addRecord(link);
let types = unifiedData.getTypes();
Summary
Summarizes the data information of the unifiedData object, including the data type and size.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| summary | Record<string, number> | No | No | Dictionary type object, where the key indicates the data type (see UniformDataType), and the value indicates the total size (in bytes) of this type of records in the unified data object. Atomic service API: This API can be used in atomic services since API version 11. |
| totalSize | number | No | No | Total size of all the records in the UnifiedData object, in bytes. Atomic service API: This API can be used in atomic services since API version 11. |
| overview22+ | Record<string, number> | Yes | No | Mapping between all types of unified data objects and the size of data records of the types (in bytes). If the obtained unified data object is empty, the overview property is empty. Atomic service API: This API can be used in atomic services since API version 22. |
Example
function parseSummary(summary : unifiedDataChannel.Summary) {
let summaryRecord = summary.summary as Record<string, number>;
if (summaryRecord) {
for (let item of Object.entries(summaryRecord)) {
if (item && item.length <= 1) {
continue;
}
let summaryStr : string = String(item[1]);
let info : string[] = summaryStr.split(",");
if (info.length <= 1) {
continue;
}
let key : string = info[0];
let value : string = info[1];
}
}
let overviewRecord = summary.overview as Record<string, number>;
let totalSize = summary.totalSize;
}
UnifiedRecord
An abstract definition of the data content supported by the UDMF. A UnifiedRecord object contains one or more data records, for example, a text record, an image record, or an HTML record. Since API version 15, different styles of the same content can be added to a UnifiedRecord object. Data users can obtain the corresponding styles as required.
constructor12+
constructor()
Defines a constructor used to create a UnfiedRecord object.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Example
let unifiedRecord = new unifiedDataChannel.UnifiedRecord();
constructor12+
constructor(type: string, value: ValueType)
Defines a constructor used to create a data record with the specified type and value.
If value is of the image.PixelMap type, type must be the value of OPENHARMONY_PIXEL_MAP in UniformDataType.
If value is of the Want type, type must be the value of OPENHARMONY_WANT in UniformDataType.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the data record to create. |
| value | ValueType | Yes | Value of the data record to create. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types; 3. Parameter verification failed. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
import { image } from '@kit.ImageKit';
let hyperlink : uniformDataStruct.Hyperlink = {
uniformDataType:'general.hyperlink',
url : 'www.XXX.com',
description : 'This is the description of the hyperlink'
}
let hyperlinkRecord = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.HYPERLINK, hyperlink);
let plainText : uniformDataStruct.PlainText = {
uniformDataType: 'general.plain-text',
textContent : 'This is a plain text example',
abstract : 'This is abstract'
}
let text = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT, plainText);
let arrayBuffer = new ArrayBuffer(4 * 200 * 200);
let opt : image.InitializationOptions = { editable: true, pixelFormat: 3, size: { height: 200, width: 200 }, alphaType: 3 };
let pixelMap : uniformDataStruct.PixelMap = {
uniformDataType : 'openharmony.pixel-map',
pixelMap : image.createPixelMapSync(arrayBuffer, opt)
}
let pixelMapRecord = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.OPENHARMONY_PIXEL_MAP, pixelMap);
getType
getType(): string
Obtains the type of this UnfiedRecord. The data obtained by getRecords from the UnifiedData object is a UnifiedRecord object. You need to use this API to obtain the specific type of the record, convert the UnifiedRecord object to its child class, and call the child class interfaces.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Return value
| Type | Description |
|---|---|
| string | Data type obtained. For details, see UniformDataType. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
let plainText : uniformDataStruct.PlainText = {
uniformDataType: 'general.plain-text',
textContent : 'This is a plain text example',
abstract : 'This is abstract'
}
let text = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT, plainText);
let unifiedData = new unifiedDataChannel.UnifiedData(text);
let records = unifiedData.getRecords();
if (records[0].getType() == uniformTypeDescriptor.UniformDataType.PLAIN_TEXT) {
let plainText = records[0] as unifiedDataChannel.PlainText;
console.info(`textContent: ${plainText.textContent}`);
}
getValue12+
getValue(): ValueType
Obtains the value of this data record.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Return value
| Type | Description |
|---|---|
| ValueType | Value obtained. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
let text = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT, 'this is value of text');
let value = text.getValue();
let hyperlinkDetails : Record<string, string> = {
'attr1': 'value1',
'attr2': 'value2'
}
let hyperlink : uniformDataStruct.Hyperlink = {
uniformDataType:'general.hyperlink',
url : 'www.XXX.com',
description : 'This is the description of the hyperlink',
details : hyperlinkDetails
}
let hyperlinkRecord = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.HYPERLINK, hyperlink);
let hyperlinkValue = hyperlinkRecord.getValue();
addEntry15+
addEntry(type: string, value: ValueType): void
Adds data of a specified data type and content to the current data record. You can use this API to add different data types and contents to the same data.
Atomic service API: This API can be used in atomic services since API version 15.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the data to add. For details, see UniformDataType. |
| value | ValueType | Yes | Value of the data to add. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
let fileUriDetails : Record<string, string> = {
'attr1': 'value1',
'attr2': 'value2'
}
let fileUri : uniformDataStruct.FileUri = {
uniformDataType : 'general.file-uri',
oriUri : 'file://data/image/1.png',
fileType : 'general.image',
details : fileUriDetails
}
let hyperlink : uniformDataStruct.Hyperlink = {
uniformDataType:'general.hyperlink',
url : 'file://data/image/1.png',
description : 'This is the description of the hyperlink'
}
let unifiedData = new unifiedDataChannel.UnifiedData();
let record = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.HYPERLINK, hyperlink);
record.addEntry(uniformTypeDescriptor.UniformDataType.FILE_URI, fileUri);
unifiedData.addRecord(record);
getEntry15+
getEntry(type: string): ValueType
Obtains data of the specified type from the data record.
Atomic service API: This API can be used in atomic services since API version 15.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the data to obtain. For details, see UniformDataType. |
Return value
| Type | Description |
|---|---|
| ValueType | Value obtained. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
let fileUriDetails : Record<string, string> = {
'attr1': 'value1',
'attr2': 'value2'
}
let fileUri : uniformDataStruct.FileUri = {
uniformDataType : 'general.file-uri',
oriUri : 'file://data/image/1.png',
fileType : 'general.image',
details : fileUriDetails
}
let formDetails : Record<string, string> = {
'attr1': 'value1',
'attr2': 'value2'
}
let form : uniformDataStruct.Form = {
uniformDataType : 'openharmony.form',
formId : 1,
formName : 'form',
bundleName : 'com.xx.app',
abilityName : 'ability',
module : 'module',
details : formDetails
}
let unifiedData = new unifiedDataChannel.UnifiedData();
let record = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.OPENHARMONY_FORM, form);
record.addEntry(uniformTypeDescriptor.UniformDataType.FILE_URI, fileUri);
unifiedData.addRecord(record);
let records = unifiedData.getRecords();
for (let i = 0; i < records.length; i++) {
let unifiedDataRecord = records[i] as unifiedDataChannel.UnifiedRecord;
let fileUriRead : uniformDataStruct.FileUri = unifiedDataRecord.getEntry(uniformTypeDescriptor.UniformDataType.FILE_URI) as uniformDataStruct.FileUri;
if (fileUriRead != undefined) {
console.info(`oriUri: ${fileUriRead.oriUri}`);
}
let formRead = unifiedDataRecord.getEntry(uniformTypeDescriptor.UniformDataType.OPENHARMONY_FORM) as uniformDataStruct.Form;
if (formRead != undefined) {
console.info(`formName: ${formRead.formName}`);
}
}
getEntries15+
getEntries(): Record<string, ValueType>
Obtains all the data in the current data record.
Atomic service API: This API can be used in atomic services since API version 15.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Return value
| Type | Description |
|---|---|
| Record<string, ValueType> | Values and types obtained. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
let fileUriDetails : Record<string, string> = {
'attr1': 'value1',
'attr2': 'value2'
}
let fileUri : uniformDataStruct.FileUri = {
uniformDataType : 'general.file-uri',
oriUri : 'file://data/image/1.png',
fileType : 'general.image',
details : fileUriDetails
}
let formDetails : Record<string, string> = {
'attr1': 'value1',
'attr2': 'value2'
}
let form : uniformDataStruct.Form = {
uniformDataType : 'openharmony.form',
formId : 1,
formName : 'form',
bundleName : 'com.xx.app',
abilityName : 'ability',
module : 'module',
details : formDetails
}
let unifiedData = new unifiedDataChannel.UnifiedData();
let record = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.OPENHARMONY_FORM, form);
record.addEntry(uniformTypeDescriptor.UniformDataType.FILE_URI, fileUri);
unifiedData.addRecord(record);
let records = unifiedData.getRecords();
for (let i = 0; i < records.length; i++) {
let unifiedDataRecord = records[i] as unifiedDataChannel.UnifiedRecord;
let entries : Record<string, unifiedDataChannel.ValueType> = unifiedDataRecord.getEntries();
let formRead : uniformDataStruct.Form = entries[uniformTypeDescriptor.UniformDataType.OPENHARMONY_FORM] as uniformDataStruct.Form;
if (formRead != undefined) {
console.info(`formName: ${formRead.formName}`);
}
let fileUriRead : uniformDataStruct.FileUri = entries[uniformTypeDescriptor.UniformDataType.FILE_URI] as uniformDataStruct.FileUri;
if (fileUriRead != undefined) {
console.info(`oriUri: ${fileUriRead.oriUri}`);
}
}
getTypes15+
getTypes(): Array<string>
Obtains all the data types in the data record. This API can be called using the UnifiedRecord object to query all data types in the record, including the data types added using the addEntry function.
Atomic service API: This API can be used in atomic services since API version 15.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Return value
| Type | Description |
|---|---|
| Array<string> | Array of UniformDataTypes obtained. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
let fileUriDetails : Record<string, string> = {
'attr1': 'value1',
'attr2': 'value2'
}
let fileUri : uniformDataStruct.FileUri = {
uniformDataType : 'general.file-uri',
oriUri : 'file://data/image/1.png',
fileType : 'general.image',
details : fileUriDetails
}
let formDetails : Record<string, string> = {
'attr1': 'value1',
'attr2': 'value2'
}
let form : uniformDataStruct.Form = {
uniformDataType : 'openharmony.form',
formId : 1,
formName : 'form',
bundleName : 'com.xx.app',
abilityName : 'ability',
module : 'module',
details : formDetails
}
let unifiedData = new unifiedDataChannel.UnifiedData();
let record = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.OPENHARMONY_FORM, form);
record.addEntry(uniformTypeDescriptor.UniformDataType.FILE_URI, fileUri);
unifiedData.addRecord(record);
let records = unifiedData.getRecords();
for (let i = 0; i < records.length; i++) {
let unifiedDataRecord = records[i] as unifiedDataChannel.UnifiedRecord;
let types : Array<string> = unifiedDataRecord.getTypes();
if (types.includes(uniformTypeDescriptor.UniformDataType.OPENHARMONY_FORM)) {
console.info(`Types include: ${uniformTypeDescriptor.UniformDataType.OPENHARMONY_FORM}`);
}
}
Text
Represents the text data. It is a child class of UnifiedRecord and a base class of text data. You are advised to use the child class of Text, for example, PlainText, Hyperlink, and HTML, to describe data.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| details | Record<string, string> | No | Yes | A dictionary type object, where both the key and value are of the string type and are used to describe the text content. For example, a data object with the following content can be created to describe a text file: { "title":"Title of the file", "content":"Content of the file" } The default value is an empty dictionary object. |
Example
let text = new unifiedDataChannel.Text();
text.details = {
title: 'MyTitle',
content: 'This is content'
};
let unifiedData = new unifiedDataChannel.UnifiedData(text);
PlainText
Represents the plain text data. It is a child class of Text.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| textContent | string | No | No | Plaintext content. |
| abstract | string | No | Yes | Text abstract. This parameter is optional. The default value is an empty string. |
Example
let text = new unifiedDataChannel.PlainText();
text.textContent = 'this is textContent';
text.abstract = 'This is abstract';
Hyperlink
Represents the hyperlink data. It is a child class of Text.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| url | string | No | No | URL. |
| description | string | No | Yes | Description of the linked content. This parameter is optional. The default value is an empty string. |
Example
let link = new unifiedDataChannel.Hyperlink();
link.url = 'www.XXX.com';
link.description = 'This is description';
HTML
Represents the HTML data. It is a child class of Text.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| htmlContent | string | No | No | Content in HTML format. |
| plainContent | string | No | Yes | Plaintext without HTML tags. This parameter is optional. The default value is an empty string. |
Example
let html = new unifiedDataChannel.HTML();
html.htmlContent = '<div><p>Title</p></div>';
html.plainContent = 'This is plainContent';
File
Represents the file data. It is a child class of UnifiedRecord and a base class of the data of the file type. You are advised to use the child class of File, for example, Image, Video, and Folder, to describe data.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| details | Record<string, string> | No | Yes | A dictionary type object, where both the key and value are of the string type and are used to describe file information. For example, a data object with the following content can be created to describe a file: { "name":"File name", "type":"File type" } The default value is an empty dictionary object. |
| uri | string | No | No | URI of the local file or online file. The local file URI can be obtained using the getUriFromPath function. |
Example
import { unifiedDataChannel } from '@kit.ArkData';
import { fileUri } from '@kit.CoreFileKit'
import { UIAbility } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
export default class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage: window.WindowStage) {
let context = this.context;
let pathDir = context.filesDir;
let file = new unifiedDataChannel.File();
file.details = {
name: 'test',
type: 'txt'
};
let filePath = pathDir + '/test.txt';
file.uri = fileUri.getUriFromPath(filePath);
}
}
Image
Represents the image data. It is a child class of File and is used to describe images.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| imageUri | string | No | No | URI of the local image or online image. The local image URI can be obtained using the getUriFromPath function. |
Example
import { unifiedDataChannel } from '@kit.ArkData';
import { fileUri } from '@kit.CoreFileKit'
import { UIAbility } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
export default class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage: window.WindowStage) {
let context = this.context;
let pathDir = context.filesDir;
let image = new unifiedDataChannel.Image();
let filePath = pathDir + '/test.jpg';
image.imageUri = fileUri.getUriFromPath(filePath);
}
}
Video
Represents video data. It is a child class of File and is used to describe a video file.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| videoUri | string | No | No | URI of the local video or online video. The local video URI can be obtained using the getUriFromPath function. |
Example
import { unifiedDataChannel } from '@kit.ArkData';
import { fileUri } from '@kit.CoreFileKit'
import { UIAbility } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
export default class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage: window.WindowStage) {
let context = this.context;
let pathDir = context.filesDir;
let video = new unifiedDataChannel.Video();
let filePath = pathDir + '/test.mp4';
video.videoUri =fileUri.getUriFromPath(filePath);
}
}
Audio
Represents audio data. It is a child class of File and is used to describe an audio file.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| audioUri | string | No | No | URI of the local audio or online audio. The local audio URI can be obtained using the getUriFromPath function. |
Example
import { unifiedDataChannel } from '@kit.ArkData';
import { fileUri } from '@kit.CoreFileKit'
import { UIAbility } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
export default class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage: window.WindowStage) {
let context = this.context;
let pathDir = context.filesDir;
let audio = new unifiedDataChannel.Audio();
let filePath = pathDir + '/test.mp3';
audio.audioUri = fileUri.getUriFromPath(filePath);
}
}
Folder
Represents the folder data. It is a child class of File and is used to describe a folder.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| folderUri | string | No | No | URI of the local folder or online folder. The local folder URI can be obtained using the getUriFromPath function. |
Example
import { unifiedDataChannel } from '@kit.ArkData';
import { fileUri } from '@kit.CoreFileKit'
import { UIAbility } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
export default class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage: window.WindowStage) {
let context = this.context;
let pathDir = context.filesDir;
let folder = new unifiedDataChannel.Folder();
let filePath = pathDir + '/folder';
folder.folderUri = fileUri.getUriFromPath(filePath);
}
}
SystemDefinedRecord
Represents specific data types defined by OpenHarmony. It is a child class of UnifiedRecord and a base class of OpenHarmony-specific data types. You are advised to use the child class of SystemDefinedRecord, for example, SystemDefinedForm, SystemDefinedAppItem, and SystemDefinedPixelMap, to describe OpenHarmony-specific data.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| details | Record<string, number | string | Uint8Array> | No | Yes | A dictionary type object, where the key is of the string type, and the value can be a number, a string, or a Uint8Array. The default value is an empty dictionary object. |
Example
let sdr = new unifiedDataChannel.SystemDefinedRecord();
let u8Array = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
sdr.details = {
title: 'recordTitle',
version: 1,
content: u8Array
};
let unifiedData = new unifiedDataChannel.UnifiedData(sdr);
SystemDefinedForm
Represents the service widget data defined by the system. It is a child class of SystemDefinedRecord.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| formId | number | No | No | Service widget ID. |
| formName | string | No | No | Widget name. |
| bundleName | string | No | No | Name of the bundle to which the widget belongs. |
| abilityName | string | No | No | Ability name corresponding to the widget. |
| module | string | No | No | Name of the module to which the widget belongs. |
Example
let form = new unifiedDataChannel.SystemDefinedForm();
form.formId = 123456;
form.formName = 'MyFormName';
form.bundleName = 'MyBundleName';
form.abilityName = 'MyAbilityName';
form.module = 'MyModule';
let u8Array = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
form.details = {
formKey1: 123,
formKey2: 'formValue',
formKey3: u8Array
};
let unifiedData = new unifiedDataChannel.UnifiedData(form);
SystemDefinedAppItem
Represents the data of the home screen icon defined by the system. It is a child class of SystemDefinedRecord.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| appId | string | No | No | ID of the application, for which the icon is used. |
| appName | string | No | No | Name of the application, for which the icon is used. |
| appIconId | string | No | No | Image ID of the icon. Model restriction: This API can be used only in the stage model. |
| appLabelId | string | No | No | Label ID corresponding to the icon name. Model restriction: This API can be used only in the stage model. |
| bundleName | string | No | No | Bundle name corresponding to the icon. |
| abilityName | string | No | No | Application ability name corresponding to the icon. |
Example
let appItem = new unifiedDataChannel.SystemDefinedAppItem();
appItem.appId = 'MyAppId';
appItem.appName = 'MyAppName';
appItem.appIconId = 'MyAppIconId';
appItem.appLabelId = 'MyAppLabelId';
appItem.bundleName = 'MyBundleName';
appItem.abilityName = 'MyAbilityName';
let u8Array = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
appItem.details = {
appItemKey1: 123,
appItemKey2: 'appItemValue',
appItemKey3: u8Array
};
let unifiedData = new unifiedDataChannel.UnifiedData(appItem);
SystemDefinedPixelMap
Represents the image data type corresponding to PixelMap defined by the system. It is a child class of SystemDefinedRecord and holds only binary data of PixelMap.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| rawData | Uint8Array | No | No | Binary data of the PixelMap object. |
Example
import { image } from '@kit.ImageKit'; // Module where the PixelMap class is defined.
import { unifiedDataChannel, uniformTypeDescriptor } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
const color = new ArrayBuffer(96); // Create a pixelMap object.
let opts: image.InitializationOptions = {
editable: true, pixelFormat: 3, size: {
height: 4, width: 6
}
}
image.createPixelMap(color, opts, (error, pixelMap) => {
if (error) {
console.error('Failed to create pixelMap.');
} else {
console.info('Succeeded in creating pixelMap.');
let arrayBuf = new ArrayBuffer(pixelMap.getPixelBytesNumber());
pixelMap.readPixelsToBuffer(arrayBuf);
let u8Array = new Uint8Array(arrayBuf);
let sdPixel = new unifiedDataChannel.SystemDefinedPixelMap();
sdPixel.rawData = u8Array;
let unifiedData = new unifiedDataChannel.UnifiedData(sdPixel);
// Read the record of the pixelMap type from unifiedData.
let records = unifiedData.getRecords();
for (let i = 0; i < records.length; i++) {
if (records[i].getType() === uniformTypeDescriptor.UniformDataType.OPENHARMONY_PIXEL_MAP) {
let pixelMapRecord = records[i] as unifiedDataChannel.SystemDefinedPixelMap;
let newArrayBuf = pixelMapRecord.rawData.buffer;
pixelMap.writeBufferToPixels(newArrayBuf).then(() => {
console.info('Succeeded in writing data from buffer to a pixelMap');
}).catch((error: BusinessError) => {
console.error(`Failed to write data from a buffer to a PixelMap. code is ${error.code}, message is ${error.message}`);
})
}
}
}
})
ApplicationDefinedRecord
Represents the custom data type for applications only. It is a child class of UnifiedRecord and a base class of custom data types of applications. Applications can extend custom data types based on this class.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| applicationDefinedType | string | No | No | Application's custom data type identifier, which must start with ApplicationDefined. |
| rawData | Uint8Array | No | No | Binary data of the custom data type. |
Example
let record = new unifiedDataChannel.ApplicationDefinedRecord();
let u8Array = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
record.applicationDefinedType = 'ApplicationDefinedType';
record.rawData = u8Array;
let unifiedData = new unifiedDataChannel.UnifiedData(record);
Intention
Enumerates the data channel types supported by the UDMF. It is used to identify different service scenarios, to which the UDMF data channels apply.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Value | Description |
|---|---|---|
| DATA_HUB | 'DataHub' | Public data channel. Atomic service API: This API can be used in atomic services since API version 11. |
| DRAG14+ | 'Drag' | Channel in which data can be dragged and dropped. Model restriction: This API can be used only in the stage model. Use scenario: This API is used to share data across applications in drag-and-drop scenarios. |
| SYSTEM_SHARE20+ | 'SystemShare' | Data channel of the system sharing type. Model restriction: This API can be used only in the stage model. Use scenario: This API is used to share data across applications in system sharing scenarios. |
| PICKER20+ | 'Picker' | Data channel of the picker type. Model restriction: This API can be used only in the stage model. Use scenario: This API is used to share data across applications in the scenarios where a picker is used. |
| MENU20+ | 'Menu' | Data channel of the menu type. Model restriction: This API can be used only in the stage model. Use scenario: This API is used to share data across applications in the shortcut menu. |
Visibility20+
Enumerates the data visibility levels.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Value | Description |
|---|---|---|
| ALL | 0 | Visible to all applications. Model restriction: This API can be used only in the stage model. |
| OWN_PROCESS | 1 | Visible only to the data provider. Model restriction: This API can be used only in the stage model. |
Options
Defines the data operation performed by the UDMF. It includes three optional parameters: intention, key, and visibility. The three parameters can be left unspecified. For details, see the parameter description of the specific API.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| intention | Intention | No | Yes | Type of the data channel related to the data operation. Atomic service API: This API can be used in atomic services since API version 11. |
| key | string | No | Yes | Unique identifier of the data object in the UDMF, which can be obtained from the value returned by insertData. The key consists of udmf:/, intention, bundleName, and groupId with a (/) in between, for example, udmf://DataHub/com.ohos.test/0123456789. udmf:/ is fixed, DataHub is an enum of intention, com.ohos.test is the bundle name, and 0123456789 is a group ID randomly generated. Atomic service API: This API can be used in atomic services since API version 11. |
| visibility20+ | Visibility | No | Yes | Data visibility level. This parameter is effective only when specified during data writing. If unspecified, the default value Visibility.ALL is used. Atomic service API: This API can be used in atomic services since API version 20. |
FileConflictOptions15+
Enumerates the options for resolving file copy conflicts.
Atomic service API: This API can be used in atomic services since API version 15.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Value | Description |
|---|---|---|
| OVERWRITE | 0 | Overwrite the file with the same name in the destination directory. |
| SKIP | 1 | Skip the file if there is a file with the same name in the destination directory. |
ProgressIndicator15+
Enumerates the progress indicator options.
Atomic service API: This API can be used in atomic services since API version 15.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Value | Description |
|---|---|---|
| NONE | 0 | Do not use the default progress indicator. |
| DEFAULT | 1 | Use the default progress indicator. If data is obtained within 500 ms, the default progress bar is not started. |
ListenerStatus15+
Enumerates the status codes returned when data is obtained from the UDMF.
Atomic service API: This API can be used in atomic services since API version 15.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Value | Description |
|---|---|---|
| FINISHED | 0 | The task is completed. |
| PROCESSING | 1 | The task is being processed. |
| CANCELED | 2 | The task is canceled. |
| INNER_ERROR | 200 | An internal error occurs. |
| INVALID_PARAMETERS | 201 | GetDataParams contains invalid parameters. |
| DATA_NOT_FOUND | 202 | No data is obtained. |
| SYNC_FAILED | 203 | Failed to sync data. |
| COPY_FILE_FAILED | 204 | Failed to copy data. |
ProgressInfo15+
Represents the progress information.
Atomic service API: This API can be used in atomic services since API version 15.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| progress | number | No | No | Progress of the drag task, in percentage. The value is an integer ranging from -1 to 100. The value -1 indicates a failure to obtain data, and the value 100 indicates data is obtained. |
| status | ListenerStatus | No | No | Status code of the drag task reported by the system. |
DataProgressListener15+
type DataProgressListener = (progressInfo: ProgressInfo, data: UnifiedData | null) => void
Defines the callback used to return the data retrieval progress information and data obtained.
Atomic service API: This API can be used in atomic services since API version 15.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| progressInfo | ProgressInfo | Yes | Progress information to report. |
| data | UnifiedData | null | Yes | Data obtained when the progress reaches 100. If the progress does not reach 100, null is returned. |
GetDataParams15+
Represents the parameters for obtaining data from UDMF, including the destination directory, option for resolving file conflicts, and progress indicator type.
For details, see Obtaining Data Asynchronously Through Drag-and-Drop.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| progressIndicator | ProgressIndicator | No | No | Progress indicator options. You can use the default progress indicator as required. Atomic service API: This API can be used in atomic services since API version 15. |
| dataProgressListener | DataProgressListener | No | No | Callback used to return the data retrieval progress and data obtained. Atomic service API: This API can be used in atomic services since API version 15. |
| destUri | string | No | Yes | Destination directory for the file copied. If file processing is not supported, leave this parameter unspecified, which is the default value of this parameter. If file processing is supported, pass in an existing directory. If complex file processing policies are involved or multipathing file storage is required, you are advised to leave this parameter unspecified and let the application handle file copying. If this parameter is not specified, the source URI is obtained. If this parameter is specified, the specified destination URI is obtained. Atomic service API: This API can be used in atomic services since API version 15. |
| fileConflictOptions | FileConflictOptions | No | Yes | Option for resolving file copy conflicts. The default value is OVERWRITE. Atomic service API: This API can be used in atomic services since API version 15. |
| acceptableInfo20+ | DataLoadInfo | No | Yes | Capability of the receiver to receive data types and data records. In the lazy loading scenario, the sender can generate and return more appropriate data content based on this information. The default value is empty, indicating that the receiver does not have the data receiving capability. Atomic service API: This API can be used in atomic services since API version 20. |
DataLoadInfo20+
Defines type and quantity of the data to load.
- Used by the data sender to define the data range that can be provided. This field is mandatory.
- Used by the data receiver to define the expected data type and quantity. This field is optional.
Atomic service API: This API can be used in atomic services since API version 20.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| types | Set<string> | No | Yes | Data type set. The default value is an empty set. |
| recordCount | number | No | Yes | Maximum number of data records, ranging from 0 to 232-1. The default value is 0. If the value is out of the range, the default value is used. If the value is a floating point number, only the integer part is used. If the value is used for drag and drop, it is displayed as the number of badges with a maximum value of 231-1. If the value exceeds the maximum, no badge is displayed. In addition, the priority of this API is lower than the numberBadge method in DragPreviewOptions. |
DataLoadHandler20+
type DataLoadHandler = (acceptableInfo?: DataLoadInfo) => UnifiedData | null
Defines a handler for lazy data loading. The data sender can dynamically generate data based on the information passed by the data receiver to implement more flexible and precise data interaction policies.
This API is a synchronous function and is applicable to simple service logic. If the service logic is complex and the execution time lasts for more than 3s, you are advised to use the asynchronous handler DelayedDataLoadHandler.
Atomic service API: This API can be used in atomic services since API version 20.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| acceptableInfo | DataLoadInfo | No | Data type and quantity to receive. The default value is empty. |
Return value
| Type | Description |
|---|---|
| UnifiedData | null | Returns UnifiedData or null when the processing function for lazy data loading is triggered. |
DelayedDataLoadHandler22+
type DelayedDataLoadHandler = (acceptableInfo?: DataLoadInfo) => Promise<UnifiedData | null>
Defines a handler for lazy data loading. The data sender can dynamically generate data based on the information passed by the data receiver to implement more flexible and precise data interaction policies.
This API is an asynchronous function, which uses a promise to return the result. It does not block the main thread and can be used to process time-consuming tasks with complex service logic.
Atomic service API: This API can be used in atomic services since API version 22.
Model restriction: This API can be used only in the stage model.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| acceptableInfo | DataLoadInfo | No | Data type and quantity to receive. The default value is empty. |
Return value
| Type | Description |
|---|---|
| Promise<UnifiedData | null> | Promise used to return the result. |
DataLoadParams20+
Defines the data loading policy for the data sender in the lazy loading scenario.
If both loadHandler and delayedDataLoadHandler are passed, delayedDataLoadHandler is preferentially used, and loadHandler does not take effect.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
| loadHandler | DataLoadHandler | No | No | Processing function used for lazy data loading. Atomic service API: This API can be used in atomic services since API version 20. |
| delayedDataLoadHandler22+ | DelayedDataLoadHandler | No | Yes | Asynchronous handler used for lazy data loading. Atomic service API: This API can be used in atomic services since API version 22. Model restriction: This API can be used only in the stage model. |
| dataLoadInfo | DataLoadInfo | No | No | Data type and quantity that can be generated by the sender. Atomic service API: This API can be used in atomic services since API version 20. |
unifiedDataChannel.insertData
insertData(options: Options, data: UnifiedData, callback: AsyncCallback<string>): void
Inserts data to the UDMF public data channel. This API uses an asynchronous callback to return the unique identifier of the data inserted.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | Options | Yes | Configuration for the data insertion operation. The intention field is mandatory (the DRAG channel is not supported). If it is not specified, error code 401 will be returned. The settings of other parameters do not affect the use of this API. |
| data | UnifiedData | Yes | Data to insert. |
| callback | AsyncCallback<string> | Yes | Callback used to return the key (unique identifier) of the data inserted. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
let plainText : uniformDataStruct.PlainText = {
uniformDataType: 'general.plain-text',
textContent : 'This is a plain text example',
abstract : 'This is abstract'
}
let text = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT, plainText);
let unifiedData = new unifiedDataChannel.UnifiedData(text);
let options: unifiedDataChannel.Options = {
intention: unifiedDataChannel.Intention.DATA_HUB
}
try {
unifiedDataChannel.insertData(options, unifiedData, (err, key) => {
if (err === undefined) {
console.info(`Succeeded in inserting data. key = ${key}`);
} else {
console.error(`Failed to insert data. code is ${err.code}, message is ${err.message} `);
}
});
} catch (e) {
let error: BusinessError = e as BusinessError;
console.error(`Insert data throws an exception. code is ${error.code}, message is ${error.message} `);
}
unifiedDataChannel.insertData
insertData(options: Options, data: UnifiedData): Promise<string>
Inserts data to the UDMF public data channel. This API uses a promise to return the unique identifier of the data inserted.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | Options | Yes | Configuration for the data insertion operation. The intention field is mandatory (the DRAG channel is not supported). If it is not specified, error code 401 will be returned. The settings of other parameters do not affect the use of this API. |
| data | UnifiedData | Yes | Data to insert. |
Return value
| Type | Description |
|---|---|
| Promise<string> | Promise used to return the key of the data inserted. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
let plainText : uniformDataStruct.PlainText = {
uniformDataType: 'general.plain-text',
textContent : 'This is a plain text example',
abstract : 'This is abstract'
}
let text = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT, plainText);
let unifiedData = new unifiedDataChannel.UnifiedData(text);
let options: unifiedDataChannel.Options = {
intention: unifiedDataChannel.Intention.DATA_HUB
}
try {
unifiedDataChannel.insertData(options, unifiedData).then((key) => {
console.info(`Succeeded in inserting data. key = ${key}`);
}).catch((err: BusinessError) => {
console.error(`Failed to insert data. code is ${err.code}, message is ${err.message} `);
});
} catch (e) {
let error: BusinessError = e as BusinessError;
console.error(`Insert data throws an exception. code is ${error.code}, message is ${error.message} `);
}
unifiedDataChannel.updateData
updateData(options: Options, data: UnifiedData, callback: AsyncCallback<void>): void
Updates the data in the UDMF public data channel. This API uses an asynchronous callback to return the result.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | Options | Yes | Configuration for the data update operation. The key field is mandatory. If it is not specified, error code 401 will be returned. Only the DATA_HUB channel of the intention parameter is supported. The settings of other parameters do not affect the use of this API. |
| data | UnifiedData | Yes | Data to update. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. If the data is updated successfully, err is undefined. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
let plainText : uniformDataStruct.PlainText = {
uniformDataType: 'general.plain-text',
textContent : 'This is a plain text example',
abstract : 'This is abstract'
}
let text = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT, plainText);
let unifiedData = new unifiedDataChannel.UnifiedData(text);
let options: unifiedDataChannel.Options = {
intention: unifiedDataChannel.Intention.DATA_HUB
}
try {
unifiedDataChannel.insertData(options, unifiedData).then((key) => {
console.info(`Succeeded in inserting data. key = ${key}`);
let updateOptions: unifiedDataChannel.Options = {
intention: unifiedDataChannel.Intention.DATA_HUB,
key: key
}
let plainTextUpdate : uniformDataStruct.PlainText = {
uniformDataType: 'general.plain-text',
textContent : 'This is plainText textContent for update',
abstract : 'This is abstract for update'
}
let textUpdate = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT, plainTextUpdate);
let unifiedDataUpdate = new unifiedDataChannel.UnifiedData(textUpdate);
try {
unifiedDataChannel.updateData(updateOptions, unifiedDataUpdate, (err) => {
if (err === undefined) {
console.info('Succeeded in updating data.');
} else {
console.error(`Failed to update data. code is ${err.code}, message is ${err.message} `);
}
});
} catch (e) {
let error: BusinessError = e as BusinessError;
console.error(`Update data throws an exception. code is ${error.code}, message is ${error.message} `);
}
}).catch((err: BusinessError) => {
console.error(`Failed to insert data. code is ${err.code}, message is ${err.message} `);
});
} catch (e) {
let error: BusinessError = e as BusinessError;
console.error(`Insert data throws an exception. code is ${error.code}, message is ${error.message} `);
}
unifiedDataChannel.updateData
updateData(options: Options, data: UnifiedData): Promise<void>
Updates the data in the UDMF public data channel. This API uses a promise to return the result.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | Options | Yes | Configuration for the data update operation. The key field is mandatory. If it is not specified, error code 401 will be returned. Only the DATA_HUB channel of the intention parameter is supported. The settings of other parameters do not affect the use of this API. |
| data | UnifiedData | Yes | Data to update. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
let plainText : uniformDataStruct.PlainText = {
uniformDataType: 'general.plain-text',
textContent : 'This is a plain text example',
abstract : 'This is abstract'
}
let text = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT, plainText);
let unifiedData = new unifiedDataChannel.UnifiedData(text);
let options: unifiedDataChannel.Options = {
intention: unifiedDataChannel.Intention.DATA_HUB
}
try {
unifiedDataChannel.insertData(options, unifiedData).then((key) => {
console.info(`Succeeded in inserting data. key = ${key}`);
let updateOptions: unifiedDataChannel.Options = {
intention: unifiedDataChannel.Intention.DATA_HUB,
key: key
}
let plainTextUpdate : uniformDataStruct.PlainText = {
uniformDataType: 'general.plain-text',
textContent : 'This is plainText textContent for update',
abstract : 'This is abstract for update'
}
let textUpdate = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT, plainTextUpdate);
let unifiedDataUpdate = new unifiedDataChannel.UnifiedData(textUpdate);
try {
unifiedDataChannel.updateData(updateOptions, unifiedDataUpdate).then(() => {
console.info('Succeeded in updating data.');
}).catch((err: BusinessError) => {
console.error(`Failed to update data. code is ${err.code}, message is ${err.message} `);
});
} catch (e) {
let error: BusinessError = e as BusinessError;
console.error(`Update data throws an exception. code is ${error.code}, message is ${error.message} `);
}
}).catch((err: BusinessError) => {
console.error(`Failed to insert data. code is ${err.code}, message is ${err.message} `);
});
} catch (e) {
let error: BusinessError = e as BusinessError;
console.error(`Insert data throws an exception. code is ${error.code}, message is ${error.message} `);
}
unifiedDataChannel.queryData
queryData(options: Options, callback: AsyncCallback<Array<UnifiedData>>): void
Queries data in the UDMF public data channel. This API uses an asynchronous callback to return the result.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | Options | Yes | Configuration for the data query operation. Both the key and intention are optional (the DRAG channel of intention is not supported). The return value varies depending on the parameters passed in. |
| callback | AsyncCallback<Array<UnifiedData>> | Yes | Callback used to return the queried data. If only the key is specified in options, the data corresponding to the key is returned. If only the intention is specified in options, all data in the intention is returned. If both intention and key are specified, the intersection of the two is returned, which is the result obtained when only key is specified. If there is no intersection between the specified intention and key, an error object is returned. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
let options: unifiedDataChannel.Options = {
intention: unifiedDataChannel.Intention.DATA_HUB
};
try {
unifiedDataChannel.queryData(options, (err, data) => {
if (err === undefined) {
console.info(`Succeeded in querying data. size = ${data.length}`);
for (let i = 0; i < data.length; i++) {
let records = data[i].getRecords();
for (let j = 0; j < records.length; j++) {
if (records[j].getTypes().includes(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT)) {
let text = records[j].getEntry(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT) as uniformDataStruct.PlainText;
console.info(`${i + 1}.${text.textContent}`);
}
}
}
} else {
console.error(`Failed to query data. code is ${err.code}, message is ${err.message} `);
}
});
} catch (e) {
let error: BusinessError = e as BusinessError;
console.error(`Query data throws an exception. code is ${error.code}, message is ${error.message} `);
}
unifiedDataChannel.queryData
queryData(options: Options): Promise<Array<UnifiedData>>
Queries data in the UDMF public data channel. This API uses a promise to return the result.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | Options | Yes | Configuration for the data query operation. Both the key and intention are optional (the DRAG channel of intention is not supported). The return value varies depending on the parameters passed in. |
Return value
| Type | Description |
|---|---|
| Promise<Array<UnifiedData>> | Promise used to return the result queried. If only the key is specified in options, the data corresponding to the key is returned. If only the intention is specified in options, all data in the intention is returned. If both intention and key are specified, the intersection of the two is returned, which is the result obtained when only key is specified. If there is no intersection between the specified intention and key, an error object is returned. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
let options: unifiedDataChannel.Options = {
key: 'udmf://DataHub/com.ohos.test/0123456789'
};
try {
unifiedDataChannel.queryData(options).then((data) => {
console.info(`Succeeded in querying data. size = ${data.length}`);
for (let i = 0; i < data.length; i++) {
let records = data[i].getRecords();
for (let j = 0; j < records.length; j++) {
if (records[j].getTypes().includes(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT)) {
let text = records[j].getEntry(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT) as uniformDataStruct.PlainText;
console.info(`${i + 1}.${text.textContent}`);
}
}
}
}).catch((err: BusinessError) => {
console.error(`Failed to query data. code is ${err.code}, message is ${err.message} `);
});
} catch (e) {
let error: BusinessError = e as BusinessError;
console.error(`Query data throws an exception. code is ${error.code}, message is ${error.message} `);
}
unifiedDataChannel.deleteData
deleteData(options: Options, callback: AsyncCallback<Array<UnifiedData>>): void
Deletes data from the UDMF public data channel. This API uses an asynchronous callback to return the result.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | Options | Yes | Configuration for the data deletion operation. Both the key and intention are optional (only the DATA_HUB channel of intention is supported). The return value varies depending on the parameters passed in. |
| callback | AsyncCallback<Array<UnifiedData>> | Yes | Callback used to return the data deleted. If only the key is specified in options, the data corresponding to the key deleted is returned. If only the intention is specified in options, all data in the intention deleted is returned. If both intention and key are specified, the intersection of the two deleted is returned. If there is no intersection between the two, an error object is returned. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
let options: unifiedDataChannel.Options = {
intention: unifiedDataChannel.Intention.DATA_HUB
};
try {
unifiedDataChannel.deleteData(options, (err, data) => {
if (err === undefined) {
console.info(`Succeeded in deleting data. size = ${data.length}`);
for (let i = 0; i < data.length; i++) {
let records = data[i].getRecords();
for (let j = 0; j < records.length; j++) {
if (records[j].getTypes().includes(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT)) {
let text = records[j].getEntry(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT) as uniformDataStruct.PlainText;
console.info(`${i + 1}.${text.textContent}`);
}
}
}
} else {
console.error(`Failed to delete data. code is ${err.code}, message is ${err.message} `);
}
});
} catch (e) {
let error: BusinessError = e as BusinessError;
console.error(`Delete data throws an exception. code is ${error.code}, message is ${error.message} `);
}
unifiedDataChannel.deleteData
deleteData(options: Options): Promise<Array<UnifiedData>>
Deletes data from the UDMF public data channel. This API uses a promise to return the result.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | Options | Yes | Configuration for the data deletion operation. Both the key and intention are optional (only the DATA_HUB channel of intention is supported). The return value varies depending on the parameters passed in. |
Return value
| Type | Description |
|---|---|
| Promise<Array<UnifiedData>> | Promise used to return the data deleted. If only the key is specified in options, the data corresponding to the key deleted is returned. If only the intention is specified in options, all data in the intention deleted is returned. If both intention and key are specified, the intersection of the two deleted is returned. If there is no intersection between the two, an error object is returned. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types. |
Example
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
let options: unifiedDataChannel.Options = {
key: 'udmf://DataHub/com.ohos.test/0123456789'
};
try {
unifiedDataChannel.deleteData(options).then((data) => {
console.info(`Succeeded in deleting data. size = ${data.length}`);
for (let i = 0; i < data.length; i++) {
let records = data[i].getRecords();
for (let j = 0; j < records.length; j++) {
if (records[j].getTypes().includes(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT)) {
let text = records[j].getEntry(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT) as uniformDataStruct.PlainText;
console.info(`${i + 1}.${text.textContent}`);
}
}
}
}).catch((err: BusinessError) => {
console.error(`Failed to delete data. code is ${err.code}, message is ${err.message} `);
});
} catch (e) {
let error: BusinessError = e as BusinessError;
console.error(`Query data throws an exception. code is ${error.code}, message is ${error.message} `);
}
unifiedDataChannel.setAppShareOptions14+
setAppShareOptions(intention: Intention, shareOptions: ShareOptions): void
Sets the ShareOptions for the application data. Currently, only the drag-and-drop data channel is supported.
Required permissions: ohos.permission.MANAGE_UDMF_APP_SHARE_OPTION
Model restriction: This API can be used only in the stage model.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| intention | Intention | Yes | Type of the data channel. Currently, only the data channel of the DRAG type is supported. |
| shareOptions | ShareOptions | Yes | Usage scope of the UnifiedData. |
Error codes
For details about the error codes, see Universal Error Codes and UDMF Error Codes.
| ID | Error Message |
|---|---|
| 201 | Permission verification failed. The application does not have the permission required to call the API. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 20400001 | Settings already exist. To reconfigure, remove the existing sharing options. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
unifiedDataChannel.setAppShareOptions(unifiedDataChannel.Intention.DRAG, unifiedDataChannel.ShareOptions.IN_APP);
console.info(`[UDMF]setAppShareOptions success. `);
}catch (e){
let error: BusinessError = e as BusinessError;
console.error(`[UDMF]setAppShareOptions throws an exception. code is ${error.code}, message is ${error.message} `);
}
unifiedDataChannel.removeAppShareOptions14+
removeAppShareOptions(intention: Intention): void
Removes the data control information set by setAppShareOptions.
Required permissions: ohos.permission.MANAGE_UDMF_APP_SHARE_OPTION
Model restriction: This API can be used only in the stage model.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| intention | Intention | Yes | Type of the data channel. Currently, only the data channel of the DRAG type is supported. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 201 | Permission verification failed. The application does not have the permission required to call the API. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
unifiedDataChannel.removeAppShareOptions(unifiedDataChannel.Intention.DRAG);
console.info(`[UDMF]removeAppShareOptions success. `);
}catch (e){
let error: BusinessError = e as BusinessError;
console.error(`[UDMF]removeAppShareOptions throws an exception. code is ${error.code}, message is ${error.message} `);
}
unifiedDataChannel.convertRecordsToEntries17+
convertRecordsToEntries(data: UnifiedData): void
Converts the provided data into a multi-style data structure, which is useful when the original data uses multiple records to represent different styles of the same data.
This API is used only when the following rules are met:
- The number of records in data is greater than 1.
- The value of unifiedData.properties.tag is records_to_entries_data_format.
Atomic service API: This API can be used in atomic services since API version 17.
Model restriction: This API can be used only in the stage model.
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| data | UnifiedData | Yes | Data to convert. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
Example
import { unifiedDataChannel } from '@kit.ArkData';
import { uniformDataStruct, uniformTypeDescriptor } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
let details : Record<string, string> = {
'attr1': 'value1',
'attr2': 'value2'
}
let plainTextObj : uniformDataStruct.PlainText = {
uniformDataType: 'general.plain-text',
textContent : 'The weather is very good today',
abstract : 'The weather is very good today',
details : details
}
let htmlObj : uniformDataStruct.HTML = {
uniformDataType :'general.html',
htmlContent : '<div><p>The weather is very good today</p></div>',
plainContent : 'The weather is very good today',
details : details
}
let plainText = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT, plainTextObj);
let html = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.HTML, htmlObj);
let unifiedData = new unifiedDataChannel.UnifiedData(plainText);
unifiedData.addRecord(html);
unifiedData.properties.tag = 'records_to_entries_data_format';
try {
unifiedDataChannel.convertRecordsToEntries(unifiedData);
let records: Array<unifiedDataChannel.UnifiedRecord> = unifiedData.getRecords();
console.info(`Records size is ${records.length}`); // After conversion, its length must be less than 1
if (records.length == 1) {
let plainTextObjRead: uniformDataStruct.PlainText = records[0].getEntry(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT) as uniformDataStruct.PlainText;
console.info(`TextContent is ${plainTextObjRead.textContent}`);
let htmlObjRead: uniformDataStruct.HTML = records[0].getEntry(uniformTypeDescriptor.UniformDataType.HTML) as uniformDataStruct.HTML;
console.info(`HtmlContent is ${htmlObjRead.htmlContent}`);
}
} catch (e) {
let error: BusinessError = e as BusinessError;
console.error(`Convert data throws an exception. code is ${error.code}, message is ${error.message} `);
}