剪贴板


剪贴板

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

导入模块

import pasteboard from '@ohos.pasteboard';
1

属性

系统能力: 以下各项对应的系统能力均为SystemCapability.MiscServices.Pasteboard。

名称 参数类型 可读 可写 说明
MAX_RECORD_NUM7+ number 单个PasteData中所能包含的Record的数量上限。
MIMETYPE_TEXT_HTML7+ string HTML text文本的MIME类型定义。
MIMETYPE_TEXT_WANT7+ string Want的MIME类型定义。
MIMETYPE_TEXT_PLAIN7+ string Plain text文本的MIME类型定义。
MIMETYPE_TEXT_URI7+ string URI文本的MIME类型定义。

pasteboard.createPlainTextData

createPlainTextData(text:string): PasteData

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数

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

返回值

类型 说明
PasteData 包含此内容的剪贴板内容对象。

示例

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

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

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);
1
2
3
4
5

pasteboard.createUriData7+

createUriData(uri:string): PasteData

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数

参数名 类型 必填 说明
uri string 待保存的URI内容。

返回值

类型 说明
PasteData 包含此内容的剪贴板内容对象。

示例

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

pasteboard.createPlainTextRecord7+

createPlainTextRecord(text:string): PasteDataRecord

创建一条文本类型的内容条目。

系统能力: SystemCapability.MiscServices.Pasteboard

参数

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

返回值

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

示例

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

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

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);
1
2
3
4
5

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

PasteDataProperty7+

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

系统能力: 以下各项对应的系统能力均为SystemCapability.MiscServices.Pasteboard。

名称 参数类型 可读 可写 说明
additions {[key: string]: object} 设置的其他附加属性数据。
mimeTypes Array<string> 剪贴板内容条目的数据类型, 非重复的类型列表。
tag string 用户自定义标签。
timestamp number 剪贴板数据的写入时间戳(毫秒)。
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<void> 异步回调函数,调用成功则返回强制转换的文本内容,调用失败则返回error信息。

示例

var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1?user.txt");
record.convertToText().then((data) => {
    console.info('convertToText success data : ' + JSON.stringify(data));
}).catch((error) => { 
    console.error('convertToText failed because ' + JSON.stringify(error));
});
1
2
3
4
5
6

convertToText7+

convertToText(callback: AsyncCallback<string>): void

实例方法,将一个PasteData中的内容强制转换为文本内容,并使用callback方式返回结果。

系统能力: SystemCapability.MiscServices.Pasteboard

参数

参数名 类型 必填 说明
callback AsyncCallback<string> 回调函数,调用成功则返回强制转换的文本内容,调用失败则返回error信息。

示例

var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1?user.txt");
record.convertToText((err, data) => {    
    if (err) {        
        console.error('convertToText failed because ' + JSON.stringify(err));        
        return;   
      }
    console.info('convertToText success data : ' + JSON.stringify(data));
});
1
2
3
4
5
6
7
8

PasteData

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

系统能力: SystemCapability.MiscServices.Pasteboard

getPrimaryText

getPrimaryText(): string

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值

类型 说明
string 纯文本内容。

示例

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

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();
1
2
3

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();
1
2
3
4
5
6

getPrimaryUri7+

getPrimaryUri(): string

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值

类型 说明
string URI文本内容。

示例

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

addTextRecord7+

addTextRecord(text: string): void

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

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数

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

示例

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

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);
1
2
3

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);
1
2
3
4
5
6

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");
1
2

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);
1
2
3
4
5
6

getMimeTypes7+

getMimeTypes(): Array<string>

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值

类型 说明
Array<string> 非重复的类型列表。

示例

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

getPrimaryMimeType7+

getPrimaryMimeType(): string

获取首个条目的数据类型。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值

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

示例

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

getProperty7+

getProperty(): PasteDataProperty

获取属性描述对象。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值

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

示例

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

getRecordAt7+

getRecordAt(index: number): PasteDataRecord

获取指定下标的条目。

系统能力: SystemCapability.MiscServices.Pasteboard

参数

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

返回值

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

示例

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

getRecordCount7+

getRecordCount(): number

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值

类型 说明
number 条目的个数。

示例

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

getTag7+

getTag(): string

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

系统能力: SystemCapability.MiscServices.Pasteboard

返回值

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

示例

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

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

