剪贴板


剪贴板

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

说明:

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

导入模块

import pasteboard from '@ohos.pasteboard';
1

常量

系统能力: 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 剪贴板内容对象。

示例:

let dataXml = new ArrayBuffer(256);
let pasteData = pasteboard.createData('app/xml', dataXml);
1
2

pasteboard.createRecord9+

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

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
mimeType string 自定义数据的MIME类型。
value ValueType 自定义数据内容。

返回值:

类型 说明
PasteDataRecord 一条新建的自定义数据内容条目。

示例:

let dataXml = new ArrayBuffer(256);
let pasteDataRecord = pasteboard.createRecord('app/xml', dataXml);
1
2

pasteboard.getSystemPasteboard

getSystemPasteboard(): SystemPasteboard

获取系统剪贴板对象。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型 说明
SystemPasteboard 系统剪贴板对象。

示例:

let systemPasteboard = pasteboard.getSystemPasteboard();
1

ShareOption9+

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

系统能力: SystemCapability.MiscServices.Pasteboard

名称 说明
InApp 表示仅允许同应用内粘贴。
LocalDevice 表示允许在此设备中任何应用内粘贴。
CrossDevice 表示允许跨设备在任何应用内粘贴。

pasteboard.createHtmlData(deprecated)

createHtmlData(htmlText: string): PasteData

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

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
htmlText string HTML内容。

返回值:

类型 说明
PasteData 剪贴板内容对象。

示例:

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>";
let pasteData = pasteboard.createHtmlData(html);
1
2

pasteboard.createWantData(deprecated)

createWantData(want: Want): PasteData

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

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
want Want Want内容。

返回值:

类型 说明
PasteData 剪贴板内容对象。

示例:

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

pasteboard.createPlainTextData(deprecated)

createPlainTextData(text: string): PasteData

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

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
text string 纯文本内容。

返回值:

类型 说明
PasteData 剪贴板内容对象。

示例:

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

pasteboard.createUriData(deprecated)

createUriData(uri: string): PasteData

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

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
uri string URI内容。

返回值:

类型 说明
PasteData 剪贴板内容对象。

示例:

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

pasteboard.createHtmlTextRecord(deprecated)

createHtmlTextRecord(htmlText: string): PasteDataRecord

创建一条HTML内容的条目。

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
htmlText string HTML内容。

返回值:

类型 说明
PasteDataRecord 一条新建的HTML内容条目。

示例:

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>";
let record = pasteboard.createHtmlTextRecord(html);
1
2

pasteboard.createWantRecord(deprecated)

createWantRecord(want: Want): PasteDataRecord

创建一条Want内容条目。

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
want Want Want内容。

返回值:

类型 说明
PasteDataRecord 一条新建的Want内容条目。

示例:

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

pasteboard.createPlainTextRecord(deprecated)

createPlainTextRecord(text: string): PasteDataRecord

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

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
text string 纯文本内容。

返回值:

类型 说明
PasteDataRecord 一条新建的纯文本内容条目。

示例:

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

pasteboard.createUriRecord(deprecated)

createUriRecord(uri: string): PasteDataRecord

创建一条URI内容的条目。

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
uri string URI内容。

返回值:

类型 说明
PasteDataRecord 一条新建的URI内容条目。

示例:

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

PasteDataProperty7+

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

系统能力: SystemCapability.MiscServices.Pasteboard

名称 参数类型 可读 可写 说明
additions7+ {[key:string]:object} 设置的其他附加属性数据。
mimeTypes7+ Array<string> 剪贴板内容条目的数据类型,非重复的类型列表。
tag7+ string 用户自定义标签。
timestamp7+ number 剪贴板数据的写入时间戳(单位:ms)。
localOnly7+ boolean 配置剪贴板内容是否为“仅在本地”。默认值为true。
- 配置为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} 自定义数据内容。

convertToTextV99+

convertToTextV9(callback: AsyncCallback<string>): void

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
callback AsyncCallback<string> 回调函数,当转换成功,err为undefined,data为强制转换的文本内容;否则返回错误信息。

示例:

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

convertToTextV99+

convertToTextV9(): Promise<string>

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型 说明
Promise<string> Promise对象,返回强制转换的文本内容。

示例:

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

