剪贴板

2024-01-23 17:25 更新

本模块主要提供管理系统剪贴板的能力,为系统复制、粘贴功能提供支持。系统剪贴板支持对文本、HTML、URI、Want等内容的操作。

说明

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

导入模块

  1. import pasteboard from '@ohos.pasteboard';

常量

系统能力: SystemCapability.MiscServices.Pasteboard

名称

类型

说明

MAX_RECORD_NUM7+

number

512

单个PasteData中所能包含的最大条目数。

MIMETYPE_TEXT_HTML7+

string

'text/html'

HTML内容的MIME类型定义。

MIMETYPE_TEXT_WANT7+

string

'text/want'

Want内容的MIME类型定义。

MIMETYPE_TEXT_PLAIN7+

string

'text/plain'

纯文本内容的MIME类型定义。

MIMETYPE_TEXT_URI7+

string

'text/uri'

URI内容的MIME类型定义。

MIMETYPE_PIXELMAP9+

string

'pixelMap'

PixelMap内容的MIME类型定义。

ValueType9+

用于表示允许的数据字段类型。

系统能力: SystemCapability.MiscServices.Pasteboard

类型

说明

string

表示string的类型。

image.PixelMap

表示image.PixelMap的类型。

Want

表示Want的类型。

ArrayBuffer

表示ArrayBuffer的类型。

pasteboard.createData9+

createData(mimeType: string, value: ValueType): PasteData

构建一个自定义类型的剪贴板内容对象。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

mimeType

string

自定义数据的MIME类型。

value

ValueType

自定义数据内容。

返回值:

类型

说明

PasteData

剪贴板内容对象。

示例:

  1. let dataXml = 'Hello World';
  2. let pasteData = pasteboard.createData('app/xml', dataXml);

pasteboard.createRecord9+

createRecord(mimeType: string, value: ValueType):PasteDataRecord;

创建一条自定义数据内容条目。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

mimeType

string

自定义数据的MIME类型。

value

ValueType

自定义数据内容。

返回值:

类型

说明

PasteDataRecord

一条新建的自定义数据内容条目。

示例:

  1. let dataXml = 'Hello World';
  2. let pasteDataRecord = pasteboard.createRecord('app/xml', dataXml);

pasteboard.getSystemPasteboard

getSystemPasteboard(): SystemPasteboard

获取系统剪贴板对象。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

SystemPasteboard

系统剪贴板对象。

示例:

  1. let systemPasteboard = pasteboard.getSystemPasteboard();

ShareOption9+

可粘贴数据的范围类型枚举。

系统能力: SystemCapability.MiscServices.Pasteboard

名称

说明

INAPP

0

表示仅允许同应用内粘贴。

LOCALDEVICE

1

表示允许在此设备中任何应用内粘贴。

CROSSDEVICE

2

表示允许跨设备在任何应用内粘贴。

pasteboard.createHtmlData(deprecated)

createHtmlData(htmlText: string): PasteData

构建一个HTML剪贴板内容对象。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用pasteboard.createData替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

htmlText

string

HTML内容。

返回值:

类型

说明

PasteData

剪贴板内容对象。

示例:

  1. let html = "<!DOCTYPE html>\n" + "<html>\n" + "<head>\n" + "<meta charset=\"utf-8\">\n" + "<title>HTML-PASTEBOARD_HTML</title>\n" + "</head>\n" + "<body>\n" + " <h1>HEAD</h1>\n" + " <p></p>\n" + "</body>\n" + "</html>";
  2. let pasteData = pasteboard.createHtmlData(html);

pasteboard.createWantData(deprecated)

createWantData(want: Want): PasteData

构建一个Want剪贴板内容对象。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用pasteboard.createData替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

want

Want

Want内容。

返回值:

类型

说明

PasteData

剪贴板内容对象。

示例:

  1. let object = {
  2. bundleName: "com.example.aafwk.test",
  3. abilityName: "com.example.aafwk.test.TwoAbility"
  4. };
  5. let pasteData = pasteboard.createWantData(object);

pasteboard.createPlainTextData(deprecated)

createPlainTextData(text: string): PasteData

构建一个纯文本剪贴板内容对象。

说明

从 API Version 6 开始支持,从 API Version 9 开始废弃,建议使用pasteboard.createData替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

text

string

纯文本内容。

返回值:

类型

说明

PasteData

剪贴板内容对象。

示例:

  1. let pasteData = pasteboard.createPlainTextData('content');

pasteboard.createUriData(deprecated)

createUriData(uri: string): PasteData

构建一个URI剪贴板内容对象。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用pasteboard.createData替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

uri

string

URI内容。

返回值:

类型

说明

PasteData

剪贴板内容对象。

示例:

  1. let pasteData = pasteboard.createUriData('dataability:///com.example.myapplication1/user.txt');

pasteboard.createHtmlTextRecord(deprecated)

createHtmlTextRecord(htmlText: string): PasteDataRecord

创建一条HTML内容的条目。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用pasteboard.createRecord替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

htmlText

string

HTML内容。

返回值:

类型

说明

PasteDataRecord

一条新建的HTML内容条目。

示例:

  1. let html = "<!DOCTYPE html>\n" + "<html>\n" + "<head>\n" + "<meta charset=\"utf-8\">\n" + "<title>HTML-PASTEBOARD_HTML</title>\n" + "</head>\n" + "<body>\n" + " <h1>HEAD</h1>\n" + " <p></p>\n" + "</body>\n" + "</html>";
  2. let record = pasteboard.createHtmlTextRecord(html);

pasteboard.createWantRecord(deprecated)

createWantRecord(want: Want): PasteDataRecord

创建一条Want内容条目。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用pasteboard.createRecord替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

want

Want

Want内容。

返回值:

类型

说明

PasteDataRecord

一条新建的Want内容条目。

示例:

  1. let object = {
  2. bundleName: "com.example.aafwk.test",
  3. abilityName: "com.example.aafwk.test.TwoAbility"
  4. };
  5. let record = pasteboard.createWantRecord(object);

pasteboard.createPlainTextRecord(deprecated)

createPlainTextRecord(text: string): PasteDataRecord

创建一条纯文本内容条目。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用pasteboard.createRecord替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

text

string

纯文本内容。

返回值:

类型

说明

PasteDataRecord

一条新建的纯文本内容条目。

示例:

  1. let record = pasteboard.createPlainTextRecord('hello');

pasteboard.createUriRecord(deprecated)

createUriRecord(uri: string): PasteDataRecord

创建一条URI内容的条目。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用pasteboard.createRecord替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

uri

string

URI内容。

返回值:

类型

说明

PasteDataRecord

一条新建的URI内容条目。

示例:

  1. let record = pasteboard.createUriRecord('dataability:///com.example.myapplication1/user.txt');

PasteDataProperty7+

定义了剪贴板中所有内容条目的属性,包含时间戳、数据类型、粘贴范围以及一些附加数据等。

系统能力: SystemCapability.MiscServices.Pasteboard

名称

类型

可读

可写

说明

additions7+

{[key:string]:object}

设置的其他附加属性数据,暂不支持。

mimeTypes7+

Array<string>

剪贴板内容条目的数据类型,非重复的类型列表。

tag7+

string

用户自定义标签,暂不支持。

timestamp7+

number

剪贴板数据的写入时间戳(单位:ms)。

localOnly7+

boolean

配置剪贴板内容是否为“仅在本地”,默认值为true。暂不支持,推荐使用shareOption属性。

- 配置为true时,表示内容仅在本地,不会在设备之间传递。

- 配置为false时,表示内容将在设备间传递。

shareOption9+

ShareOption

指示剪贴板数据可以粘贴到的范围,如果未设置或设置不正确,则默认值为CROSSDEVICE。

PasteDataRecord7+

对于剪贴板中内容记录的抽象定义,称之为条目。剪贴板内容部分由一个或者多个条目构成,例如一条文本内容、一份HTML、一个URI或者一个Want。

属性

系统能力: SystemCapability.MiscServices.Pasteboard

名称

类型

可读

可写

说明

htmlText7+

string

HTML内容。

want7+

Want

Want内容。

mimeType7+

string

数据类型。

plainText7+

string

纯文本内容。

uri7+

string

URI内容。

pixelMap9+

image.PixelMap

PixelMap内容。

data9+

{[mimeType: string]: ArrayBuffer}

自定义数据内容。

toPlainText9+

toPlainText(): string

将一个PasteData中的内容强制转换为文本内容。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

string

纯文本内容。