removeRecordAt7+

removeRecordAt(index: number): boolean

移除指定下标的条目。

系统能力: SystemCapability.MiscServices.Pasteboard

参数

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

返回值

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

示例

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

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);
1
2
3

pasteboard.getSystemPasteboard

getSystemPasteboard(): SystemPasteboard

获取系统剪切板。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值

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

示例

var systemPasteboard = pasteboard.getSystemPasteboard();
1

SystemPasteboard

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

var systemPasteboard = pasteboard.getSystemPasteboard();
1

setPasteData

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

将数据写入系统剪切板,并使用callback方式返回结果。

系统能力: SystemCapability.MiscServices.Pasteboard

参数

参数名 类型 必填 说明
data PasteData PasteData对象。
callback AsyncCallback<void> 回调函数,表示是否成功将数据写入系统剪切板。

示例

var pasteData = pasteboard.createPlainTextData("content");
var systemPasteboard = pasteboard.getSystemPasteboard();
systemPasteboard.setPasteData(pasteData, (error, data) => { 
    if (error) {
        console.error('Failed to setPasteData. Cause: ' + error.message);
        return;
    }
    console.info('setPasteData successfully.');
});
1
2
3
4
5
6
7
8
9

setPasteData

setPasteData(data:PasteData): Promise<void>

将数据写入系统剪切板,并使用Promise异步方式返回结果。

系统能力: SystemCapability.MiscServices.Pasteboard

参数

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

返回值

类型 说明
Promise<void> 异步回调函数,表示是否成功将数据写入系统剪切板。

示例

var pasteData = pasteboard.createPlainTextData("content");
var systemPasteboard = pasteboard.getSystemPasteboard();
systemPasteboard.setPasteData(pasteData).then((data) => {
    console.info('setPasteData success.');
}).catch((error) => {
    console.error('Failed to setPasteData. Cause: ' + error.message);
});
1
2
3
4
5
6
7

getPasteData

getPasteData( callback:AsyncCallback<PasteData>): void

读取系统剪切板内容,并使用callback方式返回结果。

系统能力: SystemCapability.MiscServices.Pasteboard

参数

参数名 类型 必填 说明
callback AsyncCallback<PasteData> 回调函数,返回系统剪切板数据。

示例

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

getPasteData

getPasteData(): Promise<PasteData>

读取系统剪切板内容,并使用Promise异步方式返回结果。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值

类型 说明
Promise<PasteData> 异步回调函数,调返回系统剪切板数据。

示例

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

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);
1
2
3
4
5

off('update')7+

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

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

系统能力: SystemCapability.MiscServices.Pasteboard

参数

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

示例

systemPasteboard.off('update', listener);
1

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 hasPasteData because ' + JSON.stringify(err));
        return;
    }
    console.info('success hasPasteData : ' + JSON.stringify(data));
});
1
2
3
4
5
6
7

hasPasteData7+

hasPasteData(): Promise<boolean>

判断系统剪切板中是否有内容,并使用Promise异步方式返回结果。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值

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

示例

systemPasteboard.hasPasteData().then((data) => { 
    console.info('success hasPasteData : ' + JSON.stringify(data));
}).catch((error) => {
    console.error('failed to hasPasteData because ' + JSON.stringify(error));
});
1
2
3
4
5

clear7+

clear(callback: AsyncCallback<void>): void

清空系统剪切板内容,并使用callback异步方式返回结果。

系统能力: SystemCapability.MiscServices.Pasteboard

参数

参数名 类型 必填 说明
callback AsyncCallback<void> 回调函数,表示是否成功清空系统剪切板内容。

示例

systemPasteboard.clear((err, data) => { 
    if (err) {        
        console.error('failed to clear because ' + JSON.stringify(err));        
        return;    
    }
    console.info('success clear');
});
1
2
3
4
5
6
7

clear7+

clear(): Promise<void>

清空系统剪切板内容,并使用Promise异步方式返回结果。

系统能力: SystemCapability.MiscServices.Pasteboard

返回值

类型 说明
Promise<void> 异步回调函数,表示是否成功清空系统剪切板内容。

示例

systemPasteboard.clear().then((data) => { 
    console.info('success clear');
}).catch((error) => {    
    console.error('failed to clear because ' + JSON.stringify(error));
});
1
2
3
4
5