剪貼板

說明： 本模塊首批接口從API version 6開始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。 開發(fā)前請(qǐng)熟悉鴻蒙開發(fā)指導(dǎo)文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

導(dǎo)入模塊

import pasteboard from '@ohos.pasteboard';

屬性

系統(tǒng)能力 : 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.MiscServices.Pasteboard。

pasteboard.createPlainTextData

createPlainTextData(text:string): PasteData

構(gòu)建一個(gè)純文本剪貼板內(nèi)容對(duì)象。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

返回值

示例

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

pasteboard.createHtmlData7+

createHtmlData(htmlText:string): PasteData

構(gòu)建一個(gè)html文本剪貼板內(nèi)容對(duì)象。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

返回值

示例

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

構(gòu)建一個(gè)want剪貼板內(nèi)容對(duì)象。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

返回值

示例

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

pasteboard.createUriData7+

createUriData(uri:string): PasteData

構(gòu)建一個(gè)URI剪貼板內(nèi)容對(duì)象。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

返回值

示例

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

pasteboard.createPlainTextRecord7+

createPlainTextRecord(text:string): PasteDataRecord

創(chuàng)建一條文本類型的內(nèi)容條目。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

返回值

示例

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

pasteboard.createHtmlTextRecord7+

createHtmlTextRecord(htmlText:string): PasteDataRecord

創(chuàng)建一條HTML內(nèi)容的條目。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

返回值

示例

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

創(chuàng)建一條Want內(nèi)容條目。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

返回值

示例

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

pasteboard.createUriRecord7+

createUriRecord(uri:string): PasteDataRecord

創(chuàng)建一條URI內(nèi)容的條目。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

返回值

示例

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

PasteDataProperty7+

定義了剪貼板中所有內(nèi)容條目的屬性，包含時(shí)間戳、數(shù)據(jù)類型以及一些附加數(shù)據(jù)等。

系統(tǒng)能力 : 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.MiscServices.Pasteboard。

PasteDataRecord7+

對(duì)于剪貼板中內(nèi)容記錄的抽象定義，稱之為條目。剪貼板內(nèi)容部分由一個(gè)或者多個(gè)條目構(gòu)成，例如一條文本內(nèi)容、一份HTML、一個(gè)URI或者一個(gè)Want。

屬性

系統(tǒng)能力 : 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.MiscServices.Pasteboard。

convertToText7+

convertToText(): Promise

實(shí)例方法，將一個(gè)PasteData中的內(nèi)容強(qiáng)制轉(zhuǎn)換為文本內(nèi)容，并使用Promise異步方式返回結(jié)果。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

返回值

示例

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

convertToText7+

convertToText(callback: AsyncCallback): void

實(shí)例方法，將一個(gè)PasteData中的內(nèi)容強(qiáng)制轉(zhuǎn)換為文本內(nèi)容，并使用callback方式返回結(jié)果。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

示例

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

PasteData

在調(diào)用PasteData的接口前，需要先獲取一個(gè)PasteData對(duì)象。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

getPrimaryText

getPrimaryText(): string

獲取首個(gè)條目的純文本內(nèi)容。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

返回值

示例

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

getPrimaryHtml7+

getPrimaryHtml(): string

獲取首個(gè)條目的HTML文本內(nèi)容。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

返回值

示例

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

獲取首個(gè)條目的Want對(duì)象內(nèi)容。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

返回值

示例

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

獲取首個(gè)條目的URI文本內(nèi)容。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

返回值

示例

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

addTextRecord7+

addTextRecord(text: string): void

向當(dāng)前剪貼板內(nèi)容中添加一條純文本條目，并將MIME_TEXT_PLAIN添加到[PasteDataProperty]的mimeTypes中。入?yún)⒕荒転榭眨駝t添加失敗。

剪貼板內(nèi)容中添加的條目達(dá)到數(shù)量上限128后，后續(xù)的添加操作無效。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

示例

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

addHtmlRecord7+

addHtmlRecord(htmlText: string): void

向當(dāng)前剪貼板內(nèi)容中添加一條HTML文本條目，并將MIMETYPE_TEXT_HTML添加到[PasteDataProperty]的mimeTypes中。入?yún)⒕荒転榭眨駝t添加失敗。

剪貼板內(nèi)容中添加的條目達(dá)到數(shù)量上限128后，后續(xù)的添加操作無效。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

示例

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

向當(dāng)前剪貼板內(nèi)容中添加一條Want條目，并將MIMETYPE_TEXT_WANT添加到[PasteDataProperty]的mimeTypes中。入?yún)⒕荒転榭眨駝t添加失敗。

剪貼板內(nèi)容中添加的條目達(dá)到數(shù)量上限128后，后續(xù)的添加操作無效。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

示例

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