示例:

  1. let record = pasteboard.createRecord(pasteboard.MIMETYPE_TEXT_URI, 'dataability:///com.example.myapplication1/user.txt');
  2. let data = record.toPlainText();
  3. console.info(`Succeeded in converting to text. Data: ${data}`);

convertToText(deprecated)

convertToText(callback: AsyncCallback<string>): void

将一个PasteData中的内容强制转换为文本内容,使用callback异步回调。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用toPlainText替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

callback

AsyncCallback<string>

回调函数,当转换成功,err为undefined,data为强制转换的文本内容;否则返回错误信息。

示例:

  1. let record = pasteboard.createUriRecord('dataability:///com.example.myapplication1/user.txt');
  2. record.convertToText((err, data) => {
  3. if (err) {
  4. console.error(`Failed to convert to text. Cause: ${err.message}`);
  5. return;
  6. }
  7. console.info(`Succeeded in converting to text. Data: ${data}`);
  8. });

convertToText(deprecated)

convertToText(): Promise<string>

将一个PasteData中的内容强制转换为文本内容,使用Promise异步回调。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用toPlainText替代。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

Promise<string>

Promise对象,返回强制转换的文本内容。

示例:

  1. let record = pasteboard.createUriRecord('dataability:///com.example.myapplication1/user.txt');
  2. record.convertToText().then((data) => {
  3. console.info(`Succeeded in converting to text. Data: ${data}`);
  4. }).catch((err) => {
  5. console.error(`Failed to convert to text. Cause: ${err.message}`);
  6. });

PasteData

剪贴板内容对象。剪贴板内容包含一个或者多个内容条目(PasteDataRecord)以及属性描述对象(PasteDataProperty)。

在调用PasteData的接口前,需要先通过createData()getData()获取一个PasteData对象。

系统能力: SystemCapability.MiscServices.Pasteboard

getPrimaryText

getPrimaryText(): string

获取首个条目的纯文本内容。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

string

纯文本内容。

示例:

  1. let pasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN, 'hello');
  2. let plainText = pasteData.getPrimaryText();

getPrimaryHtml7+

getPrimaryHtml(): string

获取首个条目的HTML内容。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

string

HTML内容。

示例:

  1. let html = "<!DOCTYPE html>\n" + "<html>\n" + "<head>\n" + "<meta charset=\"utf-8\">\n" + "<title>HTML-PASTEBOARD_HTML</title>\n" + "</head>\n" + "<body>\n" + " <h1>HEAD</h1>\n" + " <p></p>\n" + "</body>\n" + "</html>";
  2. let pasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_HTML, html);
  3. let htmlText = pasteData.getPrimaryHtml();

getPrimaryWant7+

getPrimaryWant(): Want

获取首个条目的Want对象内容。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

Want

Want对象内容。

示例:

  1. let object = {
  2. bundleName: "com.example.aafwk.test",
  3. abilityName: "com.example.aafwk.test.TwoAbility"
  4. };
  5. let pasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_WANT, object);
  6. let want = pasteData.getPrimaryWant();

getPrimaryUri7+

getPrimaryUri(): string

获取首个条目的URI内容。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

string

URI内容。

示例:

  1. let pasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_URI, 'dataability:///com.example.myapplication1/user.txt');
  2. let uri = pasteData.getPrimaryUri();

getPrimaryPixelMap9+

getPrimaryPixelMap(): image.PixelMap

获取首个条目的PixelMap内容。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

image.PixelMap

PixelMap内容。

示例:

  1. import image from '@ohos.multimedia.image';
  2. let buffer = new ArrayBuffer(128);
  3. let opt = {
  4. size: { height: 3, width: 5 },
  5. pixelFormat: 3,
  6. editable: true,
  7. alphaType: 1,
  8. scaleMode: 1
  9. };
  10. image.createPixelMap(buffer, opt).then((pixelMap) => {
  11. let pasteData = pasteboard.createData(pasteboard.MIMETYPE_PIXELMAP, pixelMap);
  12. let PixelMap = pasteData.getPrimaryPixelMap();
  13. });

addRecord7+

addRecord(record: PasteDataRecord): void

向当前剪贴板内容中添加一条条目,同时也会将条目类型添加到PasteDataProperty的mimeTypes中。入参均不能为空,否则添加失败。

剪贴板内容中添加的条目达到数量上限512后,后续的添加操作无效。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

