Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 ed099635 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!9011 master：pasteboard API整改优化：需同步翻译 

Merge pull request !9011 from 葛亚芳/master
上级 9a031a12 4a20194a
隐藏空白更改
内联 并排
Showing with 608 addition and 548 deletion
zh-cn/application-dev/reference/apis/js-apis-pasteboard.md
浏览文件 @ ed099635
# 剪贴板 # 剪贴板
剪贴板服务主要组件包括剪贴板管理客户端和剪贴板服务。剪贴板管理客户端负责剪贴板接口管理，提供剪贴板北向JS API给应用；在应用框架侧创建剪贴板数据、请求剪贴板SA执行剪贴板的新建、删除、查询、转换文本、配置等。剪贴板服务负责剪贴板事件管理，管理剪贴板SA的生命周期，为系统复制、粘贴功能提供支持。 本模块主要提供管理系统剪贴板的能力，为系统复制、粘贴功能提供支持。系统剪贴板支持对文本、HTML、URI、Want、PixelMap等内容的操作。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
>
> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
```js
```
import pasteboard from '@ohos.pasteboard'; import pasteboard from '@ohos.pasteboard';
``` ```
## 属性 ## 属性
**系统能力**: 以下各项对应的系统能力均为SystemCapability.MiscServices.Pasteboard。 **系统能力：** SystemCapability.MiscServices.Pasteboard
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| MAX_RECORD_NUM<sup>7+</sup> | number | 是 | 否 | 单个PasteData中所能包含的Record的数量上限。 | | MAX_RECORD_NUM<sup>7+</sup> | number | 是 | 否 | 单个PasteData中所能包含的最大条目数。 |
| MIMETYPE_TEXT_HTML<sup>7+</sup> | string | 是 | 否 | HTML&nbsp;text文本的MIME类型定义。 | | MIMETYPE_TEXT_HTML<sup>7+</sup> | string | 是 | 否 | HTML内容的MIME类型定义。 |
| MIMETYPE_TEXT_WANT<sup>7+</sup> | string | 是 | 否 | Want的MIME类型定义。 | | MIMETYPE_TEXT_WANT<sup>7+</sup> | string | 是 | 否 | Want内容的MIME类型定义。 |
| MIMETYPE_TEXT_PLAIN<sup>7+</sup> | string | 是 | 否 | Plain&nbsp;text文本的MIME类型定义。 | | MIMETYPE_TEXT_PLAIN<sup>7+</sup> | string | 是 | 否 | 纯文本内容的MIME类型定义。 |
| MIMETYPE_TEXT_URI<sup>7+</sup> | string | 是 | 否 | URI文本的MIME类型定义。 | | MIMETYPE_TEXT_URI<sup>7+</sup> | string | 是 | 否 | URI内容的MIME类型定义。 |
| MIMETYPE_PIXELMAP<sup>9+</sup> | string | 是 | 否 | PixelMap的MIME类型定义。 | | MIMETYPE_PIXELMAP<sup>9+</sup> | string | 是 | 否 | PixelMap内容的MIME类型定义。 |
## pasteboard.createPlainTextData ## pasteboard.createPlainTextData
...@@ -34,78 +32,84 @@ createPlainTextData(text:string): PasteData ...@@ -34,78 +32,84 @@ createPlainTextData(text:string): PasteData
构建一个纯文本剪贴板内容对象。 构建一个纯文本剪贴板内容对象。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| text | string | 是 | 纯文本数据。 | | text | string | 是 | 纯文本内容。 |
**返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [PasteData](#pastedata) | 包含此内容的剪贴板内容对象。 | | [PasteData](#pastedata) | 剪贴板内容对象。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createPlainTextData("content"); var pasteData = pasteboard.createPlainTextData("content");
``` ```
## pasteboard.createHtmlData<sup>7+</sup> ## pasteboard.createHtmlData<sup>7+</sup>
createHtmlData(htmlText:string): PasteData createHtmlData(htmlText:string): PasteData
构建一个html文本剪贴板内容对象。 构建一个HTML剪贴板内容对象。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| htmlText | string | 是 | 待保存的HTML文本内容。 | | htmlText | string | 是 | HTML内容。 |
**返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [PasteData](#pastedata) | 包含此内容的剪贴板内容对象。 | | [PasteData](#pastedata) | 剪贴板内容对象。 |
**示例** **示例：**
```js ```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 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 pasteData = pasteboard.createHtmlData(html);
``` ```
## pasteboard.createWantData<sup>7+</sup> ## pasteboard.createWantData<sup>7+</sup>
createWantData(want:Want): PasteData createWantData(want:Want): PasteData
构建一个want剪贴板内容对象。 构建一个Want剪贴板内容对象。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 待保存的Want内容。 | | want | [Want](js-apis-application-Want.md) | 是 | Want内容。 |
**返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [PasteData](#pastedata) | 包含此内容的剪贴板内容对象。 | | [PasteData](#pastedata) | 剪贴板内容对象。 |
**示例** **示例：**
```js ```js
var object = { var object = {
bundleName: "com.example.aafwk.test", bundleName: "com.example.aafwk.test",
abilityName: "com.example.aafwk.test.TwoAbility" abilityName: "com.example.aafwk.test.TwoAbility"
}; };
var pasteData = pasteboard.createWantData(object); var pasteData = pasteboard.createWantData(object);
``` ```
## pasteboard.createUriData<sup>7+</sup> ## pasteboard.createUriData<sup>7+</sup>
...@@ -114,23 +118,25 @@ createUriData(uri:string): PasteData ...@@ -114,23 +118,25 @@ createUriData(uri:string): PasteData
构建一个URI剪贴板内容对象。 构建一个URI剪贴板内容对象。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| uri | string | 是 | 待保存的URI内容。 | | uri | string | 是 | URI内容。 |
**返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [PasteData](#pastedata) | 包含此内容的剪贴板内容对象。 | | [PasteData](#pastedata) | 剪贴板内容对象。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createUriData("dataability:///com.example.myapplication1/user.txt"); var pasteData = pasteboard.createUriData("dataability:///com.example.myapplication1/user.txt");
``` ```
## pasteboard.createPixelMapData<sup>9+</sup> ## pasteboard.createPixelMapData<sup>9+</sup>
...@@ -139,59 +145,64 @@ createPixelMapData((pixelMap: image.PixelMap): PasteData ...@@ -139,59 +145,64 @@ createPixelMapData((pixelMap: image.PixelMap): PasteData
构建一个PixelMap剪贴板内容对象。 构建一个PixelMap剪贴板内容对象。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| pixelMap | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | 待保存的PixelMap内容。 | | pixelMap | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | PixelMap内容。 |
**返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [PasteData](#pastedata) | 包含此内容的剪贴板内容对象。 | | [PasteData](#pastedata) | 剪贴板内容对象。 |
**示例** **示例：**
```js ```js
import image from '@ohos.multimedia.image'; import image from '@ohos.multimedia.image';
var buffer = new ArrayBuffer(128)
var opt = { var buffer = new ArrayBuffer(128)
size: { height: 3, width: 5 }, var opt = {
pixelFormat: 3, size: { height: 3, width: 5 },
editable: true, pixelFormat: 3,
alphaType: 1, editable: true,
scaleMode: 1 alphaType: 1,
} scaleMode: 1
image.createPixelMap(buffer, opt).then((pixelMap) => { }
var pasteData = pasteboard.createPixelMapData(pixelMap); image.createPixelMap(buffer, opt).then((pixelMap) => {
}) var pasteData = pasteboard.createPixelMapData(pixelMap);
``` })
```
## pasteboard.createPlainTextRecord<sup>7+</sup> ## pasteboard.createPlainTextRecord<sup>7+</sup>
createPlainTextRecord(text:string): PasteDataRecord createPlainTextRecord(text:string): PasteDataRecord
创建一条文本类型的内容条目。 创建一条纯文本内容条目。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| text | string | 是 | 纯文本内容。 | | text | string | 是 | 纯文本内容。 |
**返回值** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [PasteDataRecord](#pastedatarecord7) | 一条新建的纯文本内容条目。 | | [PasteDataRecord](#pastedatarecord7) | 一条新建的纯文本内容条目。 |
**示例** **示例：**
```js ```js
var record = pasteboard.createPlainTextRecord("hello"); var record = pasteboard.createPlainTextRecord("hello");
``` ```
## pasteboard.createHtmlTextRecord<sup>7+</sup> ## pasteboard.createHtmlTextRecord<sup>7+</sup>
...@@ -200,24 +211,26 @@ createHtmlTextRecord(htmlText:string): PasteDataRecord ...@@ -200,24 +211,26 @@ createHtmlTextRecord(htmlText:string): PasteDataRecord
创建一条HTML内容的条目。 创建一条HTML内容的条目。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| htmlText | string | 是 | HTML内容。 | | htmlText | string | 是 | HTML内容。 |
**返回值** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [PasteDataRecord](#pastedatarecord7) | 一条新建的HTML内容条目。 | | [PasteDataRecord](#pastedatarecord7) | 一条新建的HTML内容条目。 |
**示例** **示例：**
```js ```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 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); var record = pasteboard.createHtmlTextRecord(html);
``` ```
## pasteboard.createWantRecord<sup>7+</sup> ## pasteboard.createWantRecord<sup>7+</sup>
...@@ -226,27 +239,29 @@ createWantRecord(want:Want): PasteDataRecord ...@@ -226,27 +239,29 @@ createWantRecord(want:Want): PasteDataRecord
创建一条Want内容条目。 创建一条Want内容条目。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | Want类型数据。 | | want | [Want](js-apis-application-Want.md) | 是 | Want内容。 |
**返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [PasteDataRecord](#pastedatarecord7) | 一条新建的Want内容条目 | | [PasteDataRecord](#pastedatarecord7) | 一条新建的Want内容条目。 |
**示例** **示例：**
```js ```js
var object = { var object = {
bundleName: "com.example.aafwk.test", bundleName: "com.example.aafwk.test",
abilityName: "com.example.aafwk.test.TwoAbility" abilityName: "com.example.aafwk.test.TwoAbility"
}; };
var record = pasteboard.createWantRecord(object); var record = pasteboard.createWantRecord(object);
``` ```
## pasteboard.createUriRecord<sup>7+</sup> ## pasteboard.createUriRecord<sup>7+</sup>
...@@ -255,66 +270,90 @@ createUriRecord(uri:string): PasteDataRecord ...@@ -255,66 +270,90 @@ createUriRecord(uri:string): PasteDataRecord
创建一条URI内容的条目。 创建一条URI内容的条目。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| uri | string | 是 | URI内容。 | | uri | string | 是 | URI内容。 |
**返回值** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [PasteDataRecord](#pastedatarecord7) | 一条新建的URI内容条目。 | | [PasteDataRecord](#pastedatarecord7) | 一条新建的URI内容条目。 |
**示例** **示例：**
```js ```js
var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt"); var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
``` ```
## pasteboard.createPixelMapRecord<sup>9+</sup> ## pasteboard.createPixelMapRecord<sup>9+</sup>
createPixelMapRecord(pixelMap:image.PixelMap): PasteDataRecord createPixelMapRecord(pixelMap:image.PixelMap): PasteDataRecord
创建一条PixelMap对象内容的条目。 创建一条PixelMap内容的条目。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| pixelMap | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | PixelMap对象内容。 | | pixelMap | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | PixelMap内容。 |
**返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [PasteDataRecord](#pastedatarecord7) | 一条新建的PixelMap对象内容条目。 | | [PasteDataRecord](#pastedatarecord7) | 一条新建的PixelMap内容条目。 |
**示例** **示例：**
```js ```js
import image from '@ohos.multimedia.image'; import image from '@ohos.multimedia.image';
var buffer = new ArrayBuffer(128)
var opt = { var buffer = new ArrayBuffer(128)
size: { height: 3, width: 5 }, var opt = {
pixelFormat: 3, size: { height: 3, width: 5 },
editable: true, pixelFormat: 3,
alphaType: 1, editable: true,
scaleMode: 1 alphaType: 1,
} scaleMode: 1
image.createPixelMap(buffer, opt).then((pixelMap) => { }
var record = pasteboard.createPixelMapRecord(pixelMap); image.createPixelMap(buffer, opt).then((pixelMap) => {
}) var record = pasteboard.createPixelMapRecord(pixelMap);
``` })
```
## pasteboard.getSystemPasteboard
getSystemPasteboard(): SystemPasteboard
获取系统剪贴板对象。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [SystemPasteboard](#systempasteboard) | 系统剪贴板对象。 |
**示例：**
```js
var systemPasteboard = pasteboard.getSystemPasteboard();
```
## ShareOption<sup>9+</sup> ## ShareOption<sup>9+</sup>
可粘贴数据的范围类型枚举。 可粘贴数据的范围类型枚举。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
| 名称 | 说明 | | 名称 | 说明 |
| ----- | ----------------------- | | ----- | ----------------------- |
...@@ -326,15 +365,15 @@ createPixelMapRecord(pixelMap:image.PixelMap): PasteDataRecord ...@@ -326,15 +365,15 @@ createPixelMapRecord(pixelMap:image.PixelMap): PasteDataRecord
定义了剪贴板中所有内容条目的属性，包含时间戳、数据类型、粘贴范围以及一些附加数据等。 定义了剪贴板中所有内容条目的属性，包含时间戳、数据类型、粘贴范围以及一些附加数据等。
**系统能力**: 以下各项对应的系统能力均为SystemCapability.MiscServices.Pasteboard。 **系统能力：** SystemCapability.MiscServices.Pasteboard
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| additions<sup>7+</sup> | {[key:&nbsp;string]:&nbsp;object} | 是 | 是 | 设置的其他附加属性数据。 | | additions<sup>7+</sup> | {[key:string]:object} | 是 | 是 | 设置的其他附加属性数据。 |
| mimeTypes<sup>7+</sup> | Array&lt;string&gt; | 是 | 否 | 剪贴板内容条目的数据类型,&nbsp;非重复的类型列表。 | | mimeTypes<sup>7+</sup> | Array&lt;string&gt; | 是 | 否 | 剪贴板内容条目的数据类型，非重复的类型列表。 |
| tag<sup>7+</sup> | string | 是 | 是 | 用户自定义标签。 | | tag<sup>7+</sup> | string | 是 | 是 | 用户自定义标签。 |
| timestamp<sup>7+</sup> | number | 是 | 否 | 剪贴板数据的写入时间戳（毫秒）。 | | timestamp<sup>7+</sup> | number | 是 | 否 | 剪贴板数据的写入时间戳（单位：ms）。 |
| localOnly<sup>7+</sup> | boolean | 是 | 是 | 配置剪贴板内容的“仅在本地”标志位。<br/>-&nbsp;默认情况为true。<br/>-&nbsp;配置为true时，表示内容仅在本地，不会在设备之间传递。<br/>-&nbsp;配置为false时，表示内容将在设备间传递。 | | localOnly<sup>7+</sup> | boolean | 是 | 是 | 配置剪贴板内容是否为“仅在本地”。默认值为true。<br/>- 配置为true时，表示内容仅在本地，不会在设备之间传递。<br/>- 配置为false时，表示内容将在设备间传递。 |
| shareOption<sup>9+</sup> | [ShareOption](#shareoption9) | 是 | 是 | 指示剪贴板数据可以粘贴到的范围。 | | shareOption<sup>9+</sup> | [ShareOption](#shareoption9) | 是 | 是 | 指示剪贴板数据可以粘贴到的范围。 |
...@@ -345,14 +384,14 @@ createPixelMapRecord(pixelMap:image.PixelMap): PasteDataRecord ...@@ -345,14 +384,14 @@ createPixelMapRecord(pixelMap:image.PixelMap): PasteDataRecord
### 属性 ### 属性
**系统能力**: 以下各项对应的系统能力均为SystemCapability.MiscServices.Pasteboard。 **系统能力：** SystemCapability.MiscServices.Pasteboard
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| htmlText<sup>7+</sup> | string | 是 | 否 | HTML文本内容。 | | htmlText<sup>7+</sup> | string | 是 | 否 | HTML内容。 |
| want<sup>7+</sup> | [Want](js-apis-application-Want.md) | 是 | 否 | Want文本内容。 | | want<sup>7+</sup> | [Want](js-apis-application-Want.md) | 是 | 否 | Want内容。 |
| mimeType<sup>7+</sup> | string | 是 | 否 | 数据类型。 | | mimeType<sup>7+</sup> | string | 是 | 否 | 数据类型。 |
| plainText<sup>7+</sup> | string | 是 | 否 | 文本内容。 | | plainText<sup>7+</sup> | string | 是 | 否 | 纯文本内容。 |
| uri<sup>7+</sup> | string | 是 | 否 | URI内容。 | | uri<sup>7+</sup> | string | 是 | 否 | URI内容。 |
| pixelMap<sup>9+</sup> | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | 否 | PixelMap内容。 | | pixelMap<sup>9+</sup> | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | 否 | PixelMap内容。 |
...@@ -361,59 +400,63 @@ createPixelMapRecord(pixelMap:image.PixelMap): PasteDataRecord ...@@ -361,59 +400,63 @@ createPixelMapRecord(pixelMap:image.PixelMap): PasteDataRecord
convertToText(): Promise&lt;string&gt; convertToText(): Promise&lt;string&gt;
实例方法，将一个PasteData中的内容强制转换为文本内容，并使用Promise异步方式返回结果。 将一个PasteData中的内容强制转换为文本内容，使用Promise异步回调。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | 异步回调函数，调用成功则返回强制转换的文本内容，调用失败则返回error信息。 | | Promise&lt;string&gt; | Promise对象，返回强制转换的文本内容。 |
**示例** **示例：**
```js ```js
var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt"); var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
record.convertToText().then((data) => { record.convertToText().then((data) => {
console.info('convertToText success data : ' + JSON.stringify(data)); console.info('Succeeded in converting to text. Data: ' + JSON.stringify(data));
}).catch((error) => { }).catch((err) => {
console.error('convertToText failed because ' + JSON.stringify(error)); console.error('Failed to convert to text. Cause: ' + JSON.stringify(err));
}); });
``` ```
### convertToText<sup>7+</sup> ### convertToText<sup>7+</sup>
convertToText(callback: AsyncCallback&lt;string&gt;): void convertToText(callback: AsyncCallback&lt;string&gt;): void
实例方法，将一个PasteData中的内容强制转换为文本内容，并使用callback方式返回结果。 将一个PasteData中的内容强制转换为文本内容，使用callback异步回调。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数，调用成功则返回强制转换的文本内容，调用失败则返回error信息。 | | callback | AsyncCallback&lt;string&gt; | 是 | 回调函数，当转换成功，err为undefined，data为强制转换的文本内容；否则返回错误信息。 |
**示例** **示例：**
```js ```js
var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt"); var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
record.convertToText((err, data) => { record.convertToText((err, data) => {
if (err) { if (err) {
console.error('convertToText failed because ' + JSON.stringify(err)); console.error('Failed to convert to text. Cause: ' + JSON.stringify(err));
return; return;
} }
console.info('convertToText success data : ' + JSON.stringify(data)); console.info('Succeeded in converting to text. Data: ' + JSON.stringify(data));
}); });
``` ```
## PasteData ## PasteData
剪贴板内容对象。
在调用PasteData的接口前，需要先获取一个PasteData对象。 在调用PasteData的接口前，需要先获取一个PasteData对象。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
### getPrimaryText ### getPrimaryText
...@@ -424,42 +467,44 @@ getPrimaryText(): string ...@@ -424,42 +467,44 @@ getPrimaryText(): string
获取首个条目的纯文本内容。 获取首个条目的纯文本内容。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**返回值** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| string | 纯文本内容。 | | string | 纯文本内容。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createPlainTextData("hello"); var pasteData = pasteboard.createPlainTextData("hello");
var plainText = pasteData.getPrimaryText(); var plainText = pasteData.getPrimaryText();
``` ```
### getPrimaryHtml<sup>7+</sup> ### getPrimaryHtml<sup>7+</sup>
getPrimaryHtml(): string getPrimaryHtml(): string
获取首个条目的HTML文本内容。 获取首个条目的HTML内容。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| string | HTML文本数据。 | | string | HTML内容。 |
**示例** **示例：**
```js ```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 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 pasteData = pasteboard.createHtmlData(html);
var htmlText = pasteData.getPrimaryHtml(); var htmlText = pasteData.getPrimaryHtml();
``` ```
### getPrimaryWant<sup>7+</sup> ### getPrimaryWant<sup>7+</sup>
...@@ -468,77 +513,80 @@ getPrimaryWant(): Want ...@@ -468,77 +513,80 @@ getPrimaryWant(): Want
获取首个条目的Want对象内容。 获取首个条目的Want对象内容。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [Want](js-apis-application-Want.md) | Want对象内容。 | | [Want](js-apis-application-Want.md) | Want对象内容。 |
**示例** **示例：**
```js ```js
var object = { var object = {
bundleName: "com.example.aafwk.test", bundleName: "com.example.aafwk.test",
abilityName: "com.example.aafwk.test.TwoAbility" abilityName: "com.example.aafwk.test.TwoAbility"
}; };
var pasteData = pasteboard.createWantData(object); var pasteData = pasteboard.createWantData(object);
var want = pasteData.getPrimaryWant(); var want = pasteData.getPrimaryWant();
``` ```
### getPrimaryUri<sup>7+</sup> ### getPrimaryUri<sup>7+</sup>
getPrimaryUri(): string getPrimaryUri(): string
获取首个条目的URI文本内容。 获取首个条目的URI内容。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| string | URI文本内容。 | | string | URI内容。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createUriData("dataability:///com.example.myapplication1/user.txt"); var pasteData = pasteboard.createUriData("dataability:///com.example.myapplication1/user.txt");
var uri = pasteData.getPrimaryUri(); var uri = pasteData.getPrimaryUri();
``` ```
### getPrimaryPixelMap<sup>9+</sup> ### getPrimaryPixelMap<sup>9+</sup>
getPrimaryPixelMap(): image.PixelMap getPrimaryPixelMap(): image.PixelMap
获取首个条目的PixelMap对象内容。 获取首个条目的PixelMap内容。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [image.PixelMap](js-apis-image.md#pixelmap7) | PixelMap对象内容。 | | [image.PixelMap](js-apis-image.md#pixelmap7) | PixelMap内容。 |
**示例** **示例：**
```js ```js
import image from '@ohos.multimedia.image'; import image from '@ohos.multimedia.image';
var buffer = new ArrayBuffer(128) var buffer = new ArrayBuffer(128)
var opt = { var opt = {
size: { height: 3, width: 5 }, size: { height: 3, width: 5 },
pixelFormat: 3, pixelFormat: 3,
editable: true, editable: true,
alphaType: 1, alphaType: 1,
scaleMode: 1 scaleMode: 1
} }
image.createPixelMap(buffer, opt).then((pixelMap) => { image.createPixelMap(buffer, opt).then((pixelMap) => {
var pasteData = pasteboard.createPixelMapData(pixelMap); var pasteData = pasteboard.createPixelMapData(pixelMap);
var pixelMap = pasteData.getPrimaryPixelMap(); var pixelMap = pasteData.getPrimaryPixelMap();
}) })
``` ```
### addTextRecord<sup>7+</sup> ### addTextRecord<sup>7+</sup>
...@@ -549,43 +597,45 @@ addTextRecord(text: string): void ...@@ -549,43 +597,45 @@ addTextRecord(text: string): void
剪贴板内容中添加的条目达到数量上限128后，后续的添加操作无效。 剪贴板内容中添加的条目达到数量上限128后，后续的添加操作无效。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| text | string | 是 | 纯文本内容。 | | text | string | 是 | 纯文本内容。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createPlainTextData("hello"); var pasteData = pasteboard.createPlainTextData("hello");
pasteData.addTextRecord("good"); pasteData.addTextRecord("good");
``` ```
### addHtmlRecord<sup>7+</sup> ### addHtmlRecord<sup>7+</sup>
addHtmlRecord(htmlText: string): void addHtmlRecord(htmlText: string): void
向当前剪贴板内容中添加一条HTML文本条目，并将MIMETYPE_TEXT_HTML添加到[PasteDataProperty](#pastedataproperty7)的mimeTypes中。入参均不能为空，否则添加失败。 向当前剪贴板内容中添加一条HTML内容条目，并将MIMETYPE_TEXT_HTML添加到[PasteDataProperty](#pastedataproperty7)的mimeTypes中。入参均不能为空，否则添加失败。
剪贴板内容中添加的条目达到数量上限128后，后续的添加操作无效。 剪贴板内容中添加的条目达到数量上限128后，后续的添加操作无效。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| htmlText | string | 是 | HTML格式的文本内容。 | | htmlText | string | 是 | HTML内容。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createPlainTextData("hello"); 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>"; 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); pasteData.addHtmlRecord(html);
``` ```
### addWantRecord<sup>7+</sup> ### addWantRecord<sup>7+</sup>
...@@ -596,23 +646,24 @@ addWantRecord(want: Want): void ...@@ -596,23 +646,24 @@ addWantRecord(want: Want): void
剪贴板内容中添加的条目达到数量上限128后，后续的添加操作无效。 剪贴板内容中添加的条目达到数量上限128后，后续的添加操作无效。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | Want对象内容。 | | want | [Want](js-apis-application-Want.md) | 是 | Want对象内容。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createPlainTextData("hello"); var pasteData = pasteboard.createPlainTextData("hello");
var object = { var object = {
bundleName: "com.example.aafwk.test", bundleName: "com.example.aafwk.test",
abilityName: "com.example.aafwk.test.TwoAbility" abilityName: "com.example.aafwk.test.TwoAbility"
}; };
pasteData.addWantRecord(object); pasteData.addWantRecord(object);
``` ```
### addUriRecord<sup>7+</sup> ### addUriRecord<sup>7+</sup>
...@@ -623,19 +674,20 @@ addUriRecord(uri: string): void ...@@ -623,19 +674,20 @@ addUriRecord(uri: string): void
剪贴板内容中添加的条目达到数量上限128后，后续的添加操作无效。 剪贴板内容中添加的条目达到数量上限128后，后续的添加操作无效。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| uri | string | 是 | URI文本内容。 | | uri | string | 是 | URI内容。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createPlainTextData("hello"); var pasteData = pasteboard.createPlainTextData("hello");
pasteData.addUriRecord("dataability:///com.example.myapplication1/user.txt"); pasteData.addUriRecord("dataability:///com.example.myapplication1/user.txt");
``` ```
### addPixelMapRecord<sup>9+</sup> ### addPixelMapRecord<sup>9+</sup>
...@@ -645,29 +697,31 @@ addPixelMapRecord(pixelMap: image.PixelMap): void ...@@ -645,29 +697,31 @@ addPixelMapRecord(pixelMap: image.PixelMap): void
剪贴板内容中添加的条目达到数量上限512后，后续的添加操作无效。 剪贴板内容中添加的条目达到数量上限512后，后续的添加操作无效。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| pixelMap | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | PixelMap对象内容。 | | pixelMap | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | PixelMap内容。 |
**示例** **示例：**
```js ```js
import image from '@ohos.multimedia.image'; import image from '@ohos.multimedia.image';
var buffer = new ArrayBuffer(128)
var opt = { var buffer = new ArrayBuffer(128)
size: { height: 3, width: 5 }, var opt = {
pixelFormat: 3, size: { height: 3, width: 5 },
editable: true, pixelFormat: 3,
alphaType: 1, editable: true,
scaleMode: 1 alphaType: 1,
} scaleMode: 1
image.createPixelMap(buffer, opt).then((pixelMap) => { }
var record = pasteboard.createPlainTextData("hello").addPixelMapRecord(pixelMap); image.createPixelMap(buffer, opt).then((pixelMap) => {
}) var record = pasteboard.createPlainTextData("hello").addPixelMapRecord(pixelMap);
``` })
```
### addRecord<sup>7+</sup> ### addRecord<sup>7+</sup>
...@@ -678,23 +732,24 @@ addRecord(record: PasteDataRecord): void ...@@ -678,23 +732,24 @@ addRecord(record: PasteDataRecord): void
剪贴板内容中添加的条目达到数量上限128后，后续的添加操作无效。 剪贴板内容中添加的条目达到数量上限128后，后续的添加操作无效。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| record | [PasteDataRecord](#pastedatarecord7) | 是 | 待添加的条目。 | | record | [PasteDataRecord](#pastedatarecord7) | 是 | 待添加的条目。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createUriData("dataability:///com.example.myapplication1/user.txt"); var pasteData = pasteboard.createUriData("dataability:///com.example.myapplication1/user.txt");
var textRecord = pasteboard.createPlainTextRecord("hello"); 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 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); var htmlRecord = pasteboard.createHtmlTextRecord(html);
pasteData.addRecord(textRecord); pasteData.addRecord(textRecord);
pasteData.addRecord(htmlRecord); pasteData.addRecord(htmlRecord);
``` ```
### getMimeTypes<sup>7+</sup> ### getMimeTypes<sup>7+</sup>
...@@ -703,259 +758,254 @@ getMimeTypes(): Array&lt;string&gt; ...@@ -703,259 +758,254 @@ getMimeTypes(): Array&lt;string&gt;
获取剪贴板中[PasteDataProperty](#pastedataproperty7)的mimeTypes列表，当剪贴板内容为空时，返回列表为空。 获取剪贴板中[PasteDataProperty](#pastedataproperty7)的mimeTypes列表，当剪贴板内容为空时，返回列表为空。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Array&lt;string&gt; | 非重复的类型列表。 | | Array&lt;string&gt; | 剪贴板内容条目的数据类型，非重复的类型列表。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createPlainTextData("hello"); var pasteData = pasteboard.createPlainTextData("hello");
var types = pasteData.getMimeTypes(); var types = pasteData.getMimeTypes();
``` ```
### getPrimaryMimeType<sup>7+</sup> ### getPrimaryMimeType<sup>7+</sup>
getPrimaryMimeType(): string getPrimaryMimeType(): string
获取首个条目的数据类型。 获取剪贴板内容中首个条目的数据类型。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| string | 首个条目的数据类型。 | | string | 首个条目的数据类型。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createPlainTextData("hello"); var pasteData = pasteboard.createPlainTextData("hello");
var type = pasteData.getPrimaryMimeType(); var type = pasteData.getPrimaryMimeType();
``` ```
### getProperty<sup>7+</sup> ### getProperty<sup>7+</sup>
getProperty(): PasteDataProperty getProperty(): PasteDataProperty
获取属性描述对象。 获取剪贴板内容的属性描述对象。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [PasteDataProperty](#pastedataproperty7) | 属性描述对象。 | | [PasteDataProperty](#pastedataproperty7) | 属性描述对象。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createPlainTextData("hello"); var pasteData = pasteboard.createPlainTextData("hello");
var property = pasteData.getProperty(); var property = pasteData.getProperty();
``` ```
### setProperty<sup>9+</sup> ### setProperty<sup>9+</sup>
setProperty(property: PasteDataProperty): void setProperty(property: PasteDataProperty): void
设置属性描述对象，当前仅支持设置shareOption属性。 设置剪贴板内容的属性描述对象，当前仅支持设置shareOption属性。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| property | [PasteDataProperty](#pastedataproperty7) | 是 | 属性描述对象。 | | property | [PasteDataProperty](#pastedataproperty7) | 是 | 属性描述对象。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createHtmlData('application/xml'); var pasteData = pasteboard.createHtmlData('application/xml');
let prop = pasteData.getProperty(); let prop = pasteData.getProperty();
prop.shareOption = pasteboard.ShareOption.InApp; prop.shareOption = pasteboard.ShareOption.InApp;
pasteData.setProperty(prop); pasteData.setProperty(prop);
``` ```
### getRecordAt<sup>7+</sup> ### getRecordAt<sup>7+</sup>
getRecordAt(index: number): PasteDataRecord getRecordAt(index: number): PasteDataRecord
获取指定下标的条目。 获取剪贴板内容中指定下标的条目。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| index | number | 是 | 指定条目的下标。 | | index | number | 是 | 指定条目的下标。 |
**返回值** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [PasteDataRecord](#pastedatarecord7) | 指定下标的条目。 | | [PasteDataRecord](#pastedatarecord7) | 指定下标的条目。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createPlainTextData("hello"); var pasteData = pasteboard.createPlainTextData("hello");
var record = pasteData.getRecordAt(0); var record = pasteData.getRecordAt(0);
``` ```
### getRecordCount<sup>7+</sup> ### getRecordCount<sup>7+</sup>
getRecordCount(): number getRecordCount(): number
获取剪贴板中条目的个数。 获取剪贴板内容中条目的个数。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| number | 条目的个数。 | | number | 条目的个数。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createPlainTextData("hello"); var pasteData = pasteboard.createPlainTextData("hello");
var count = pasteData.getRecordCount(); var count = pasteData.getRecordCount();
``` ```
### getTag<sup>7+</sup> ### getTag<sup>7+</sup>
getTag(): string getTag(): string
获取用户自定义的标签内容，如果没有设置用户自定义的标签内容将返回空。 获取剪贴板内容中用户自定义的标签内容，如果没有设置用户自定义的标签内容将返回空。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| string | 获取用户自定义的标签内容，如果没有设置用户自定义的标签内容将返回空。 | | string | 返回用户自定义的标签内容，如果没有设置用户自定义的标签内容，将返回空。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createPlainTextData("hello"); var pasteData = pasteboard.createPlainTextData("hello");
var tag = pasteData.getTag(); var tag = pasteData.getTag();
``` ```
### hasMimeType<sup>7+</sup> ### hasMimeType<sup>7+</sup>
hasMimeType(mimeType: string): boolean hasMimeType(mimeType: string): boolean
检查内容中是否有指定的数据类型。 检查剪贴板内容中是否有指定的数据类型。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| mimeType | string | 是 | 待查询的数据类型。 | | mimeType | string | 是 | 待查询的数据类型。 |
**返回值** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| boolean | 有指定的数据类型返回true，否则返回false。 | | boolean | 有指定的数据类型返回true，否则返回false。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createPlainTextData("hello"); var pasteData = pasteboard.createPlainTextData("hello");
var hasType = pasteData.hasMimeType(pasteboard.MIMETYPE_TEXT_PLAIN); var hasType = pasteData.hasMimeType(pasteboard.MIMETYPE_TEXT_PLAIN);
``` ```
### removeRecordAt<sup>7+</sup> ### removeRecordAt<sup>7+</sup>
removeRecordAt(index: number): boolean removeRecordAt(index: number): boolean
移除指定下标的条目。 移除剪贴板内容中指定下标的条目。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| index | number | 是 | 指定的下标。 | | index | number | 是 | 指定的下标。 |
**返回值** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| boolean | 成功移除返回true，失败返回false。 | | boolean | 成功移除返回true，失败返回false。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createPlainTextData("hello"); var pasteData = pasteboard.createPlainTextData("hello");
var isRemove = pasteData.removeRecordAt(0); var isRemove = pasteData.removeRecordAt(0);
``` ```
### replaceRecordAt<sup>7+</sup> ### replaceRecordAt<sup>7+</sup>
replaceRecordAt(index: number, record: PasteDataRecord): boolean replaceRecordAt(index: number, record: PasteDataRecord): boolean
替换指定下标的条目。 替换剪贴板内容中指定下标的条目。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| index | number | 是 | 指定的下标。 | | index | number | 是 | 指定的下标。 |
| record | [PasteDataRecord](#pastedatarecord7) | 是 | 替换后的条目。 | | record | [PasteDataRecord](#pastedatarecord7) | 是 | 替换后的条目。 |
**返回值** **返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 成功替换返回true，失败返回false。 |
**示例**
```js
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
获取系统剪切板。
**系统能力**: SystemCapability.MiscServices.Pasteboard
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [SystemPasteboard](#systempasteboard) | 系统剪切板对象。 | | boolean | 成功替换返回true，失败返回false。 |
**示例**
```js **示例：**
var systemPasteboard = pasteboard.getSystemPasteboard();
```
```js
var pasteData = pasteboard.createPlainTextData("hello");
var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
var isReplace = pasteData.replaceRecordAt(0, record);
```
## SystemPasteboard ## SystemPasteboard
在调用SystemPasteboard的接口前，需要先通过[getSystemPasteboard](#pasteboardgetsystempasteboard)获取系统剪切板。 系统剪贴板对象。
``` 在调用SystemPasteboard的接口前，需要先通过[getSystemPasteboard](#pasteboardgetsystempasteboard)获取系统剪贴板。
```js
var systemPasteboard = pasteboard.getSystemPasteboard(); var systemPasteboard = pasteboard.getSystemPasteboard();
``` ```
...@@ -964,112 +1014,117 @@ var systemPasteboard = pasteboard.getSystemPasteboard(); ...@@ -964,112 +1014,117 @@ var systemPasteboard = pasteboard.getSystemPasteboard();
setPasteData(data:PasteData, callback:AsyncCallback&lt;void&gt;): void setPasteData(data:PasteData, callback:AsyncCallback&lt;void&gt;): void
将数据写入系统剪切板，并使用callback方式返回结果。 将数据写入系统剪贴板，使用callback异步回调。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| data | [PasteData](#pastedata) | 是 | PasteData对象。 | | data | [PasteData](#pastedata) | 是 | PasteData对象。 |
| callback | AsyncCallback&lt;void> | 是 | 回调函数，表示是否成功将数据写入系统剪切板。 | | callback | AsyncCallback&lt;void> | 是 | 回调函数。当写入成功，err为undefined，否则为错误对象。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createPlainTextData("content"); var pasteData = pasteboard.createPlainTextData("content");
var systemPasteboard = pasteboard.getSystemPasteboard(); var systemPasteboard = pasteboard.getSystemPasteboard();
systemPasteboard.setPasteData(pasteData, (error, data) => { systemPasteboard.setPasteData(pasteData, (err, data) => {
if (error) { if (err) {
console.error('Failed to setPasteData. Cause: ' + error.message); console.error('Failed to set PasteData. Cause: ' + err.message);
return; return;
} }
console.info('setPasteData successfully.'); console.info('Succeeded in setting PasteData.');
}); });
``` ```
### setPasteData ### setPasteData
setPasteData(data:PasteData): Promise&lt;void&gt; setPasteData(data:PasteData): Promise&lt;void&gt;
将数据写入系统剪切板，并使用Promise异步方式返回结果。 将数据写入系统剪贴板，使用Promise异步回调。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
**参数**
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| data | [PasteData](#pastedata) | PasteData对象。 | | data | [PasteData](#pastedata) | PasteData对象。 |
**返回值** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | 异步回调函数，表示是否成功将数据写入系统剪切板。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例** **示例：**
```js ```js
var pasteData = pasteboard.createPlainTextData("content"); var pasteData = pasteboard.createPlainTextData("content");
var systemPasteboard = pasteboard.getSystemPasteboard(); var systemPasteboard = pasteboard.getSystemPasteboard();
systemPasteboard.setPasteData(pasteData).then((data) => { systemPasteboard.setPasteData(pasteData).then((data) => {
console.info('setPasteData success.'); console.info('Succeeded in setting PasteData.');
}).catch((error) => { }).catch((err) => {
console.error('Failed to setPasteData. Cause: ' + error.message); console.error('Failed to set PasteData. Cause: ' + err.message);
}); });
``` ```
### getPasteData ### getPasteData
getPasteData( callback:AsyncCallback&lt;PasteData&gt;): void getPasteData( callback:AsyncCallback&lt;PasteData&gt;): void
读取系统剪切板内容，并使用callback方式返回结果。 读取系统剪贴板内容，使用callback异步回调。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[PasteData](#pastedata)&gt; | 是 | 回调函数，返回系统剪切板数据。 | | callback | AsyncCallback&lt;[PasteData](#pastedata)&gt; | 是 | 回调函数。当读取成功，err为undefined，data为返回的系统剪贴板数据；否则返回错误对象。 |
**示例** **示例：**
```js ```js
var systemPasteboard = pasteboard.getSystemPasteboard(); var systemPasteboard = pasteboard.getSystemPasteboard();
systemPasteboard.getPasteData((error, pasteData) => { systemPasteboard.getPasteData((err, pasteData) => {
if (error) { if (err) {
console.error('Failed to getPasteData. Cause: ' + error.message); console.error('Failed to get PasteData. Cause: ' + err.message);
return; return;
} }
var text = pasteData.getPrimaryText(); var text = pasteData.getPrimaryText();
}); });
``` ```
### getPasteData ### getPasteData
getPasteData(): Promise&lt;PasteData&gt; getPasteData(): Promise&lt;PasteData&gt;
读取系统剪切板内容，并使用Promise异步方式返回结果。 读取系统剪贴板内容，使用Promise异步回调。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;[PasteData](#pastedata)&gt; | 异步回调函数，调返回系统剪切板数据。 | | Promise&lt;[PasteData](#pastedata)&gt; | Promise对象，返回系统剪贴板数据。 |
**示例** **示例：**
```js ```js
var systemPasteboard = pasteboard.getSystemPasteboard(); var systemPasteboard = pasteboard.getSystemPasteboard();
systemPasteboard.getPasteData().then((pasteData) => { systemPasteboard.getPasteData().then((pasteData) => {
var text = pasteData.getPrimaryText(); var text = pasteData.getPrimaryText();
}).catch((error) => { }).catch((err) => {
console.error('Failed to getPasteData. Cause: ' + error.message); console.error('Failed to get PasteData. Cause: ' + err.message);
}) })
``` ```
### on('update')<sup>7+</sup> ### on('update')<sup>7+</sup>
...@@ -1078,23 +1133,24 @@ on(type: 'update', callback: () =&gt;void ): void ...@@ -1078,23 +1133,24 @@ on(type: 'update', callback: () =&gt;void ): void
订阅系统剪贴板内容变化事件，当系统剪贴板中内容变化时触发用户程序的回调。 订阅系统剪贴板内容变化事件，当系统剪贴板中内容变化时触发用户程序的回调。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 取值为'update'，表示系统剪贴板内容变化事件。 | | type | string | 是 | 取值为'update'，表示系统剪贴板内容变化事件。 |
| callback | function | 是 | 剪贴板中内容变化时触发的用户程序的回调。 | | callback | function | 是 | 剪贴板中内容变化时触发的用户程序的回调。 |
**示例** **示例：**
```js ```js
var systemPasteboard = pasteboard.getSystemPasteboard(); var systemPasteboard = pasteboard.getSystemPasteboard();
var listener = () => { var listener = () => {
console.info('The system pasteboard has changed'); console.info('The system pasteboard has changed.');
}; };
systemPasteboard.on('update', listener); systemPasteboard.on('update', listener);
``` ```
### off('update')<sup>7+</sup> ### off('update')<sup>7+</sup>
...@@ -1103,120 +1159,124 @@ off(type: 'update', callback?: () =&gt;void ): void ...@@ -1103,120 +1159,124 @@ off(type: 'update', callback?: () =&gt;void ): void
取消订阅系统剪贴板内容变化事件。 取消订阅系统剪贴板内容变化事件。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 取值为'update'，表示系统剪贴板内容变化事件。 | | type | string | 是 | 取值为'update'，表示系统剪贴板内容变化事件。 |
| callback | function | 否 | 剪贴板中内容变化时触发的用户程序的回调。 | | callback | function | 否 | 剪贴板中内容变化时触发的用户程序的回调。 |
**示例** **示例：**
```js ```js
let listener = () => { let listener = () => {
console.info('The system pasteboard has changed'); console.info('The system pasteboard has changed.');
}; };
systemPasteboard.off('update', listener); systemPasteboard.off('update', listener);
``` ```
### hasPasteData<sup>7+</sup> ### hasPasteData<sup>7+</sup>
hasPasteData(callback: AsyncCallback&lt;boolean&gt;): void hasPasteData(callback: AsyncCallback&lt;boolean&gt;): void
判断系统剪切板中是否有内容，并使用callback异步方式返回结果。 判断系统剪贴板中是否有内容，使用callback异步回调。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 返回为true表示系统剪切板中有内容，返回false表示系统剪切板中没有内容。 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 返回true表示系统剪贴板中有内容，返回false表示系统剪贴板中没有内容。 |
**示例** **示例：**
```js ```js
systemPasteboard.hasPasteData((err, data) => { systemPasteboard.hasPasteData((err, data) => {
if (err) { if (err) {
console.error('failed to hasPasteData because ' + JSON.stringify(err)); console.error('Failed to check the PasteData. Cause: ' + JSON.stringify(err));
return; return;
} }
console.info('success hasPasteData : ' + JSON.stringify(data)); console.info('Succeeded in checking the PasteData. Data: ' + JSON.stringify(data));
}); });
``` ```
### hasPasteData<sup>7+</sup> ### hasPasteData<sup>7+</sup>
hasPasteData(): Promise&lt;boolean&gt; hasPasteData(): Promise&lt;boolean&gt;
判断系统剪切板中是否有内容，并使用Promise异步方式返回结果。 判断系统剪贴板中是否有内容，使用Promise异步回调。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **返回值：**
**返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;boolean&gt; | 返回为true表示系统剪切板中有内容，返回false表示系统剪切板中没有内容。 | | Promise&lt;boolean&gt; | 返回true表示系统剪贴板中有内容，返回false表示系统剪贴板中没有内容。 |
**示例** **示例：**
```js ```js
systemPasteboard.hasPasteData().then((data) => { systemPasteboard.hasPasteData().then((data) => {
console.info('success hasPasteData : ' + JSON.stringify(data)); console.info('Succeeded in checking the PasteData. Data: ' + JSON.stringify(data));
}).catch((error) => { }).catch((err) => {
console.error('failed to hasPasteData because ' + JSON.stringify(error)); console.error('Failed to check the PasteData. Cause: ' + JSON.stringify(err));
}); });
``` ```
### clear<sup>7+</sup> ### clear<sup>7+</sup>
clear(callback: AsyncCallback&lt;void&gt;): void clear(callback: AsyncCallback&lt;void&gt;): void
清空系统剪切板内容，并使用callback异步方式返回结果。 清空系统剪贴板内容，使用callback异步回调。
**系统能力：** SystemCapability.MiscServices.Pasteboard
**系统能力**: SystemCapability.MiscServices.Pasteboard **参数：**
**参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，表示是否成功清空系统剪切板内容。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当成功清空时，err为undefined；否则为错误对象。 |
**示例** **示例：**
```js ```js
systemPasteboard.clear((err, data) => { systemPasteboard.clear((err, data) => {
if (err) { if (err) {
console.error('failed to clear because ' + JSON.stringify(err)); console.error('Failed to clear the PasteData. Cause: ' + JSON.stringify(err));
return; return;
} }
console.info('success clear'); console.info('Succeeded in clearing the PasteData.');
}); });
``` ```
### clear<sup>7+</sup> ### clear<sup>7+</sup>
clear(): Promise&lt;void&gt; clear(): Promise&lt;void&gt;
清空系统剪切板内容，并使用Promise异步方式返回结果。 清空系统剪贴板内容，使用Promise异步回调。
**系统能力**: SystemCapability.MiscServices.Pasteboard **系统能力：** SystemCapability.MiscServices.Pasteboard
**返回值** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | 异步回调函数，表示是否成功清空系统剪切板内容。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例** **示例：**
```js ```js
systemPasteboard.clear().then((data) => { systemPasteboard.clear().then((data) => {
console.info('success clear'); console.info('Succeeded in clearing the PasteData.');
}).catch((error) => { }).catch((err) => {
console.error('failed to clear because ' + JSON.stringify(error)); console.error('Failed to clear the PasteData. Cause: ' + JSON.stringify(err));
}); });
``` ```
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或