剪贴板

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

说明：

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

导入模块

import pasteboard from '@ohos.pasteboard';

属性

系统能力： SystemCapability.MiscServices.Pasteboard

名称 参数类型 可读 可写 说明
MAX_RECORD_NUM7+ number 是 否 单个PasteData中所能包含的最大条目数。
MIMETYPE_TEXT_HTML7+ string 是 否 HTML内容的MIME类型定义。
MIMETYPE_TEXT_WANT7+ string 是 否 Want内容的MIME类型定义。
MIMETYPE_TEXT_PLAIN7+ string 是 否 纯文本内容的MIME类型定义。
MIMETYPE_TEXT_URI7+ string 是 否 URI内容的MIME类型定义。

pasteboard.createPlainTextData

createPlainTextData(text:string): PasteData

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

返回值：

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

示例：

var pasteData = pasteboard.createPlainTextData("content");

pasteboard.createHtmlData7+

createHtmlData(htmlText:string): PasteData

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

返回值：

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

示例：

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

pasteboard.createWantData7+

createWantData(want:Want): PasteData

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

返回值：

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

示例：

var object = {
    bundleName: "com.example.aafwk.test",
    abilityName: "com.example.aafwk.test.TwoAbility"
};
var pasteData = pasteboard.createWantData(object);

pasteboard.createUriData7+

createUriData(uri:string): PasteData

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

返回值：

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

示例：

var pasteData = pasteboard.createUriData("dataability:///com.example.myapplication1/user.txt");

pasteboard.createPlainTextRecord7+

createPlainTextRecord(text:string): PasteDataRecord

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

返回值：

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

示例：

var record = pasteboard.createPlainTextRecord("hello");

pasteboard.createHtmlTextRecord7+

createHtmlTextRecord(htmlText:string): PasteDataRecord

创建一条HTML内容的条目。

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

返回值：

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

示例：

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

pasteboard.createWantRecord7+

createWantRecord(want:Want): PasteDataRecord

创建一条Want内容条目。

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

返回值：

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

示例：

var object = {
    bundleName: "com.example.aafwk.test",
    abilityName: "com.example.aafwk.test.TwoAbility"
};
var record = pasteboard.createWantRecord(object);

pasteboard.createUriRecord7+

createUriRecord(uri:string): PasteDataRecord

创建一条URI内容的条目。

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

返回值：

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

示例：

var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");

pasteboard.getSystemPasteboard

getSystemPasteboard(): SystemPasteboard

获取系统剪贴板对象。

系统能力： SystemCapability.MiscServices.Pasteboard

返回值：

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

示例：

var systemPasteboard = pasteboard.getSystemPasteboard();

PasteDataProperty7+

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

系统能力： SystemCapability.MiscServices.Pasteboard

名称 参数类型 可读 可写 说明
additions {[key:string]:object} 是 是 设置的其他附加属性数据。
mimeTypes Array<string> 是 否 剪贴板内容条目的数据类型，非重复的类型列表。
tag string 是 是 用户自定义标签。
timestamp number 是 否 剪贴板数据的写入时间戳（单位：ms）。
localOnly boolean 是 是 配置剪贴板内容是否为“仅在本地”。默认值为true。
- 配置为true时，表示内容仅在本地，不会在设备之间传递。
- 配置为false时，表示内容将在设备间传递。

PasteDataRecord7+

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

属性

系统能力： SystemCapability.MiscServices.Pasteboard

名称 参数类型 可读 可写 说明
htmlText7+ string 是 否 HTML内容。
want7+ Want 是 否 Want内容。
mimeType7+ string 是 否 数据类型。
plainText7+ string 是 否 纯文本内容。
uri7+ string 是 否 URI内容。

convertToText7+

convertToText(): Promise<string>

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

系统能力： SystemCapability.MiscServices.Pasteboard

返回值：

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

示例：

var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
record.convertToText().then((data) => {
    console.info('Succeeded in converting to text. Data: ' + JSON.stringify(data));
}).catch((err) => {
    console.error('Failed to convert to text. Cause: ' + JSON.stringify(err));
});

convertToText7+