record

PasteDataRecord

待添加的条目。

示例:

  1. let pasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_URI, 'dataability:///com.example.myapplication1/user.txt');
  2. let textRecord = pasteboard.createRecord(pasteboard.MIMETYPE_TEXT_PLAIN, 'hello');
  3. let html = "<!DOCTYPE html>\n" + "<html>\n" + "<head>\n" + "<meta charset=\"utf-8\">\n" + "<title>HTML-PASTEBOARD_HTML</title>\n" + "</head>\n" + "<body>\n" + " <h1>HEAD</h1>\n" + " <p></p>\n" + "</body>\n" + "</html>";
  4. let htmlRecord = pasteboard.createRecord(pasteboard.MIMETYPE_TEXT_HTML, html);
  5. pasteData.addRecord(textRecord);
  6. pasteData.addRecord(htmlRecord);

addRecord9+

addRecord(mimeType: string, value: ValueType): void

向当前剪贴板内容中添加一条自定义数据内容条目,同时也会将自定义数据类型添加到PasteDataProperty的mimeTypes中。入参均不能为空,否则添加失败。

剪贴板内容中添加的条目达到数量上限512后,后续的添加操作无效。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

mimeType

string

自定义数据的MIME类型。

value

ValueType

自定义数据内容。

错误码:

以下错误码的详细介绍请参见剪贴板错误码

错误码ID

错误信息

12900002

The number of record exceeds the maximum limit.

示例:

  1. let pasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_URI, 'dataability:///com.example.myapplication1/user.txt');
  2. let dataXml = 'Hello World';
  3. pasteData.addRecord('app/xml', dataXml);

getMimeTypes7+

getMimeTypes(): Array<string>

获取剪贴板中PasteDataProperty的mimeTypes列表,当剪贴板内容为空时,返回列表为空。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

Array<string>

剪贴板内容条目的数据类型,非重复的类型列表。

示例:

  1. let pasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN, 'hello');
  2. let types = pasteData.getMimeTypes();

getPrimaryMimeType7+

getPrimaryMimeType(): string

获取剪贴板内容中首个条目的数据类型。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

string

首个条目的数据类型。

示例:

  1. let pasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN, 'hello');
  2. let type = pasteData.getPrimaryMimeType();

getProperty7+

getProperty(): PasteDataProperty

获取剪贴板内容的属性描述对象。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

PasteDataProperty

属性描述对象。

示例:

  1. let pasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN, 'hello');
  2. let property = pasteData.getProperty();

setProperty9+

setProperty(property: PasteDataProperty): void

设置剪贴板内容的属性描述对象,当前仅支持设置shareOption属性。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

property

PasteDataProperty

属性描述对象。

示例:

  1. let pasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_HTML, 'application/xml');
  2. let prop = pasteData.getProperty();
  3. prop.shareOption = pasteboard.ShareOption.INAPP;
  4. pasteData.setProperty(prop);

getRecord9+

getRecord(index: number): PasteDataRecord

获取剪贴板内容中指定下标的条目。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

index

number

指定条目的下标。

返回值:

类型

说明

PasteDataRecord

指定下标的条目。

错误码:

以下错误码的详细介绍请参见剪贴板错误码

错误码ID

错误信息

12900001

The index is out of the record.

示例:

  1. let pasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN, 'hello');
  2. let record = pasteData.getRecord(0);

getRecordCount7+

getRecordCount(): number

获取剪贴板内容中条目的个数。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

number

条目的个数。

示例:

  1. let pasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN, 'hello');
  2. let count = pasteData.getRecordCount();

getTag7+

getTag(): string

获取剪贴板内容中用户自定义的标签内容,如果没有设置用户自定义的标签内容将返回空。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

string

返回用户自定义的标签内容,如果没有设置用户自定义的标签内容,将返回空。

示例:

  1. let pasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN, 'hello');
  2. let tag = pasteData.getTag();

hasType9+

hasType(mimeType: string): boolean

检查剪贴板内容中是否有指定的MIME数据类型。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

mimeType

string

待查询的数据类型。

返回值:

类型

说明

boolean

有指定的数据类型返回true,否则返回false。

示例:

  1. let pasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN, 'hello');
  2. let hasType = pasteData.hasType(pasteboard.MIMETYPE_TEXT_PLAIN);

