harmony 鸿蒙@ohos.data.UDMF（统一数据管理框架）

2023-06-24
浏览 (803)

@ohos.data.UDMF（统一数据管理框架）

本模块提供数据统一管理的能力，包括对文本、图片等数据类型的标准化定义。通过调用对应数据类型的接口，应用程序可将各种数据封装为统一数据对象。

说明：

本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import UDMF from '@ohos.data.UDMF';

UnifiedDataType

统一数据对象中各数据记录的数据类型。

系统能力： SystemCapability.DistributedDataManager.UDMF.Core

名称	值	说明
TEXT	‘Text’	文本类型。
PLAIN_TEXT	‘Text.PlainText’	纯文本类型。
HYPERLINK	‘Text.Hyperlink’	超链接类型。
HTML	‘Text.HTML’	富文本类型。
FILE	‘File’	文件类型。
IMAGE	‘File.Media.Image’	图片类型。
VIDEO	‘File.Media.Video’	视频类型。
FOLDER	‘File.Folder’	文件夹类型。
SYSTEM_DEFINED_RECORD	‘SystemDefinedType’	系统服务数据类型。
SYSTEM_DEFINED_FORM	‘SystemDefinedType.Form’	卡片类型。
SYSTEM_DEFINED_APP_ITEM	‘SystemDefinedType.AppItem’	图标类型。
SYSTEM_DEFINED_PIXEL_MAP	‘SystemDefinedType.PixelMap’	二进制图片类型。
APPLICATION_DEFINED_RECORD	‘ApplicationDefinedType’	应用自定义类型。

UnifiedData

表示UDMF统一数据对象，提供封装一组数据记录的方法。

系统能力： SystemCapability.DistributedDataManager.UDMF.Core

constructor

constructor(record: UnifiedRecord)

用于创建带有一条数据记录的统一数据对象。

系统能力： SystemCapability.DistributedDataManager.UDMF.Core

参数：

参数名	类型	必填	说明
record	UnifiedRecord	是	要添加到统一数据对象中的数据记录，该记录为UnifiedRecord子类对象。

示例：

let text = new UDMF.PlainText();
text.textContent = 'this is textContent of text';
let unifiedData = new UDMF.UnifiedData(text);

addRecord

addRecord(record: UnifiedRecord): void

在当前统一数据对象中添加一条数据记录。

系统能力： SystemCapability.DistributedDataManager.UDMF.Core

参数：

参数名	类型	必填	说明
record	UnifiedRecord	是	要添加到统一数据对象中的数据记录，该记录为UnifiedRecord子类对象。

示例：

let text1 = new UDMF.PlainText();
text1.textContent = 'this is textContent of text1';
let unifiedData = new UDMF.UnifiedData(text1);

let text2 = new UDMF.PlainText();
text2.textContent = 'this is textContent of text2';
unifiedData.addRecord(text2);

getRecords

getRecords(): Array<UnifiedRecord>

将当前统一数据对象中的所有数据记录取出。通过本接口取出的数据为UnifiedRecord类型，需通过getType获取数据类型后转为子类再使用。

系统能力 ：SystemCapability.DistributedDataManager.UDMF.Core

返回值：

类型	说明
Array<UnifiedRecord>	当前统一数据对象内所添加的记录。

示例：

let text = new UDMF.PlainText();
text.textContent = 'this is textContent of text';
let unifiedData = new UDMF.UnifiedData(text);

let link = new UDMF.Hyperlink();
link.url = 'www.XXX.com';
unifiedData.addRecord(link);

let records = unifiedData.getRecords();
for (let i = 0; i < records.length; i++) {
  let record = records[i];
  if (record.getType() == UDMF.UnifiedDataType.PLAIN_TEXT) {
    let plainText = <UDMF.PlainText> (record);
    console.info(`textContent: ${plainText.textContent}`);
  } else if (record.getType() == UDMF.UnifiedDataType.HYPERLINK) {
    let hyperlink = <UDMF.Hyperlink> (record);
    console.info(`linkUrl: ${hyperlink.url}`);
  }
}

Summary

描述某一统一数据对象的数据摘要，包括所含数据类型及大小，当前暂不支持。

系统能力： SystemCapability.DistributedDataManager.UDMF.Core

名称	类型	可读	可写	说明
summary	{ [key: string]: number }	是	否	是一个字典类型对象，key表示数据类型（见UnifiedDataType），value为统一数据对象中该类型记录大小总和（单位：Byte）。
totalSize	number	是	否	统一数据对象内记录总大小（单位：Byte）。

UnifiedRecord

对UDMF支持的数据内容的抽象定义，称为数据记录。一个统一数据对象内包含一条或多条数据记录，例如一条文本记录、一条图片记录、一条HTML记录等。

UnifiedRecord是一个抽象父类，无法保存具体数据内容，应用在使用时，不能将其添加到统一数据对象中，而应该创建带有数据内容的具体子类，如Text、Image等。

getType

getType(): string

获取当前数据记录的类型。由于从统一数据对象中调用getRecords所取出的数据是UnifiedRecord对象，因此需要通过本接口查询此记录的具体类型，再将该UnifiedRecord对象转换为其子类，调用子类接口。

系统能力 ：SystemCapability.DistributedDataManager.UDMF.Core

返回值：

类型	说明
string	当前数据记录对应的具体数据类型，见UnifiedDataType。

示例：

let text = new UDMF.PlainText();
text.textContent = 'this is textContent of text';
let unifiedData = new UDMF.UnifiedData(text);

let records = unifiedData.getRecords();
if (records[0].getType() == UDMF.UnifiedDataType.PLAIN_TEXT) {
    let plainText = <UDMF.PlainText> (records[0]);
    console.info(`textContent: ${plainText.textContent}`);
}