convertToText(callback: AsyncCallback<string>): void

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

示例：

var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
record.convertToText((err, data) => {    
    if (err) {        
        console.error('Failed to convert to text. Cause: ' + JSON.stringify(err));        
        return;   
      }
    console.info('Succeeded in converting to text. Data: ' + JSON.stringify(data));
});

PasteData

剪贴板内容对象。

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

系统能力： SystemCapability.MiscServices.Pasteboard

getPrimaryText

getPrimaryText(): string

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

系统能力： SystemCapability.MiscServices.Pasteboard

返回值：

类型 说明
string 纯文本内容。

示例：

var pasteData = pasteboard.createPlainTextData("hello");
var plainText = pasteData.getPrimaryText();

getPrimaryHtml7+

getPrimaryHtml(): string

获取首个条目的HTML内容。

系统能力： SystemCapability.MiscServices.Pasteboard

返回值：

类型 说明
string HTML内容。

示例：

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

getPrimaryWant7+

getPrimaryWant(): Want

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

系统能力： SystemCapability.MiscServices.Pasteboard

返回值：

类型 说明
Want Want对象内容。

示例：

var object = { 
    bundleName: "com.example.aafwk.test",    
    abilityName: "com.example.aafwk.test.TwoAbility"
};
var pasteData = pasteboard.createWantData(object);
var want = pasteData.getPrimaryWant();

getPrimaryUri7+

getPrimaryUri(): string

获取首个条目的URI内容。

系统能力： SystemCapability.MiscServices.Pasteboard

返回值：

类型 说明
string URI内容。

示例：

var pasteData = pasteboard.createUriData("dataability:///com.example.myapplication1/user.txt");
var uri = pasteData.getPrimaryUri();

addTextRecord7+

addTextRecord(text: string): void

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

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

示例：

var pasteData = pasteboard.createPlainTextData("hello");
pasteData.addTextRecord("good");

addHtmlRecord7+

addHtmlRecord(htmlText: string): void

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

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

示例：

var pasteData = pasteboard.createPlainTextData("hello");
var 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);

addWantRecord7+

addWantRecord(want: Want): void

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

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

示例：

var pasteData = pasteboard.createPlainTextData("hello");
var object = { 
    bundleName: "com.example.aafwk.test",    
    abilityName: "com.example.aafwk.test.TwoAbility"
};
pasteData.addWantRecord(object);

addUriRecord7+

addUriRecord(uri: string): void

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

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

示例：

var pasteData = pasteboard.createPlainTextData("hello");
pasteData.addUriRecord("dataability:///com.example.myapplication1/user.txt");

addRecord7+

addRecord(record: PasteDataRecord): void

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

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

示例：

var pasteData = pasteboard.createUriData("dataability:///com.example.myapplication1/user.txt");
var textRecord = pasteboard.createPlainTextRecord("hello");
var 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>";
var htmlRecord = pasteboard.createHtmlTextRecord(html);
pasteData.addRecord(textRecord);
pasteData.addRecord(htmlRecord);

getMimeTypes7+

getMimeTypes(): Array<string>

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

系统能力： SystemCapability.MiscServices.Pasteboard

返回值：

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

示例：

var pasteData = pasteboard.createPlainTextData("hello");
var types = pasteData.getMimeTypes();

getPrimaryMimeType7+

getPrimaryMimeType(): string

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

系统能力： SystemCapability.MiscServices.Pasteboard

返回值：

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

示例：

var pasteData = pasteboard.createPlainTextData("hello");
var type = pasteData.getPrimaryMimeType();

getProperty7+

getProperty(): PasteDataProperty

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

系统能力： SystemCapability.MiscServices.Pasteboard

返回值：

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

示例：

var pasteData = pasteboard.createPlainTextData("hello");
var property = pasteData.getProperty();

getRecordAt7+

getRecordAt(index: number): PasteDataRecord

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

返回值：

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

示例：

var pasteData = pasteboard.createPlainTextData("hello");
var record = pasteData.getRecordAt(0);

getRecordCount7+

getRecordCount(): number

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

系统能力： SystemCapability.MiscServices.Pasteboard