convertToText(deprecated)

convertToText(callback: AsyncCallback<string>): void

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

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
callback AsyncCallback<string> 回调函数,当转换成功,err为undefined,data为强制转换的文本内容;否则返回错误信息。

示例:

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

convertToText(deprecated)

convertToText(): Promise<string>

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

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型 说明
Promise<string> Promise对象,返回强制转换的文本内容。

示例:

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

PasteData

剪贴板内容对象。

在调用PasteData的接口前,需要先获取一个PasteData对象。

系统能力: SystemCapability.MiscServices.Pasteboard

getPrimaryText

getPrimaryText(): string

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型 说明
string 纯文本内容。

示例:

let pasteData = pasteboard.createPlainTextData('hello');
let plainText = pasteData.getPrimaryText();
1
2

getPrimaryHtml7+

getPrimaryHtml(): string

获取首个条目的HTML内容。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型 说明
string HTML内容。

示例:

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>";
let pasteData = pasteboard.createHtmlData(html);
let htmlText = pasteData.getPrimaryHtml();
1
2
3

getPrimaryWant7+

getPrimaryWant(): Want

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型 说明
Want Want对象内容。

示例:

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

getPrimaryUri7+

getPrimaryUri(): string

获取首个条目的URI内容。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型 说明
string URI内容。

示例:

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

getPrimaryPixelMap9+

getPrimaryPixelMap(): image.PixelMap

获取首个条目的PixelMap内容。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型 说明
image.PixelMap PixelMap内容。

示例:

import image from '@ohos.multimedia.image';

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

addRecord7+

addRecord(record: PasteDataRecord): void

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

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
record PasteDataRecord 待添加的条目。

示例:

let pasteData = pasteboard.createUriData('dataability:///com.example.myapplication1/user.txt');
let textRecord = pasteboard.createPlainTextRecord('hello');
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>";
let htmlRecord = pasteboard.createHtmlTextRecord(html);
pasteData.addRecord(textRecord);
pasteData.addRecord(htmlRecord);
1
2
3
4
5
6

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.

示例:

let pasteData = pasteboard.createUriData('dataability:///com.example.myapplication1/user.txt');
let dataXml = new ArrayBuffer(256);
pasteData.addRecord('app/xml', dataXml);
1
2
3

getMimeTypes7+

getMimeTypes(): Array<string>

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型 说明
Array<string> 剪贴板内容条目的数据类型,非重复的类型列表。

示例:

let pasteData = pasteboard.createPlainTextData('hello');
let types = pasteData.getMimeTypes();
1
2

getPrimaryMimeType7+

getPrimaryMimeType(): string

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型 说明
string 首个条目的数据类型。

示例:

let pasteData = pasteboard.createPlainTextData('hello');
let type = pasteData.getPrimaryMimeType();
1
2

getProperty7+

getProperty(): PasteDataProperty

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型 说明
PasteDataProperty 属性描述对象。

示例:

let pasteData = pasteboard.createPlainTextData('hello');
let property = pasteData.getProperty();
1
2

setProperty9+

setProperty(property: PasteDataProperty): void

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
property PasteDataProperty 属性描述对象。

示例:

let pasteData = pasteboard.createHtmlData('application/xml');
let prop = pasteData.getProperty();
prop.shareOption = pasteboard.ShareOption.InApp;
pasteData.setProperty(prop);
1
2
3
4

getRecord9+

getRecord(index: number): PasteDataRecord

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
index number 指定条目的下标。

返回值:

类型 说明
PasteDataRecord 指定下标的条目。

错误码:

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

错误码ID 错误信息
12900001 The index is out of range.

示例:

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

getRecordCount7+

getRecordCount(): number

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型 说明
number 条目的个数。

示例:

let pasteData = pasteboard.createPlainTextData('hello');
let count = pasteData.getRecordCount();
1
2

getTag7+

getTag(): string

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

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

示例:

let pasteData = pasteboard.createPlainTextData('hello');
let tag = pasteData.getTag();
1
2

hasType9+

hasType(mimeType: string): boolean

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
mimeType string 待查询的数据类型。

返回值:

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

示例:

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

removeRecord9+

removeRecord(index: number): void

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
index number 指定的下标。

错误码:

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

