Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 76f786cf 编写于 作者: Q qimeng
浏览文件
操作

Signed-off-by: qimeng <qimeng11@huawei.com> 

 Changes to be committed:
	modified:   zh-cn/application-dev/reference/apis/js-apis-pasteboard.md
上级 45ddb8b6
显示空白变更内容
内联 并排
Showing with 523 addition and 549 deletion
zh-cn/application-dev/reference/apis/js-apis-pasteboard.md
浏览文件 @ 76f786cf
......@@ -33,19 +33,16 @@ import pasteboard from '@ohos.pasteboard';
| 类型 | 说明 |
| -------- | -------- |
| string | 表示string的类型 |
| image.PixelMap<sup>7+</sup> | 表示[image.PixelMap](js-apis-image.md#pixelmap7)的类型。 |
| Want<sup>7+</sup> | 表示[Want](js-apis-application-Want.md)的类型|
| ArrayBuffer | 表示ArrayBuffer的类型|
| string | 表示string的类型。 |
| image.PixelMap<sup>9+</sup> | 表示[image.PixelMap](js-apis-image.md#pixelmap9)的类型。 |
| Want<sup>9+</sup> | 表示[Want](js-apis-application-Want.md)的类型。 |
| ArrayBuffer | 表示ArrayBuffer的类型。 |
## pasteboard.createPlainTextData(deprecated)
## pasteboard.createData<sup>9+</sup>
createPlainTextData(text: string): PasteData
createData(mimeType: string, value: ValueType): PasteData
构建一个纯文本剪贴板内容对象。
> **说明：**
>
> 从 API Version 6 开始支持，从 API Version 9 开始废弃，建议使用[pasteboard.createData<sup>9+</sup>](#pasteboard.createData<sup>9+</sup>)替代。
构建一个自定义类型的剪贴板内容对象。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -53,7 +50,8 @@ createPlainTextData(text: string): PasteData
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| text | string | 是 | 纯文本内容。 |
| mimeType | string | 是 | 自定义数据的MIME类型。 |
| value | [ValueType](#valuetype9) | 是 | 自定义数据内容。 |
**返回值：**
......@@ -63,19 +61,16 @@ createPlainTextData(text: string): PasteData
**示例：**
```js
var pasteData = pasteboard.createPlainTextData("content");
```
```js
var dataXml = 'aStringValueType';
var pasteData = pasteboard.createData('app/xml', dataXml);
```
## pasteboard.createHtmlData(deprecated)
## pasteboard.createRecord<sup>9+</sup>
createHtmlData(htmlText: string): PasteData
createRecord(mimeType: string, value: ValueType):PasteDataRecord;
构建一个HTML剪贴板内容对象。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[pasteboard.createData<sup>9+</sup>](#pasteboard.createData<sup>9+</sup>)替代。
创建一条自定义数据内容条目。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -83,30 +78,62 @@ createHtmlData(htmlText: string): PasteData
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| htmlText | string | 是 | HTML内容。 |
| mimeType | string | 是 | 自定义数据的MIME类型。 |
| value | [ValueType](#valuetype9) | 是 | 自定义数据内容。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [PasteData](#pastedata) | 剪贴板内容对象。 |
| [PasteDataRecord](#pastedatarecord7) | 一条新建的自定义数据内容条目。 |
**示例：**
```js
var dataXml = 'aStringValueType';
var pasteDataRecord = pasteboard.createRecord('app/xml', dataXml);
```
## pasteboard.getSystemPasteboard
getSystemPasteboard(): SystemPasteboard
获取系统剪贴板对象。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [SystemPasteboard](#systempasteboard) | 系统剪贴板对象。 |
**示例：**
```js
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 systemPasteboard = pasteboard.getSystemPasteboard();
```
## ShareOption<sup>9+</sup>
## pasteboard.createWantData(deprecated)
可粘贴数据的范围类型枚举。
createWantData(want: Want): PasteData
**系统能力：** SystemCapability.MiscServices.Pasteboard
构建一个Want剪贴板内容对象。
| 名称 | 说明 |
| ----- | ----------------------- |
| InApp |表示仅允许同应用内粘贴。 |
| LocalDevice |表示允许在此设备中任何应用内粘贴。 |
| CrossDevice |表示允许跨设备在任何应用内粘贴。 |
## pasteboard.createHtmlData<sup>(deprecated)</sup>
createHtmlData(htmlText: string): PasteData
构建一个HTML剪贴板内容对象。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[pasteboard.createData<sup>9+</sup>](#pasteboard.createData<sup>9+</sup>)替代。
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[pasteboard.createData](#pasteboardcreatedata9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -114,7 +141,7 @@ createWantData(want: Want): PasteData
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | Want内容。 |
| htmlText | string | 是 | HTML内容。 |
**返回值：**
......@@ -125,22 +152,18 @@ createWantData(want: Want): PasteData
**示例：**
```js
var object = {
bundleName: "com.example.aafwk.test",
abilityName: "com.example.aafwk.test.TwoAbility"
};
var pasteData = pasteboard.createWantData(object);
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.createWantData<sup>(deprecated)</sup>
## pasteboard.createUriData(deprecated)
createUriData(uri: string): PasteData
createWantData(want: Want): PasteData
构建一个URI剪贴板内容对象。
构建一个Want剪贴板内容对象。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[pasteboard.createData<sup>9+</sup>](#pasteboard.createData<sup>9+</sup>)替代。
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[pasteboard.createData](#pasteboardcreatedata9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -148,7 +171,7 @@ createUriData(uri: string): PasteData
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| uri | string | 是 | URI内容。 |
| want | [Want](js-apis-application-Want.md) | 是 | Want内容。 |
**返回值：**
......@@ -159,14 +182,21 @@ createUriData(uri: string): PasteData
**示例：**
```js
var pasteData = pasteboard.createUriData("dataability:///com.example.myapplication1/user.txt");
var object = {
bundleName: "com.example.aafwk.test",
abilityName: "com.example.aafwk.test.TwoAbility"
};
var pasteData = pasteboard.createWantData(object);
```
## pasteboard.createData<sup>9+</sup>
## pasteboard.createPlainTextData<sup>(deprecated)</sup>
createData(mimeType: string, value: ValueType): PasteData
createPlainTextData(text: string): PasteData
构建一个自定义类型的剪贴板内容对象。
构建一个纯文本剪贴板内容对象。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[pasteboard.createData](#pasteboardcreatedata9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -174,8 +204,7 @@ createData(mimeType: string, value: ValueType): PasteData
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| mimeType | string | 是 | 自定义数据的MIME类型。 |
| value | [ValueType](#ValueType<sup>9+</sup>) | 是 | 自定义数据内容。 |
| text | string | 是 | 纯文本内容。 |
**返回值：**
......@@ -185,20 +214,18 @@ createData(mimeType: string, value: ValueType): PasteData
**示例：**
```js
var dataXml = 'aStringValueType';
var pasteData = pasteboard.createData('app/xml', dataXml);
```
```js
var pasteData = pasteboard.createPlainTextData("content");
```
## pasteboard.createPlainTextRecord(deprecated)
## pasteboard.createUriData<sup>(deprecated)</sup>
createPlainTextRecord(text: string): PasteDataRecord
createUriData(uri: string): PasteData
创建一条纯文本内容条目。
构建一个URI剪贴板内容对象。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[pasteboard.createRecord<sup>9+</sup>](#pasteboard.createRecord<sup>9+</sup>)替代。
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[pasteboard.createData](#pasteboardcreatedata9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -206,29 +233,27 @@ createPlainTextRecord(text: string): PasteDataRecord
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| text | string | 是 | 纯文本内容。 |
| uri | string | 是 | URI内容。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [PasteDataRecord](#pastedatarecord7) | 一条新建的纯文本内容条目。 |
| [PasteData](#pastedata) | 剪贴板内容对象。 |
**示例：**
```js
var record = pasteboard.createPlainTextRecord("hello");
var pasteData = pasteboard.createUriData("dataability:///com.example.myapplication1/user.txt");
```
## pasteboard.createHtmlTextRecord(deprecated)
## pasteboard.createHtmlTextRecord<sup>(deprecated)</sup>
createHtmlTextRecord(htmlText: string): PasteDataRecord
创建一条HTML内容的条目。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[pasteboard.createRecord<sup>9+</sup>](#pasteboard.createRecord<sup>9+</sup>)替代。
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[pasteboard.createRecord](#pasteboardcreaterecord9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -251,15 +276,14 @@ var html = "<!DOCTYPE html>\n" + "<html>\n" + "<head>\n" + "<meta charset=\"utf-
var record = pasteboard.createHtmlTextRecord(html);
```
## pasteboard.createWantRecord(deprecated)
## pasteboard.createWantRecord<sup>(deprecated)</sup>
createWantRecord(want: Want): PasteDataRecord
创建一条Want内容条目。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[pasteboard.createRecord<sup>9+</sup>](#pasteboard.createRecord<sup>9+</sup>)替代。
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[pasteboard.createRecord](#pasteboardcreaterecord9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -285,15 +309,14 @@ var object = {
var record = pasteboard.createWantRecord(object);
```
## pasteboard.createPlainTextRecord<sup>(deprecated)</sup>
## pasteboard.createUriRecord(deprecated)
createUriRecord(uri: string): PasteDataRecord
createPlainTextRecord(text: string): PasteDataRecord
创建一条URI内容的条目。
创建一条纯文本内容条目。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[pasteboard.createRecord<sup>9+</sup>](#pasteboard.createRecord<sup>9+</sup>)替代。
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[pasteboard.createRecord](#pasteboardcreaterecord9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -301,25 +324,28 @@ createUriRecord(uri: string): PasteDataRecord
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| uri | string | 是 | URI内容。 |
| text | string | 是 | 纯文本内容。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [PasteDataRecord](#pastedatarecord7) | 一条新建的URI内容条目。 |
| [PasteDataRecord](#pastedatarecord7) | 一条新建的纯文本内容条目。 |
**示例：**
```js
var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
var record = pasteboard.createPlainTextRecord("hello");
```
## pasteboard.createRecord<sup>9+</sup>
## pasteboard.createUriRecord<sup>(deprecated)</sup>
createRecord(mimeType: string, value: ValueType):PasteDataRecord;
createUriRecord(uri: string): PasteDataRecord
创建一条自定义数据内容条目。
创建一条URI内容的条目。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[pasteboard.createRecord](#pasteboardcreaterecord9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -327,55 +353,20 @@ createRecord(mimeType: string, value: ValueType):PasteDataRecord;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| mimeType | string | 是 | 自定义数据的MIME类型。 |
| value | [ValueType](#ValueType<sup>9+</sup>) | 是 | 自定义数据内容。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [PasteDataRecord](#pastedatarecord7) | 一条新建的自定义数据内容条目。 |
**示例：**
```js
var dataXml = 'aStringValueType';
var pasteDataRecord = pasteboard.createRecord('app/xml', dataXml);
```
## pasteboard.getSystemPasteboard
getSystemPasteboard(): SystemPasteboard
获取系统剪贴板对象。
**系统能力：** SystemCapability.MiscServices.Pasteboard
| uri | string | 是 | URI内容。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [SystemPasteboard](#systempasteboard) | 系统剪贴板对象。 |
| [PasteDataRecord](#pastedatarecord7) | 一条新建的URI内容条目。 |
**示例：**
```js
var systemPasteboard = pasteboard.getSystemPasteboard();
var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
```
## ShareOption<sup>9+</sup>
可粘贴数据的范围类型枚举。
**系统能力：** SystemCapability.MiscServices.Pasteboard
| 名称 | 说明 |
| ----- | ----------------------- |
| InApp |表示仅允许同应用内粘贴。 |
| LocalDevice |表示允许在此设备中任何应用内粘贴。 |
| CrossDevice |表示允许跨设备在任何应用内粘贴。 |
## PasteDataProperty<sup>7+</sup>
......@@ -392,12 +383,10 @@ var systemPasteboard = pasteboard.getSystemPasteboard();
| localOnly<sup>7+</sup> | boolean | 是 | 是 | 配置剪贴板内容是否为“仅在本地”。默认值为true。<br/>- 配置为true时，表示内容仅在本地，不会在设备之间传递。<br/>- 配置为false时，表示内容将在设备间传递。 |
| shareOption<sup>9+</sup> | [ShareOption](#shareoption9) | 是 | 是 | 指示剪贴板数据可以粘贴到的范围，如果未设置或设置不正确，则默认值为CrossDevice。 |
## PasteDataRecord<sup>7+</sup>
对于剪贴板中内容记录的抽象定义，称之为条目。剪贴板内容部分由一个或者多个条目构成，例如一条文本内容、一份HTML、一个URI或者一个Want。
### 属性
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -412,70 +401,66 @@ var systemPasteboard = pasteboard.getSystemPasteboard();
| pixelMap<sup>9+</sup> | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | 否 | PixelMap内容。 |
| data<sup>9+</sup> | {[mimeType:&nbsp;string]:&nbsp;ArrayBuffer} | 是 | 否 | 自定义数据内容。 |
### convertToTextV9<sup>9+</sup>
### convertToText(deprecated)
convertToText(): Promise&lt;string&gt;
convertToTextV9(callback: AsyncCallback&lt;string&gt;): void
将一个PasteData中的内容强制转换为文本内容，使用Promise异步回调。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[convertToTextV9<sup>9+</sup>](#convertToTextV9<sup>9+</sup>)替代。
将一个PasteData中的内容强制转换为文本内容，使用callback异步回调。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**返回值：**
**参数：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;string&gt; | Promise对象，返回强制转换的文本内容。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数，当转换成功，err为undefined，data为强制转换的文本内容；否则返回错误信息。 |
**示例：**
```js
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) => {
record.convertToTextV9((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));
});
```
### convertToText(deprecated)
### convertToTextV9<sup>9+</sup>
convertToText(callback: AsyncCallback&lt;string&gt;): void
convertToTextV9(): Promise&lt;string&gt;
将一个PasteData中的内容强制转换为文本内容，使用callback异步回调。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[convertToTextV9<sup>9+</sup>](#convertToTextV9<sup>9+</sup>)替代。
将一个PasteData中的内容强制转换为文本内容，使用Promise异步回调。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
**返回值：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数，当转换成功，err为undefined，data为强制转换的文本内容；否则返回错误信息。 |
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;string&gt; | Promise对象，返回强制转换的文本内容。 |
**示例：**
```js
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;
}
record.convertToTextV9().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));
});
```
### convertToTextV9<sup>9+</sup>
### convertToText<sup>(deprecated)</sup>
convertToTextV9(callback: AsyncCallback&lt;string&gt;): void
convertToText(callback: AsyncCallback&lt;string&gt;): void
将一个PasteData中的内容强制转换为文本内容，使用callback异步回调。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[convertToTextV9](#converttotextv99)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -489,7 +474,7 @@ convertToTextV9(callback: AsyncCallback&lt;string&gt;): void
```js
var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
record.convertToTextV9((err, data) => {
record.convertToText((err, data) => {
if (err) {
console.error('Failed to convert to text. Cause: ' + JSON.stringify(err));
return;
......@@ -498,11 +483,14 @@ record.convertToTextV9((err, data) => {
});
```
### convertToTextV9<sup>9+</sup>
### convertToText<sup>(deprecated)</sup>
convertToTextV9(): Promise&lt;string&gt;
convertToText(): Promise&lt;string&gt;
将一个PasteData中的内容强制转换为文本内容，使用Promise异步回调。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[convertToTextV9](##converttotextv99-1)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -516,13 +504,14 @@ convertToTextV9(): Promise&lt;string&gt;
```js
var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
record.convertToTextV9().then((data) => {
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));
});
```
## PasteData
剪贴板内容对象。
......@@ -531,18 +520,14 @@ record.convertToTextV9().then((data) => {
**系统能力：** SystemCapability.MiscServices.Pasteboard
### getPrimaryText
getPrimaryText(): string
获取首个条目的纯文本内容。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**返回值：**
| 类型 | 说明 |
......@@ -556,7 +541,6 @@ var pasteData = pasteboard.createPlainTextData("hello");
var plainText = pasteData.getPrimaryText();
```
### getPrimaryHtml<sup>7+</sup>
getPrimaryHtml(): string
......@@ -579,7 +563,6 @@ var pasteData = pasteboard.createHtmlData(html);
var htmlText = pasteData.getPrimaryHtml();
```
### getPrimaryWant<sup>7+</sup>
getPrimaryWant(): Want
......@@ -605,7 +588,6 @@ var pasteData = pasteboard.createWantData(object);
var want = pasteData.getPrimaryWant();
```
### getPrimaryUri<sup>7+</sup>
getPrimaryUri(): string
......@@ -627,7 +609,6 @@ var pasteData = pasteboard.createUriData("dataability:///com.example.myapplicati
var uri = pasteData.getPrimaryUri();
```
### getPrimaryPixelMap<sup>9+</sup>
getPrimaryPixelMap(): image.PixelMap
......@@ -661,16 +642,13 @@ image.createPixelMap(buffer, opt).then((pixelMap) => {
})
```
### addTextRecord(deprecated)
### addRecord<sup>7+</sup>
addTextRecord(text: string): void
addRecord(record: PasteDataRecord): void
向当前剪贴板内容中添加一条纯文本条目，并将MIME_TEXT_PLAIN添加到[PasteDataProperty](#pastedataproperty7)的mimeTypes中。入参均不能为空，否则添加失败。
向当前剪贴板内容中添加一条条目，同时也会将条目类型添加到[PasteDataProperty](#pastedataproperty7)的mimeTypes中。入参均不能为空，否则添加失败。
剪贴板内容中添加的条目达到数量上限512后，后续的添加操作无效。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[addRecord<sup>9+</sup>](#addRecord<sup>9+</sup>)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -678,98 +656,18 @@ addTextRecord(text: string): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| text | string | 是 | 纯文本内容。 |
**示例：**
```js
var pasteData = pasteboard.createPlainTextData("hello");
pasteData.addTextRecord("good");
```
### addHtmlRecord(deprecated)
addHtmlRecord(htmlText: string): void
向当前剪贴板内容中添加一条HTML内容条目，并将MIMETYPE_TEXT_HTML添加到[PasteDataProperty](#pastedataproperty7)的mimeTypes中。入参均不能为空，否则添加失败。
剪贴板内容中添加的条目达到数量上限512后，后续的添加操作无效。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[addRecord<sup>9+</sup>](#addRecord<sup>9+</sup>)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| htmlText | string | 是 | HTML内容。 |
| record | [PasteDataRecord](#pastedatarecord7) | 是 | 待添加的条目。 |
**示例：**
```js
var pasteData = pasteboard.createPlainTextData("hello");
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>";
pasteData.addHtmlRecord(html);
```
### addWantRecord(deprecated)
addWantRecord(want: Want): void
向当前剪贴板内容中添加一条Want条目，并将MIMETYPE_TEXT_WANT添加到[PasteDataProperty](#pastedataproperty7)的mimeTypes中。入参均不能为空，否则添加失败。
剪贴板内容中添加的条目达到数量上限512后，后续的添加操作无效。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[addRecord<sup>9+</sup>](#addRecord<sup>9+</sup>)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | Want对象内容。 |
**示例：**
```js
var pasteData = pasteboard.createPlainTextData("hello");
var object = {
bundleName: "com.example.aafwk.test",
abilityName: "com.example.aafwk.test.TwoAbility"
};
pasteData.addWantRecord(object);
```
### addUriRecord(deprecated)
addUriRecord(uri: string): void
向当前剪贴板内容中添加一条URI条目，并将MIMETYPE_TEXT_URI添加到[PasteDataProperty](#pastedataproperty7)的mimeTypes中。入参均不能为空，否则添加失败。
剪贴板内容中添加的条目达到数量上限512后，后续的添加操作无效。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[addRecord<sup>9+</sup>](#addRecord<sup>9+</sup>)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| uri | string | 是 | URI内容。 |
**示例：**
```js
var pasteData = pasteboard.createPlainTextData("hello");
pasteData.addUriRecord("dataability:///com.example.myapplication1/user.txt");
var htmlRecord = pasteboard.createHtmlTextRecord(html);
pasteData.addRecord(textRecord);
pasteData.addRecord(htmlRecord);
```
### addRecord<sup>9+</sup>
addRecord(mimeType: string, value: ValueType): void
......@@ -785,7 +683,7 @@ addRecord(mimeType: string, value: ValueType): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| mimeType | string | 是 | 自定义数据的MIME类型。 |
| value | [ValueType](#ValueType<sup>9+</sup>) | 是 | 自定义数据内容。 |
| value | [ValueType](#valuetype9) | 是 | 自定义数据内容。 |
**示例：**
......@@ -795,35 +693,6 @@ addRecord(mimeType: string, value: ValueType): void
pasteData.addRecord('app/xml', dataXml);
```
### addRecord<sup>7+</sup>
addRecord(record: PasteDataRecord): void
向当前剪贴板内容中添加一条条目，同时也会将条目类型添加到[PasteDataProperty](#pastedataproperty7)的mimeTypes中。入参均不能为空，否则添加失败。
剪贴板内容中添加的条目达到数量上限512后，后续的添加操作无效。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| record | [PasteDataRecord](#pastedatarecord7) | 是 | 待添加的条目。 |
**示例：**
```js
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);
```
### getMimeTypes<sup>7+</sup>
getMimeTypes(): Array&lt;string&gt;
......@@ -845,7 +714,6 @@ var pasteData = pasteboard.createPlainTextData("hello");
var types = pasteData.getMimeTypes();
```
### getPrimaryMimeType<sup>7+</sup>
getPrimaryMimeType(): string
......@@ -867,7 +735,6 @@ var pasteData = pasteboard.createPlainTextData("hello");
var type = pasteData.getPrimaryMimeType();
```
### getProperty<sup>7+</sup>
getProperty(): PasteDataProperty
......@@ -889,7 +756,6 @@ var pasteData = pasteboard.createPlainTextData("hello");
var property = pasteData.getProperty();
```
### setProperty<sup>9+</sup>
setProperty(property: PasteDataProperty): void
......@@ -913,37 +779,6 @@ prop.shareOption = pasteboard.ShareOption.InApp;
pasteData.setProperty(prop);
```
### getRecordAt(deprecated)
getRecordAt(index: number): PasteDataRecord
获取剪贴板内容中指定下标的条目。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[getRecord<sup>9+</sup>](#getRecord<sup>9+</sup>)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| index | number | 是 | 指定条目的下标。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [PasteDataRecord](#pastedatarecord7) | 指定下标的条目。 |
**示例：**
```js
var pasteData = pasteboard.createPlainTextData("hello");
var record = pasteData.getRecordAt(0);
```
### getRecord<sup>9+</sup>
getRecord(index: number): PasteDataRecord
......@@ -992,7 +827,6 @@ var pasteData = pasteboard.createPlainTextData("hello");
var count = pasteData.getRecordCount();
```
### getTag<sup>7+</sup>
getTag(): string
......@@ -1041,15 +875,11 @@ var pasteData = pasteboard.createPlainTextData("hello");
var hasType = pasteData.hasType(pasteboard.MIMETYPE_TEXT_PLAIN);
```
### removeRecord<sup>9+</sup>
### hasMimeType(deprecated)
hasMimeType(mimeType: string): boolean
removeRecord(index: number): void
检查剪贴板内容中是否有指定的数据类型。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[hasType<sup>9+</sup>](#hasType<sup>9+</sup>)替代。
移除剪贴板内容中指定下标的条目。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -1057,29 +887,20 @@ hasMimeType(mimeType: string): boolean
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| mimeType | string | 是 | 待查询的数据类型。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 有指定的数据类型返回true，否则返回false。 |
| index | number | 是 | 指定的下标。 |
**示例：**
```js
var pasteData = pasteboard.createPlainTextData("hello");
var hasType = pasteData.hasMimeType(pasteboard.MIMETYPE_TEXT_PLAIN);
pasteData.removeRecord(0);
```
### removeRecordAt(deprecated)
### replaceRecord<sup>9+</sup>
removeRecordAt(index: number): boolean
replaceRecord(index: number, record: PasteDataRecord): void
移除剪贴板内容中指定下标的条目。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[replaceRecord<sup>9+</sup>](#replaceRecord<sup>9+</sup>)替代。
替换剪贴板内容中指定下标的条目。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -1088,25 +909,25 @@ removeRecordAt(index: number): boolean
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| index | number | 是 | 指定的下标。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 成功移除返回true，失败返回false。 |
| record | [PasteDataRecord](#pastedatarecord7) | 是 | 新条目的内容。 |
**示例：**
```js
var pasteData = pasteboard.createPlainTextData("hello");
var isRemove = pasteData.removeRecordAt(0);
var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
pasteData.replaceRecord(0, record);
```
### addHtmlRecord<sup>(deprecated)</sup>
### removeRecord<sup>9+</sup>
addHtmlRecord(htmlText: string): void
removeRecord(index: number): void
向当前剪贴板内容中添加一条HTML内容条目，并将MIMETYPE_TEXT_HTML添加到[PasteDataProperty](#pastedataproperty7)的mimeTypes中。入参均不能为空，否则添加失败。
移除剪贴板内容中指定下标的条目。
剪贴板内容中添加的条目达到数量上限512后，后续的添加操作无效。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[addRecord](#addrecord9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -1114,23 +935,26 @@ removeRecord(index: number): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| index | number | 是 | 指定的下标。 |
| htmlText | string | 是 | HTML内容。 |
**示例：**
```js
var pasteData = pasteboard.createPlainTextData("hello");
pasteData.removeRecord(0);
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);
```
### replaceRecordAt(deprecated)
### addWantRecord<sup>(deprecated)</sup>
replaceRecordAt(index: number, record: PasteDataRecord): boolean
addWantRecord(want: Want): void
替换剪贴板内容中指定下标的条目。
向当前剪贴板内容中添加一条Want条目，并将MIMETYPE_TEXT_WANT添加到[PasteDataProperty](#pastedataproperty7)的mimeTypes中。入参均不能为空，否则添加失败。
剪贴板内容中添加的条目达到数量上限512后，后续的添加操作无效。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[replaceRecord<sup>9+</sup>](#replaceRecord<sup>9+</sup>)替代。
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[addRecord](#addrecord9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -1138,28 +962,29 @@ replaceRecordAt(index: number, record: PasteDataRecord): boolean
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| index | number | 是 | 指定的下标。 |
| record | [PasteDataRecord](#pastedatarecord7) | 是 | 替换后的条目。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 成功替换返回true，失败返回false。 |
| want | [Want](js-apis-application-Want.md) | 是 | Want对象内容。 |
**示例：**
```js
var pasteData = pasteboard.createPlainTextData("hello");
var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
var isReplace = pasteData.replaceRecordAt(0, record);
var object = {
bundleName: "com.example.aafwk.test",
abilityName: "com.example.aafwk.test.TwoAbility"
};
pasteData.addWantRecord(object);
```
### replaceRecord<sup>9+</sup>
### addTextRecord<sup>(deprecated)</sup>
replaceRecord(index: number, record: PasteDataRecord): void
addTextRecord(text: string): void
替换剪贴板内容中指定下标的条目。
向当前剪贴板内容中添加一条纯文本条目，并将MIME_TEXT_PLAIN添加到[PasteDataProperty](#pastedataproperty7)的mimeTypes中。入参均不能为空，否则添加失败。
剪贴板内容中添加的条目达到数量上限512后，后续的添加操作无效。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[addRecord](#addrecord9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -1167,33 +992,25 @@ replaceRecord(index: number, record: PasteDataRecord): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| index | number | 是 | 指定的下标。 |
| record | [PasteDataRecord](#pastedatarecord7) | 是 | 新条目的内容。 |
| text | string | 是 | 纯文本内容。 |
**示例：**
```js
var pasteData = pasteboard.createPlainTextData("hello");
var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
pasteData.replaceRecord(0, record);
```
## SystemPasteboard
系统剪贴板对象。
在调用SystemPasteboard的接口前，需要先通过[getSystemPasteboard](#pasteboardgetsystempasteboard)获取系统剪贴板。
```js
var systemPasteboard = pasteboard.getSystemPasteboard();
pasteData.addTextRecord("good");
```
### addUriRecord<sup>(deprecated)</sup>
### setPasteData
addUriRecord(uri: string): void
setPasteData(data: PasteData, callback: AsyncCallback&lt;void&gt;): void
向当前剪贴板内容中添加一条URI条目，并将MIMETYPE_TEXT_URI添加到[PasteDataProperty](#pastedataproperty7)的mimeTypes中。入参均不能为空，否则添加失败。
将数据写入系统剪贴板，使用callback异步回调。
剪贴板内容中添加的条目达到数量上限512后，后续的添加操作无效。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[addRecord](#addrecord9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -1201,61 +1018,52 @@ setPasteData(data: PasteData, callback: AsyncCallback&lt;void&gt;): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| data | [PasteData](#pastedata) | 是 | PasteData对象。 |
| callback | AsyncCallback&lt;void> | 是 | 回调函数。当写入成功，err为undefined，否则为错误对象。 |
| uri | string | 是 | URI内容。 |
**示例：**
```js
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.');
});
var pasteData = pasteboard.createPlainTextData("hello");
pasteData.addUriRecord("dataability:///com.example.myapplication1/user.txt");
```
### getRecordAt<sup>(deprecated)</sup>
getRecordAt(index: number): PasteDataRecord
### setPasteData
setPasteData(data: PasteData): Promise&lt;void&gt;
将数据写入系统剪贴板，使用Promise异步回调。
获取剪贴板内容中指定下标的条目。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[getRecord](#getrecord9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
| 参数名 | 类型 | 说明 |
| -------- | -------- | -------- |
| data | [PasteData](#pastedata) | PasteData对象。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| index | number | 是 | 指定条目的下标。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
| [PasteDataRecord](#pastedatarecord7) | 指定下标的条目。 |
**示例：**
```js
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);
});
var pasteData = pasteboard.createPlainTextData("hello");
var record = pasteData.getRecordAt(0);
```
### setData<sup>9+</sup>
### hasMimeType<sup>(deprecated)</sup>
setData(data: PasteData, callback: AsyncCallback&lt;void&gt;): void
hasMimeType(mimeType: string): boolean
将数据写入系统剪贴板，使用callback异步回调。
检查剪贴板内容中是否有指定的数据类型。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[hasType](#hastype9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -1263,64 +1071,96 @@ setData(data: PasteData, callback: AsyncCallback&lt;void&gt;): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| data | [PasteData](#pastedata) | 是 | PasteData对象。 |
| callback | AsyncCallback&lt;void> | 是 | 回调函数。当写入成功，err为undefined，否则为错误对象。 |
| mimeType | string | 是 | 待查询的数据类型。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 有指定的数据类型返回true，否则返回false。 |
**示例：**
```js
var pasteData = pasteboard.createPlainTextData("content");
var 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.');
});
var pasteData = pasteboard.createPlainTextData("hello");
var hasType = pasteData.hasMimeType(pasteboard.MIMETYPE_TEXT_PLAIN);
```
### removeRecordAt<sup>(deprecated)</sup>
removeRecordAt(index: number): boolean
### setData<sup>9+</sup>
移除剪贴板内容中指定下标的条目。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[removeRecord](#removerecord9)替代。
setData(data: PasteData): Promise&lt;void&gt;
**系统能力：** SystemCapability.MiscServices.Pasteboard
将数据写入系统剪贴板，使用Promise异步回调。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| index | number | 是 | 指定的下标。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 成功移除返回true，失败返回false。 |
**示例：**
```js
var pasteData = pasteboard.createPlainTextData("hello");
var isRemove = pasteData.removeRecordAt(0);
```
### replaceRecordAt<sup>(deprecated)</sup>
replaceRecordAt(index: number, record: PasteDataRecord): boolean
替换剪贴板内容中指定下标的条目。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[replaceRecord](#replacerecord9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
| 参数名 | 类型 | 说明 |
| -------- | -------- | -------- |
| data | [PasteData](#pastedata) | PasteData对象。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| index | number | 是 | 指定的下标。 |
| record | [PasteDataRecord](#pastedatarecord7) | 是 | 替换后的条目。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
| boolean | 成功替换返回true，失败返回false。 |
**示例：**
```js
var pasteData = pasteboard.createPlainTextData("content");
var pasteData = pasteboard.createPlainTextData("hello");
var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
var isReplace = pasteData.replaceRecordAt(0, record);
```
## SystemPasteboard
系统剪贴板对象。
在调用SystemPasteboard的接口前，需要先通过[getSystemPasteboard](#pasteboardgetsystempasteboard)获取系统剪贴板。
```js
var 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);
});
```
### getPasteData(deprecated)
### on('update')<sup>7+</sup>
getPasteData( callback: AsyncCallback&lt;PasteData&gt;): void
on(type: 'update', callback: () =&gt;void ): void
读取系统剪贴板内容，使用callback异步回调。
> **说明：**
>
> 从 API Version 6 开始支持，从 API Version 9 开始废弃，建议使用[getData<sup>9+</sup>](#getData<sup>9+</sup>)替代。
订阅系统剪贴板内容变化事件，当系统剪贴板中内容变化时触发用户程序的回调。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -1328,54 +1168,48 @@ getPasteData( callback: AsyncCallback&lt;PasteData&gt;): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[PasteData](#pastedata)&gt; | 是 | 回调函数。当读取成功，err为undefined，data为返回的系统剪贴板数据；否则返回错误对象。 |
| type | string | 是 | 取值为'update'，表示系统剪贴板内容变化事件。 |
| callback | function | 是 | 剪贴板中内容变化时触发的用户程序的回调。 |
**示例：**
```js
var systemPasteboard = pasteboard.getSystemPasteboard();
systemPasteboard.getPasteData((err, pasteData) => {
if (err) {
console.error('Failed to get PasteData. Cause: ' + err.message);
return;
}
var text = pasteData.getPrimaryText();
});
var listener = () => {
console.info('The system pasteboard has changed.');
};
systemPasteboard.on('update', listener);
```
### getPasteData(deprecated)
### off('update')<sup>7+</sup>
getPasteData(): Promise&lt;PasteData&gt;
off(type: 'update', callback?: () =&gt;void ): void
读取系统剪贴板内容，使用Promise异步回调。
> **说明：**
>
> 从 API Version 6 开始支持，从 API Version 9 开始废弃，建议使用[getData<sup>9+</sup>](#getData<sup>9+</sup>)替代。
取消订阅系统剪贴板内容变化事件。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**返回值：**
**参数：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[PasteData](#pastedata)&gt; | Promise对象，返回系统剪贴板数据。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取值为'update'，表示系统剪贴板内容变化事件。 |
| callback | function | 否 | 剪贴板中内容变化时触发的用户程序的回调。 |
**示例：**
```js
var systemPasteboard = pasteboard.getSystemPasteboard();
systemPasteboard.getPasteData().then((pasteData) => {
var text = pasteData.getPrimaryText();
}).catch((err) => {
console.error('Failed to get PasteData. Cause: ' + err.message);
})
let listener = () => {
console.info('The system pasteboard has changed.');
};
systemPasteboard.off('update', listener);
```
### getData<sup>9+</sup>
### clearData<sup>9+</sup>
getData( callback: AsyncCallback&lt;PasteData&gt;): void
clearData(callback: AsyncCallback&lt;void&gt;): void
读取系统剪贴板内容，使用callback异步回调。
清空系统剪贴板内容，使用callback异步回调。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -1383,26 +1217,25 @@ getData( callback: AsyncCallback&lt;PasteData&gt;): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[PasteData](#pastedata)&gt; | 是 | 回调函数。当读取成功，err为undefined，data为返回的系统剪贴板数据；否则返回错误对象。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当成功清空时，err为undefined；否则为错误对象。 |
**示例：**
```js
var systemPasteboard = pasteboard.getSystemPasteboard();
systemPasteboard.getData((err, pasteData) => {
systemPasteboard.clearData((err, data) => {
if (err) {
console.error('Failed to get PasteData. Cause: ' + err.message);
console.error('Failed to clear the pasteboard. Cause: ' + JSON.stringify(err));
return;
}
var text = pasteData.getPrimaryText();
console.info('Succeeded in clearing the pasteboard.');
});
```
### getData<sup>9+</sup>
### clearData<sup>9+</sup>
getData(): Promise&lt;PasteData&gt;
clearData(): Promise&lt;void&gt;
读取系统剪贴板内容，使用Promise异步回调。
清空系统剪贴板内容，使用Promise异步回调。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -1410,24 +1243,23 @@ getData(): Promise&lt;PasteData&gt;
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[PasteData](#pastedata)&gt; | Promise对象，返回系统剪贴板数据。 |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
```js
var systemPasteboard = pasteboard.getSystemPasteboard();
systemPasteboard.getData().then((pasteData) => {
var text = pasteData.getPrimaryText();
systemPasteboard.clearData().then((data) => {
console.info('Succeeded in clearing the pasteboard.');
}).catch((err) => {
console.error('Failed to get PasteData. Cause: ' + err.message);
})
console.error('Failed to clear the pasteboard. Cause: ' + JSON.stringify(err));
});
```
### on('update')<sup>7+</sup>
### setData<sup>9+</sup>
on(type: 'update', callback: () =&gt;void ): void
setData(data: PasteData, callback: AsyncCallback&lt;void&gt;): void
订阅系统剪贴板内容变化事件，当系统剪贴板中内容变化时触发用户程序的回调。
将数据写入系统剪贴板，使用callback异步回调。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -1435,50 +1267,60 @@ on(type: 'update', callback: () =&gt;void ): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取值为'update'，表示系统剪贴板内容变化事件。 |
| callback | function | 是 | 剪贴板中内容变化时触发的用户程序的回调。 |
| data | [PasteData](#pastedata) | 是 | PasteData对象。 |
| callback | AsyncCallback&lt;void> | 是 | 回调函数。当写入成功，err为undefined，否则为错误对象。 |
**示例：**
```js
var pasteData = pasteboard.createPlainTextData("content");
var systemPasteboard = pasteboard.getSystemPasteboard();
var listener = () => {
console.info('The system pasteboard has changed.');
};
systemPasteboard.on('update', listener);
systemPasteboard.setData(pasteData, (err, data) => {
if (err) {
console.error('Failed to set PasteData. Cause: ' + err.message);
return;
}
console.info('Succeeded in setting PasteData.');
});
```
### setData<sup>9+</sup>
### off('update')<sup>7+</sup>
off(type: 'update', callback?: () =&gt;void ): void
setData(data: PasteData): Promise&lt;void&gt;
取消订阅系统剪贴板内容变化事件。
将数据写入系统剪贴板，使用Promise异步回调。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取值为'update'，表示系统剪贴板内容变化事件。 |
| callback | function | 否 | 剪贴板中内容变化时触发的用户程序的回调。 |
| 参数名 | 类型 | 说明 |
| -------- | -------- | -------- |
| data | [PasteData](#pastedata) | PasteData对象。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
```js
let listener = () => {
console.info('The system pasteboard has changed.');
};
systemPasteboard.off('update', listener);
var pasteData = pasteboard.createPlainTextData("content");
var 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);
});
```
### getData<sup>9+</sup>
### hasPasteData<sup>7+</sup>
hasPasteData(callback: AsyncCallback&lt;boolean&gt;): void
getData( callback: AsyncCallback&lt;PasteData&gt;): void
判断系统剪贴板中是否有内容，使用callback异步回调。
读取系统剪贴板内容，使用callback异步回调。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -1486,25 +1328,26 @@ hasPasteData(callback: AsyncCallback&lt;boolean&gt;): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 返回true表示系统剪贴板中有内容，返回false表示系统剪贴板中没有内容。 |
| callback | AsyncCallback&lt;[PasteData](#pastedata)&gt; | 是 | 回调函数。当读取成功，err为undefined，data为返回的系统剪贴板数据；否则返回错误对象。 |
**示例：**
```js
systemPasteboard.hasPasteData((err, data) => {
var systemPasteboard = pasteboard.getSystemPasteboard();
systemPasteboard.getData((err, pasteData) => {
if (err) {
console.error('Failed to check the PasteData. Cause: ' + JSON.stringify(err));
console.error('Failed to get PasteData. Cause: ' + err.message);
return;
}
console.info('Succeeded in checking the PasteData. Data: ' + JSON.stringify(data));
var text = pasteData.getPrimaryText();
});
```
### hasPasteData<sup>7+</sup>
### getData<sup>9+</sup>
hasPasteData(): Promise&lt;boolean&gt;
getData(): Promise&lt;PasteData&gt;
判断系统剪贴板中是否有内容，使用Promise异步回调。
读取系统剪贴板内容，使用Promise异步回调。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -1512,16 +1355,17 @@ hasPasteData(): Promise&lt;boolean&gt;
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;boolean&gt; | 返回true表示系统剪贴板中有内容，返回false表示系统剪贴板中没有内容。 |
| Promise&lt;[PasteData](#pastedata)&gt; | Promise对象，返回系统剪贴板数据。 |
**示例：**
```js
systemPasteboard.hasPasteData().then((data) => {
console.info('Succeeded in checking the PasteData. Data: ' + JSON.stringify(data));
var systemPasteboard = pasteboard.getSystemPasteboard();
systemPasteboard.getData().then((pasteData) => {
var text = pasteData.getPrimaryText();
}).catch((err) => {
console.error('Failed to check the PasteData. Cause: ' + JSON.stringify(err));
});
console.error('Failed to get PasteData. Cause: ' + err.message);
})
```
### hasData<sup>9+</sup>
......@@ -1574,11 +1418,14 @@ systemPasteboard.hasData().then((data) => {
});
```
### clear<sup>7+</sup>
### clear<sup>(deprecated)</sup>
clear(callback: AsyncCallback&lt;void&gt;): void
清空系统剪贴板内容，使用callback异步回调。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[pasteboard.clearData](#cleardata9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -1600,13 +1447,14 @@ systemPasteboard.clear((err, data) => {
});
```
### clear<sup>7+</sup>
### clear<sup>(deprecated)</sup>
clear(): Promise&lt;void&gt;
清空系统剪贴板内容，使用Promise异步回调。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[pasteboard.clearData](#cleardata9-1)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**返回值：**
......@@ -1625,11 +1473,14 @@ systemPasteboard.clear().then((data) => {
});
```
### clearData<sup>9+</sup>
### getPasteData<sup>(deprecated)</sup>
clearData(callback: AsyncCallback&lt;void&gt;): void
getPasteData( callback: AsyncCallback&lt;PasteData&gt;): void
清空系统剪贴板内容，使用callback异步回调。
读取系统剪贴板内容，使用callback异步回调。
> **说明：**
>
> 从 API Version 6 开始支持，从 API Version 9 开始废弃，建议使用[getData](#getdata9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
......@@ -1637,30 +1488,151 @@ clearData(callback: AsyncCallback&lt;void&gt;): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当成功清空时，err为undefined；否则为错误对象。 |
| callback | AsyncCallback&lt;[PasteData](#pastedata)&gt; | 是 | 回调函数。当读取成功，err为undefined，data为返回的系统剪贴板数据；否则返回错误对象。 |
**示例：**
```js
systemPasteboard.clearData((err, data) => {
var systemPasteboard = pasteboard.getSystemPasteboard();
systemPasteboard.getPasteData((err, pasteData) => {
if (err) {
console.error('Failed to clear the pasteboard. Cause: ' + JSON.stringify(err));
console.error('Failed to get PasteData. Cause: ' + err.message);
return;
}
console.info('Succeeded in clearing the pasteboard.');
var text = pasteData.getPrimaryText();
});
```
### clearData<sup>9+</sup>
### getPasteData<sup>(deprecated)</sup>
clearData(): Promise&lt;void&gt;
getPasteData(): Promise&lt;PasteData&gt;
清空系统剪贴板内容，使用Promise异步回调。
读取系统剪贴板内容，使用Promise异步回调。
> **说明：**
>
> 从 API Version 6 开始支持，从 API Version 9 开始废弃，建议使用[getData](#getdata9-1)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[PasteData](#pastedata)&gt; | Promise对象，返回系统剪贴板数据。 |
**示例：**
```js
var systemPasteboard = pasteboard.getSystemPasteboard();
systemPasteboard.getPasteData().then((pasteData) => {
var text = pasteData.getPrimaryText();
}).catch((err) => {
console.error('Failed to get PasteData. Cause: ' + err.message);
})
```
### hasPasteData<sup>(deprecated)</sup>
hasPasteData(callback: AsyncCallback&lt;boolean&gt;): void
判断系统剪贴板中是否有内容，使用callback异步回调。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[hasData](#hasdata9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 返回true表示系统剪贴板中有内容，返回false表示系统剪贴板中没有内容。 |
**示例：**
```js
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));
});
```
### hasPasteData<sup>(deprecated)</sup>
hasPasteData(): Promise&lt;boolean&gt;
判断系统剪贴板中是否有内容，使用Promise异步回调。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[hasData](#hasdata9-1)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;boolean&gt; | 返回true表示系统剪贴板中有内容，返回false表示系统剪贴板中没有内容。 |
**示例：**
```js
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));
});
```
### setPasteData<sup>(deprecated)</sup>
setPasteData(data: PasteData, callback: AsyncCallback&lt;void&gt;): void
将数据写入系统剪贴板，使用callback异步回调。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[setData](#setdata9)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| data | [PasteData](#pastedata) | 是 | PasteData对象。 |
| callback | AsyncCallback&lt;void> | 是 | 回调函数。当写入成功，err为undefined，否则为错误对象。 |
**示例：**
```js
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<sup>(deprecated)</sup>
setPasteData(data: PasteData): Promise&lt;void&gt;
将数据写入系统剪贴板，使用Promise异步回调。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[setData](#setdata9-1)替代。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
| 参数名 | 类型 | 说明 |
| -------- | -------- | -------- |
| data | [PasteData](#pastedata) | PasteData对象。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
......@@ -1668,9 +1640,11 @@ clearData(): Promise&lt;void&gt;
**示例：**
```js
systemPasteboard.clearData().then((data) => {
console.info('Succeeded in clearing the pasteboard.');
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 clear the pasteboard. Cause: ' + JSON.stringify(err));
console.error('Failed to set PasteData. Cause: ' + err.message);
});
```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或