返回值：

类型 说明
number 条目的个数。

示例：

var pasteData = pasteboard.createPlainTextData("hello");
var count = pasteData.getRecordCount();

getTag7+

getTag(): string

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

系统能力： SystemCapability.MiscServices.Pasteboard

返回值：

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

示例：

var pasteData = pasteboard.createPlainTextData("hello");
var tag = pasteData.getTag();

hasMimeType7+

hasMimeType(mimeType: string): boolean

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

返回值：

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

示例：

var pasteData = pasteboard.createPlainTextData("hello");
var hasType = pasteData.hasMimeType(pasteboard.MIMETYPE_TEXT_PLAIN);

removeRecordAt7+

removeRecordAt(index: number): boolean

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

返回值：

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

示例：

var pasteData = pasteboard.createPlainTextData("hello");
var isRemove = pasteData.removeRecordAt(0);

replaceRecordAt7+

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

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

参数名 类型 必填 说明
index number 是 指定的下标。
record PasteDataRecord 是 替换后的条目。

返回值：

类型 说明
boolean 成功替换返回true，失败返回false。

示例：

var pasteData = pasteboard.createPlainTextData("hello");
var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
var isReplace = pasteData.replaceRecordAt(0, record);

SystemPasteboard

系统剪贴板对象。

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

var systemPasteboard = pasteboard.getSystemPasteboard();

setPasteData

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

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

示例：

var pasteData = pasteboard.createPlainTextData("content");
var 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.');
});

setPasteData

setPasteData(data:PasteData): Promise<void>

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

返回值：

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

示例：

var pasteData = pasteboard.createPlainTextData("content");
var 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);
});

getPasteData

getPasteData( callback:AsyncCallback<PasteData>): void

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

参数名 类型 必填 说明
callback AsyncCallback<PasteData> 是 回调函数。当读取成功，err为undefined，data为返回的系统剪贴板数据；否则返回错误对象。

示例：

var systemPasteboard = pasteboard.getSystemPasteboard();
systemPasteboard.getPasteData((err, pasteData) => {  
    if (err) {
        console.error('Failed to get PasteData. Cause: ' + err.message);
        return;
    }
    var text = pasteData.getPrimaryText();
});

getPasteData

getPasteData(): Promise<PasteData>

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

系统能力： SystemCapability.MiscServices.Pasteboard

返回值：

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

示例：

var systemPasteboard = pasteboard.getSystemPasteboard();
systemPasteboard.getPasteData().then((pasteData) => { 
    var text = pasteData.getPrimaryText();
}).catch((err) => {
    console.error('Failed to get PasteData. Cause: ' + err.message);
})

on('update')7+

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

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

示例：

var systemPasteboard = pasteboard.getSystemPasteboard();
var listener = () => {
    console.info('The system pasteboard has changed.');
};
systemPasteboard.on('update', listener);

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);

hasPasteData7+

hasPasteData(callback: AsyncCallback<boolean>): void

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

示例：

systemPasteboard.hasPasteData((err, data) => {
    if (err) {
        console.error('Failed to check the PasteData. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Succeeded in checking the PasteData. Data: ' + JSON.stringify(data));
});

hasPasteData7+

hasPasteData(): Promise<boolean>

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

系统能力： SystemCapability.MiscServices.Pasteboard

返回值：

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

示例：

systemPasteboard.hasPasteData().then((data) => { 
    console.info('Succeeded in checking the PasteData. Data: ' + JSON.stringify(data));
}).catch((err) => {
    console.error('Failed to check the PasteData. Cause: ' + JSON.stringify(err));
});

clear7+

clear(callback: AsyncCallback<void>): void

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

系统能力： SystemCapability.MiscServices.Pasteboard

参数：

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

示例：

systemPasteboard.clear((err, data) => { 
    if (err) {        
        console.error('Failed to clear the PasteData. Cause: ' + JSON.stringify(err));        
        return;    
    }
    console.info('Succeeded in clearing the PasteData.');
});

clear7+

clear(): Promise<void>

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

系统能力： 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: ' + JSON.stringify(err));
});