错误码ID 错误信息
12900001 The index is out of range.

示例:

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

replaceRecord9+

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

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
index number 指定的下标。
record PasteDataRecord 新条目的内容。

错误码:

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

错误码ID 错误信息
12900001 The index is out of range.

示例:

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

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内容。

示例:

let pasteData = pasteboard.createPlainTextData('hello');
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>";
pasteData.addHtmlRecord(html);
1
2
3

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对象内容。

示例:

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

addTextRecord(deprecated)

addTextRecord(text: string): void

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

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

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
text string 纯文本内容。

示例:

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

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内容。

示例:

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

getRecordAt(deprecated)

getRecordAt(index: number): PasteDataRecord

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

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
index number 指定条目的下标。

返回值:

类型 说明
PasteDataRecord 指定下标的条目。

示例:

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

hasMimeType(deprecated)

hasMimeType(mimeType: string): boolean

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

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
mimeType string 待查询的数据类型。

返回值:

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

示例:

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

removeRecordAt(deprecated)

removeRecordAt(index: number): boolean

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

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
index number 指定的下标。

返回值:

类型 说明
boolean 成功移除返回true,失败返回false。

示例:

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

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。

示例:

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

SystemPasteboard

系统剪贴板对象。

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

let systemPasteboard = pasteboard.getSystemPasteboard();
1

on('update')7+

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

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
type string 取值为'update',表示系统剪贴板内容变化事件。
callback function 剪贴板中内容变化时触发的用户程序的回调。

示例:

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

off('update')7+

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

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
type string 取值为'update',表示系统剪贴板内容变化事件。
callback function 剪贴板中内容变化时触发的用户程序的回调。

示例:

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

clearData9+

clearData(callback: AsyncCallback<void>): void

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
callback AsyncCallback<void> 回调函数。当成功清空时,err为undefined;否则为错误对象。

示例:

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

clearData9+

clearData(): Promise<void>

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

示例:

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

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.

示例:

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

示例:

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

示例:

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

getData9+

getData(): Promise<PasteData>

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型 说明
Promise<PasteData> Promise对象,返回系统剪贴板数据。

错误码:

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

错误码ID 错误信息
12900003 Another copy or paste is in progress.

示例:

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

hasData9+

hasData(callback: AsyncCallback<boolean>): void

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
callback AsyncCallback<boolean> 返回true表示系统剪贴板中有内容,返回false表示系统剪贴板中没有内容。

示例:

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

hasData9+

hasData(): Promise<boolean>

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型 说明
Promise<boolean> 返回true表示系统剪贴板中有内容,返回false表示系统剪贴板中没有内容。

示例:

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

clear(deprecated)

clear(callback: AsyncCallback<void>): void

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

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
callback AsyncCallback<void> 回调函数。当成功清空时,err为undefined;否则为错误对象。

示例:

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

clear(deprecated)

clear(): Promise<void>

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

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

示例:

systemPasteboard.clear().then((data) => { 
    console.info('Succeeded in clearing the PasteData.');
}).catch((err) => {    
    console.error(`Failed to clear the PasteData. Cause: ${err.message}`);
});
1
2
3
4
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为返回的系统剪贴板数据;否则返回错误对象。

示例:

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

getPasteData(deprecated)

getPasteData(): Promise<PasteData>

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

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型 说明
Promise<PasteData> Promise对象,返回系统剪贴板数据。

示例:

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

hasPasteData(deprecated)

hasPasteData(callback: AsyncCallback<boolean>): void

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

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
callback AsyncCallback<boolean> 返回true表示系统剪贴板中有内容,返回false表示系统剪贴板中没有内容。

示例:

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

hasPasteData(deprecated)

hasPasteData(): Promise<boolean>

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

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值:

类型 说明
Promise<boolean> 返回true表示系统剪贴板中有内容,返回false表示系统剪贴板中没有内容。

示例:

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

setPasteData(deprecated)

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

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

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 必填 说明
data PasteData PasteData对象。
callback AsyncCallback<void> 回调函数。当写入成功,err为undefined,否则为错误对象。

示例:

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

setPasteData(deprecated)

setPasteData(data: PasteData): Promise<void>

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

说明:

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数:

参数名 类型 说明
data PasteData PasteData对象。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

示例:

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