removeRecord9+

removeRecord(index: number): void

移除剪贴板内容中指定下标的条目。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

index

number

指定的下标。

错误码:

以下错误码的详细介绍请参见剪贴板错误码

错误码ID

错误信息

12900001

The index is out of the record.

示例:

  1. let pasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN, 'hello');
  2. pasteData.removeRecord(0);

replaceRecord9+

replaceRecord(index: number, record: PasteDataRecord): void

替换剪贴板内容中指定下标的条目。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

index

number

指定的下标。

record

PasteDataRecord

新条目的内容。

错误码:

以下错误码的详细介绍请参见剪贴板错误码

错误码ID

错误信息

12900001

The index is out of the record.

示例:

  1. let pasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN, 'hello');
  2. let record = pasteboard.createRecord(pasteboard.MIMETYPE_TEXT_URI, 'dataability:///com.example.myapplication1/user.txt');
  3. pasteData.replaceRecord(0, record);

addHtmlRecord(deprecated)

addHtmlRecord(htmlText: string): void

向当前剪贴板内容中添加一条HTML内容条目,并将MIMETYPE_TEXT_HTML添加到PasteDataProperty的mimeTypes中。入参均不能为空,否则添加失败。

剪贴板内容中添加的条目达到数量上限512后,后续的添加操作无效。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用addRecord替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

htmlText

string

HTML内容。

示例:

  1. let pasteData = pasteboard.createPlainTextData('hello');
  2. let html = "<!DOCTYPE html>\n" + "<html>\n" + "<head>\n" + "<meta charset=\"utf-8\">\n" + "<title>HTML-PASTEBOARD_HTML</title>\n" + "</head>\n" + "<body>\n" + " <h1>HEAD</h1>\n" + " <p></p>\n" + "</body>\n" + "</html>";
  3. pasteData.addHtmlRecord(html);

addWantRecord(deprecated)

addWantRecord(want: Want): void

向当前剪贴板内容中添加一条Want条目,并将MIMETYPE_TEXT_WANT添加到PasteDataProperty的mimeTypes中。入参均不能为空,否则添加失败。

剪贴板内容中添加的条目达到数量上限512后,后续的添加操作无效。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用addRecord替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

want

Want

Want对象内容。

示例:

  1. let pasteData = pasteboard.createPlainTextData('hello');
  2. let object = {
  3. bundleName: "com.example.aafwk.test",
  4. abilityName: "com.example.aafwk.test.TwoAbility"
  5. };
  6. pasteData.addWantRecord(object);

addTextRecord(deprecated)

addTextRecord(text: string): void

向当前剪贴板内容中添加一条纯文本条目,并将MIME_TEXT_PLAIN添加到PasteDataProperty的mimeTypes中。入参均不能为空,否则添加失败。

剪贴板内容中添加的条目达到数量上限512后,后续的添加操作无效。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用addRecord替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

text

string

纯文本内容。

示例:

  1. let pasteData = pasteboard.createPlainTextData('hello');
  2. pasteData.addTextRecord('good');

addUriRecord(deprecated)

addUriRecord(uri: string): void

向当前剪贴板内容中添加一条URI条目,并将MIMETYPE_TEXT_URI添加到PasteDataProperty的mimeTypes中。入参均不能为空,否则添加失败。

剪贴板内容中添加的条目达到数量上限512后,后续的添加操作无效。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用addRecord替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

uri

string

URI内容。

示例:

  1. let pasteData = pasteboard.createPlainTextData('hello');
  2. pasteData.addUriRecord('dataability:///com.example.myapplication1/user.txt');

getRecordAt(deprecated)

getRecordAt(index: number): PasteDataRecord

获取剪贴板内容中指定下标的条目。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用getRecord替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

index

number

指定条目的下标。

返回值:

类型

说明

PasteDataRecord

指定下标的条目。

示例:

  1. let pasteData = pasteboard.createPlainTextData('hello');
  2. let record = pasteData.getRecordAt(0);

hasMimeType(deprecated)

hasMimeType(mimeType: string): boolean

检查剪贴板内容中是否有指定的数据类型。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用hasType替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

mimeType

string

待查询的数据类型。

返回值:

类型

说明

boolean

有指定的数据类型返回true,否则返回false。