向當(dāng)前剪貼板內(nèi)容中添加一條URI條目，并將MIMETYPE_TEXT_URI添加到[PasteDataProperty]的mimeTypes中。入?yún)⒕荒転榭眨駝t添加失敗。

剪貼板內(nèi)容中添加的條目達(dá)到數(shù)量上限128后，后續(xù)的添加操作無效。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

示例

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

addRecord7+

addRecord(record: PasteDataRecord): void

向當(dāng)前剪貼板內(nèi)容中添加一條條目，同時(shí)也會(huì)將條目類型添加到PasteDataProperty的mimeTypes中。入?yún)⒕荒転榭眨駝t添加失敗。

剪貼板內(nèi)容中添加的條目達(dá)到數(shù)量上限128后，后續(xù)的添加操作無效。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

示例

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" + "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

獲取剪貼板中[PasteDataProperty]的mimeTypes列表，當(dāng)剪貼板內(nèi)容為空時(shí)，返回列表為空。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

返回值

示例

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

getPrimaryMimeType7+

getPrimaryMimeType(): string

獲取首個(gè)條目的數(shù)據(jù)類型。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

返回值

示例

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

getProperty7+

getProperty(): PasteDataProperty

獲取屬性描述對(duì)象。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

返回值

示例

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

getRecordAt7+

getRecordAt(index: number): PasteDataRecord

獲取指定下標(biāo)的條目。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

返回值

示例

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

getRecordCount7+

getRecordCount(): number

獲取剪貼板中條目的個(gè)數(shù)。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

返回值

示例

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

getTag7+

getTag(): string

獲取用戶自定義的標(biāo)簽內(nèi)容，如果沒有設(shè)置用戶自定義的標(biāo)簽內(nèi)容將返回空。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

返回值

示例

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

hasMimeType7+

hasMimeType(mimeType: string): boolean

檢查內(nèi)容中是否有指定的數(shù)據(jù)類型。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

返回值

示例

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

removeRecordAt7+

removeRecordAt(index: number): boolean

移除指定下標(biāo)的條目。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

返回值

示例

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

replaceRecordAt7+

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

替換指定下標(biāo)的條目。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

返回值

示例

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

pasteboard.getSystemPasteboard

getSystemPasteboard(): SystemPasteboard

獲取系統(tǒng)剪切板。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

返回值

示例

var systemPasteboard = pasteboard.getSystemPasteboard();

SystemPasteboard

在調(diào)用SystemPasteboard的接口前，需要先通過getSystemPasteboard獲取系統(tǒng)剪切板。

var systemPasteboard = pasteboard.getSystemPasteboard();

setPasteData

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

將數(shù)據(jù)寫入系統(tǒng)剪切板，并使用callback方式返回結(jié)果。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

示例

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.');
});

setPasteData

setPasteData(data:PasteData): Promise

將數(shù)據(jù)寫入系統(tǒng)剪切板，并使用Promise異步方式返回結(jié)果。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

返回值

示例

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

getPasteData

getPasteData( callback:AsyncCallback): void

讀取系統(tǒng)剪切板內(nèi)容，并使用callback方式返回結(jié)果。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

示例

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

getPasteData

getPasteData(): Promise

讀取系統(tǒng)剪切板內(nèi)容，并使用Promise異步方式返回結(jié)果。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

返回值

示例

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

on('update')7+

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

訂閱系統(tǒng)剪貼板內(nèi)容變化事件，當(dāng)系統(tǒng)剪貼板中內(nèi)容變化時(shí)觸發(fā)用戶程序的回調(diào)。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

示例

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

取消訂閱系統(tǒng)剪貼板內(nèi)容變化事件。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

示例

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

hasPasteData7+

hasPasteData(callback: AsyncCallback): void

判斷系統(tǒng)剪切板中是否有內(nèi)容，并使用callback異步方式返回結(jié)果。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

示例

systemPasteboard.hasPasteData((err, data) = > {
    if (err) {
        console.error('failed to hasPasteData because ' + JSON.stringify(err));
        return;
    }
    console.info('success hasPasteData : ' + JSON.stringify(data));
});

hasPasteData7+

hasPasteData(): Promise

判斷系統(tǒng)剪切板中是否有內(nèi)容，并使用Promise異步方式返回結(jié)果。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

返回值

示例

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

clear7+

clear(callback: AsyncCallback): void

清空系統(tǒng)剪切板內(nèi)容，并使用callback異步方式返回結(jié)果。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

參數(shù)

示例

systemPasteboard.clear((err, data) = > { 
    if (err) {        
        console.error('failed to clear because ' + JSON.stringify(err));        
        return;    
    }
    console.info('success clear');
});

clear7+

clear(): Promise

清空系統(tǒng)剪切板內(nèi)容，并使用Promise異步方式返回結(jié)果。

系統(tǒng)能力 : SystemCapability.MiscServices.Pasteboard

返回值

示例

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

審核編輯 黃宇