示例:

  1. let pasteData = pasteboard.createPlainTextData('hello');
  2. let hasType = pasteData.hasMimeType(pasteboard.MIMETYPE_TEXT_PLAIN);

removeRecordAt(deprecated)

removeRecordAt(index: number): boolean

移除剪贴板内容中指定下标的条目。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用removeRecord替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

index

number

指定的下标。

返回值:

类型

说明

boolean

成功移除返回true,失败返回false。

示例:

  1. let pasteData = pasteboard.createPlainTextData('hello');
  2. let isRemove = pasteData.removeRecordAt(0);

replaceRecordAt(deprecated)

replaceRecordAt(index: number, record: PasteDataRecord): boolean

替换剪贴板内容中指定下标的条目。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用replaceRecord替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

index

number

指定的下标。

record

PasteDataRecord

替换后的条目。

返回值:

类型

说明

boolean

成功替换返回true,失败返回false。

示例:

  1. let pasteData = pasteboard.createPlainTextData('hello');
  2. let record = pasteboard.createUriRecord('dataability:///com.example.myapplication1/user.txt');
  3. let isReplace = pasteData.replaceRecordAt(0, record);

SystemPasteboard

系统剪贴板对象。

在调用SystemPasteboard的接口前,需要先通过getSystemPasteboard获取系统剪贴板。

  1. let systemPasteboard = pasteboard.getSystemPasteboard();

on('update')7+

on(type: 'update', callback: () =>void ): void

订阅系统剪贴板内容变化事件,当系统剪贴板中内容变化时触发用户程序的回调。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

type

string

取值为'update',表示系统剪贴板内容变化事件。

callback

function

剪贴板中内容变化时触发的用户程序的回调。

示例:

  1. let systemPasteboard = pasteboard.getSystemPasteboard();
  2. let listener = () => {
  3. console.info('The system pasteboard has changed.');
  4. };
  5. systemPasteboard.on('update', listener);

off('update')7+

off(type: 'update', callback?: () =>void ): void

取消订阅系统剪贴板内容变化事件。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

type

string

取值为'update',表示系统剪贴板内容变化事件。

callback

function

剪贴板中内容变化时触发的用户程序的回调。如果此参数未填,表明清除本应用的所有监听回调,否则表示清除指定监听回调。

示例:

  1. let systemPasteboard = pasteboard.getSystemPasteboard();
  2. let listener = () => {
  3. console.info('The system pasteboard has changed.');
  4. };
  5. systemPasteboard.off('update', listener);

clearData9+

clearData(callback: AsyncCallback<void>): void

清空系统剪贴板内容,使用callback异步回调。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

callback

AsyncCallback<void>

回调函数。当成功清空时,err为undefined;否则为错误对象。

示例:

  1. let systemPasteboard = pasteboard.getSystemPasteboard();
  2. systemPasteboard.clearData((err, data) => {
  3. if (err) {
  4. console.error(`Failed to clear the pasteboard. Cause: ${err.message}`);
  5. return;
  6. }
  7. console.info('Succeeded in clearing the pasteboard.');
  8. });

clearData9+

clearData(): Promise<void>

清空系统剪贴板内容,使用Promise异步回调。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

Promise<void>

无返回结果的Promise对象。

示例:

  1. let systemPasteboard = pasteboard.getSystemPasteboard();
  2. systemPasteboard.clearData().then((data) => {
  3. console.info('Succeeded in clearing the pasteboard.');
  4. }).catch((err) => {
  5. console.error(`Failed to clear the pasteboard. Cause: ${err.message}`);
  6. });

setData9+

setData(data: PasteData, callback: AsyncCallback<void>): void

将数据写入系统剪贴板,使用callback异步回调。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

data

PasteData

PasteData对象。

callback

AsyncCallback<void>

回调函数。当写入成功,err为undefined,否则为错误对象。

错误码:

以下错误码的详细介绍请参见剪贴板错误码

错误码ID

错误信息

12900003

Another copy or paste is in progress.

12900004

Replication is prohibited.

示例:

  1. let pasteData = pasteboard.createPlainTextData('content');
  2. let systemPasteboard = pasteboard.getSystemPasteboard();
  3. systemPasteboard.setData(pasteData, (err, data) => {
  4. if (err) {
  5. console.error('Failed to set PasteData. Cause: ' + err.message);
  6. return;
  7. }
  8. console.info('Succeeded in setting PasteData.');
  9. });

setData9+

setData(data: PasteData): Promise<void>

将数据写入系统剪贴板,使用Promise异步回调。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

data

PasteData

PasteData对象。

返回值:

类型

说明

Promise<void>

无返回结果的Promise对象。

错误码:

以下错误码的详细介绍请参见剪贴板错误码

错误码ID

错误信息

12900003

Another copy or paste is in progress.

12900004

Replication is prohibited.

示例:

  1. let pasteData = pasteboard.createPlainTextData('content');
  2. let systemPasteboard = pasteboard.getSystemPasteboard();
  3. systemPasteboard.setData(pasteData).then((data) => {
  4. console.info('Succeeded in setting PasteData.');
  5. }).catch((err) => {
  6. console.error('Failed to set PasteData. Cause: ' + err.message);
  7. });

getData9+

getData( callback: AsyncCallback<PasteData>): void

读取系统剪贴板内容,使用callback异步回调。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

callback

AsyncCallback<PasteData>

回调函数。当读取成功,err为undefined,data为返回的系统剪贴板数据;否则返回错误对象。

错误码:

以下错误码的详细介绍请参见剪贴板错误码

错误码ID

错误信息

12900003

Another copy or paste is in progress.

示例:

  1. let systemPasteboard = pasteboard.getSystemPasteboard();
  2. systemPasteboard.getData((err, pasteData) => {
  3. if (err) {
  4. console.error('Failed to get PasteData. Cause: ' + err.message);
  5. return;
  6. }
  7. let text = pasteData.getPrimaryText();
  8. });

getData9+

getData(): Promise<PasteData>

读取系统剪贴板内容,使用Promise异步回调。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

Promise<PasteData>

Promise对象,返回系统剪贴板数据。

错误码:

以下错误码的详细介绍请参见剪贴板错误码

错误码ID

错误信息

12900003

Another copy or paste is in progress.

示例:

  1. let systemPasteboard = pasteboard.getSystemPasteboard();
  2. systemPasteboard.getData().then((pasteData) => {
  3. let text = pasteData.getPrimaryText();
  4. }).catch((err) => {
  5. console.error('Failed to get PasteData. Cause: ' + err.message);
  6. })

hasData9+

hasData(callback: AsyncCallback<boolean>): void

判断系统剪贴板中是否有内容,使用callback异步回调。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

callback

AsyncCallback<boolean>

返回true表示系统剪贴板中有内容,返回false表示系统剪贴板中没有内容。

示例:

  1. let systemPasteboard = pasteboard.getSystemPasteboard();
  2. systemPasteboard.hasData((err, data) => {
  3. if (err) {
  4. console.error(`Failed to check the PasteData. Cause: ${err.message}`);
  5. return;
  6. }
  7. console.info(`Succeeded in checking the PasteData. Data: ${data}`);
  8. });

hasData9+

hasData(): Promise<boolean>

判断系统剪贴板中是否有内容,使用Promise异步回调。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

Promise<boolean>

返回true表示系统剪贴板中有内容,返回false表示系统剪贴板中没有内容。

示例:

  1. let systemPasteboard = pasteboard.getSystemPasteboard();
  2. systemPasteboard.hasData().then((data) => {
  3. console.info(`Succeeded in checking the PasteData. Data: ${data}`);
  4. }).catch((err) => {
  5. console.error(`Failed to check the PasteData. Cause: ${err.message}`);
  6. });

clear(deprecated)

clear(callback: AsyncCallback<void>): void

清空系统剪贴板内容,使用callback异步回调。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用pasteboard.clearData替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

callback

AsyncCallback<void>

回调函数。当成功清空时,err为undefined;否则为错误对象。

示例:

  1. systemPasteboard.clear((err, data) => {
  2. if (err) {
  3. console.error(`Failed to clear the PasteData. Cause: ${err.message}`);
  4. return;
  5. }
  6. console.info('Succeeded in clearing the PasteData.');
  7. });

clear(deprecated)

clear(): Promise<void>

清空系统剪贴板内容,使用Promise异步回调。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用pasteboard.clearData替代。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

Promise<void>

无返回结果的Promise对象。

示例:

  1. systemPasteboard.clear().then((data) => {
  2. console.info('Succeeded in clearing the PasteData.');
  3. }).catch((err) => {
  4. console.error(`Failed to clear the PasteData. Cause: ${err.message}`);
  5. });

getPasteData(deprecated)

getPasteData( callback: AsyncCallback<PasteData>): void

读取系统剪贴板内容,使用callback异步回调。

说明

从 API Version 6 开始支持,从 API Version 9 开始废弃,建议使用getData替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

callback

AsyncCallback<PasteData>

回调函数。当读取成功,err为undefined,data为返回的系统剪贴板数据;否则返回错误对象。

示例:

  1. let systemPasteboard = pasteboard.getSystemPasteboard();
  2. systemPasteboard.getPasteData((err, pasteData) => {
  3. if (err) {
  4. console.error('Failed to get PasteData. Cause: ' + err.message);
  5. return;
  6. }
  7. let text = pasteData.getPrimaryText();
  8. });

getPasteData(deprecated)

getPasteData(): Promise<PasteData>

读取系统剪贴板内容,使用Promise异步回调。

说明

从 API Version 6 开始支持,从 API Version 9 开始废弃,建议使用getData替代。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

Promise<PasteData>

Promise对象,返回系统剪贴板数据。

示例:

  1. let systemPasteboard = pasteboard.getSystemPasteboard();
  2. systemPasteboard.getPasteData().then((pasteData) => {
  3. let text = pasteData.getPrimaryText();
  4. }).catch((err) => {
  5. console.error('Failed to get PasteData. Cause: ' + err.message);
  6. })

hasPasteData(deprecated)

hasPasteData(callback: AsyncCallback<boolean>): void

判断系统剪贴板中是否有内容,使用callback异步回调。

说明

从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用hasData替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

callback

AsyncCallback<boolean>

返回true表示系统剪贴板中有内容,返回false表示系统剪贴板中没有内容。

示例:

  1. systemPasteboard.hasPasteData((err, data) => {
  2. if (err) {
  3. console.error(`Failed to check the PasteData. Cause: ${err.message}`);
  4. return;
  5. }
  6. console.info(`Succeeded in checking the PasteData. Data: ${data}`);
  7. });

hasPasteData(deprecated)

hasPasteData(): Promise<boolean>

判断系统剪贴板中是否有内容,使用Promise异步回调。

说明

从 API Version 6 开始支持,从 API Version 9 开始废弃,建议使用hasData替代。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型

说明

Promise<boolean>

返回true表示系统剪贴板中有内容,返回false表示系统剪贴板中没有内容。

示例:

  1. systemPasteboard.hasPasteData().then((data) => {
  2. console.info(`Succeeded in checking the PasteData. Data: ${data}`);
  3. }).catch((err) => {
  4. console.error(`Failed to check the PasteData. Cause: ${err.message}`);
  5. });

setPasteData(deprecated)

setPasteData(data: PasteData, callback: AsyncCallback<void>): void

将数据写入系统剪贴板,使用callback异步回调。

说明

从 API Version 6 开始支持,从 API Version 9 开始废弃,建议使用setData替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

data

PasteData

PasteData对象。

callback

AsyncCallback<void>

回调函数。当写入成功,err为undefined,否则为错误对象。

示例:

  1. let pasteData = pasteboard.createPlainTextData('content');
  2. let systemPasteboard = pasteboard.getSystemPasteboard();
  3. systemPasteboard.setPasteData(pasteData, (err, data) => {
  4. if (err) {
  5. console.error('Failed to set PasteData. Cause: ' + err.message);
  6. return;
  7. }
  8. console.info('Succeeded in setting PasteData.');
  9. });

setPasteData(deprecated)

setPasteData(data: PasteData): Promise<void>

将数据写入系统剪贴板,使用Promise异步回调。

说明

从 API Version 5 开始支持,从 API Version 9 开始废弃,建议使用setData替代。

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名

类型

必填

说明

data

PasteData

PasteData对象。

返回值:

类型

说明

Promise<void>

无返回结果的Promise对象。

示例:

  1. let pasteData = pasteboard.createPlainTextData('content');
  2. let systemPasteboard = pasteboard.getSystemPasteboard();
  3. systemPasteboard.setPasteData(pasteData).then((data) => {
  4. console.info('Succeeded in setting PasteData.');
  5. }).catch((err) => {
  6. console.error('Failed to set PasteData. Cause: ' + err.message);
  7. });
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号