diff --git a/zh-cn/application-dev/reference/apis/js-apis-pasteboard.md b/zh-cn/application-dev/reference/apis/js-apis-pasteboard.md
index c28402c720e5f23a21fded716afaaa291603cee2..9531a1a5e060fae8ccb131785ecdef4de9a22898 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-pasteboard.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-pasteboard.md
@@ -1,31 +1,29 @@
# 剪贴板
- 剪贴板服务主要组件包括剪贴板管理客户端和剪贴板服务。剪贴板管理客户端负责剪贴板接口管理,提供剪贴板北向JS API给应用;在应用框架侧创建剪贴板数据、请求剪贴板SA执行剪贴板的新建、删除、查询、转换文本、配置等。剪贴板服务负责剪贴板事件管理,管理剪贴板SA的生命周期,为系统复制、粘贴功能提供支持。
+本模块主要提供管理系统剪贴板的能力,为系统复制、粘贴功能提供支持。系统剪贴板支持对文本、HTML、URI、Want等内容的操作。
-> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
+> **说明:**
+>
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
-
## 导入模块
-
-```
+```js
import pasteboard from '@ohos.pasteboard';
```
-
## 属性
-**系统能力**: 以下各项对应的系统能力均为SystemCapability.MiscServices.Pasteboard。
+**系统能力:** SystemCapability.MiscServices.Pasteboard
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
-| MAX_RECORD_NUM7+ | number | 是 | 否 | 单个PasteData中所能包含的Record的数量上限。 |
-| MIMETYPE_TEXT_HTML7+ | string | 是 | 否 | HTML text文本的MIME类型定义。 |
-| MIMETYPE_TEXT_WANT7+ | string | 是 | 否 | Want的MIME类型定义。 |
-| MIMETYPE_TEXT_PLAIN7+ | string | 是 | 否 | Plain text文本的MIME类型定义。 |
-| MIMETYPE_TEXT_URI7+ | string | 是 | 否 | URI文本的MIME类型定义。 |
-| MIMETYPE_PIXELMAP9+ | string | 是 | 否 | PixelMap的MIME类型定义。 |
+| MAX_RECORD_NUM7+ | number | 是 | 否 | 单个PasteData中所能包含的最大条目数。 |
+| MIMETYPE_TEXT_HTML7+ | string | 是 | 否 | HTML内容的MIME类型定义。 |
+| MIMETYPE_TEXT_WANT7+ | string | 是 | 否 | Want内容的MIME类型定义。 |
+| MIMETYPE_TEXT_PLAIN7+ | string | 是 | 否 | 纯文本内容的MIME类型定义。 |
+| MIMETYPE_TEXT_URI7+ | string | 是 | 否 | URI内容的MIME类型定义。 |
+| MIMETYPE_PIXELMAP9+ | string | 是 | 否 | PixelMap内容的MIME类型定义。 |
## pasteboard.createPlainTextData
@@ -34,78 +32,84 @@ createPlainTextData(text:string): PasteData
构建一个纯文本剪贴板内容对象。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
-| text | string | 是 | 纯文本数据。 |
+| text | string | 是 | 纯文本内容。 |
+
+**返回值:**
-**返回值**
| 类型 | 说明 |
| -------- | -------- |
-| [PasteData](#pastedata) | 包含此内容的剪贴板内容对象。 |
+| [PasteData](#pastedata) | 剪贴板内容对象。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createPlainTextData("content");
- ```
+```js
+var pasteData = pasteboard.createPlainTextData("content");
+```
## pasteboard.createHtmlData7+
createHtmlData(htmlText:string): PasteData
-构建一个html文本剪贴板内容对象。
+构建一个HTML剪贴板内容对象。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
-| htmlText | string | 是 | 待保存的HTML文本内容。 |
+| htmlText | string | 是 | HTML内容。 |
+
+**返回值:**
-**返回值**
| 类型 | 说明 |
| -------- | -------- |
-| [PasteData](#pastedata) | 包含此内容的剪贴板内容对象。 |
+| [PasteData](#pastedata) | 剪贴板内容对象。 |
-**示例**
+**示例:**
- ```js
- var html = "\n" + "\n" + "
\n" + "\n" + "HTML-PASTEBOARD_HTML\n" + "\n" + "\n" + " HEAD
\n" + " \n" + "\n" + "";
- var pasteData = pasteboard.createHtmlData(html);
- ```
+```js
+var html = "\n" + "\n" + "\n" + "\n" + "HTML-PASTEBOARD_HTML\n" + "\n" + "\n" + " HEAD
\n" + " \n" + "\n" + "";
+var pasteData = pasteboard.createHtmlData(html);
+```
## pasteboard.createWantData7+
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
- var object = {
- bundleName: "com.example.aafwk.test",
- abilityName: "com.example.aafwk.test.TwoAbility"
- };
- var pasteData = pasteboard.createWantData(object);
- ```
+```js
+var object = {
+ bundleName: "com.example.aafwk.test",
+ abilityName: "com.example.aafwk.test.TwoAbility"
+};
+var pasteData = pasteboard.createWantData(object);
+```
## pasteboard.createUriData7+
@@ -114,23 +118,25 @@ createUriData(uri:string): PasteData
构建一个URI剪贴板内容对象。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
-| uri | string | 是 | 待保存的URI内容。 |
+| uri | string | 是 | URI内容。 |
+
+**返回值:**
-**返回值**
| 类型 | 说明 |
| -------- | -------- |
-| [PasteData](#pastedata) | 包含此内容的剪贴板内容对象。 |
+| [PasteData](#pastedata) | 剪贴板内容对象。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createUriData("dataability:///com.example.myapplication1/user.txt");
- ```
+```js
+var pasteData = pasteboard.createUriData("dataability:///com.example.myapplication1/user.txt");
+```
## pasteboard.createPixelMapData9+
@@ -139,59 +145,64 @@ createPixelMapData((pixelMap: image.PixelMap): PasteData
构建一个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) | 包含此内容的剪贴板内容对象。 |
-
-**示例**
-
- ```js
- import image from '@ohos.multimedia.image';
- var buffer = new ArrayBuffer(128)
- var opt = {
- size: { height: 3, width: 5 },
- pixelFormat: 3,
- editable: true,
- alphaType: 1,
- scaleMode: 1
- }
- image.createPixelMap(buffer, opt).then((pixelMap) => {
- var pasteData = pasteboard.createPixelMapData(pixelMap);
- })
- ```
+| [PasteData](#pastedata) | 剪贴板内容对象。 |
+
+**示例:**
+
+```js
+import image from '@ohos.multimedia.image';
+
+var buffer = new ArrayBuffer(128)
+var opt = {
+ size: { height: 3, width: 5 },
+ pixelFormat: 3,
+ editable: true,
+ alphaType: 1,
+ scaleMode: 1
+}
+image.createPixelMap(buffer, opt).then((pixelMap) => {
+ var pasteData = pasteboard.createPixelMapData(pixelMap);
+})
+```
## pasteboard.createPlainTextRecord7+
createPlainTextRecord(text:string): PasteDataRecord
-创建一条文本类型的内容条目。
+创建一条纯文本内容条目。
+
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| text | string | 是 | 纯文本内容。 |
-**返回值**
+**返回值:**
+
| 类型 | 说明 |
| -------- | -------- |
| [PasteDataRecord](#pastedatarecord7) | 一条新建的纯文本内容条目。 |
-**示例**
+**示例:**
- ```js
- var record = pasteboard.createPlainTextRecord("hello");
- ```
+```js
+var record = pasteboard.createPlainTextRecord("hello");
+```
## pasteboard.createHtmlTextRecord7+
@@ -200,24 +211,26 @@ createHtmlTextRecord(htmlText:string): PasteDataRecord
创建一条HTML内容的条目。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| htmlText | string | 是 | HTML内容。 |
-**返回值**
+**返回值:**
+
| 类型 | 说明 |
| -------- | -------- |
| [PasteDataRecord](#pastedatarecord7) | 一条新建的HTML内容条目。 |
-**示例**
+**示例:**
- ```js
- var html = "\n" + "\n" + "\n" + "\n" + "HTML-PASTEBOARD_HTML\n" + "\n" + "\n" + " HEAD
\n" + " \n" + "\n" + "";
- var record = pasteboard.createHtmlTextRecord(html);
- ```
+```js
+var html = "\n" + "\n" + "\n" + "\n" + "HTML-PASTEBOARD_HTML\n" + "\n" + "\n" + " HEAD
\n" + " \n" + "\n" + "";
+var record = pasteboard.createHtmlTextRecord(html);
+```
## pasteboard.createWantRecord7+
@@ -226,27 +239,29 @@ createWantRecord(want:Want): PasteDataRecord
创建一条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
- var object = {
- bundleName: "com.example.aafwk.test",
- abilityName: "com.example.aafwk.test.TwoAbility"
- };
- var record = pasteboard.createWantRecord(object);
- ```
+```js
+var object = {
+ bundleName: "com.example.aafwk.test",
+ abilityName: "com.example.aafwk.test.TwoAbility"
+};
+var record = pasteboard.createWantRecord(object);
+```
## pasteboard.createUriRecord7+
@@ -255,66 +270,90 @@ createUriRecord(uri:string): PasteDataRecord
创建一条URI内容的条目。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| uri | string | 是 | URI内容。 |
-**返回值**
+**返回值:**
+
| 类型 | 说明 |
| -------- | -------- |
| [PasteDataRecord](#pastedatarecord7) | 一条新建的URI内容条目。 |
-**示例**
+**示例:**
- ```js
- var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
- ```
+```js
+var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
+```
## pasteboard.createPixelMapRecord9+
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对象内容条目。 |
-
-**示例**
-
- ```js
- import image from '@ohos.multimedia.image';
- var buffer = new ArrayBuffer(128)
- var opt = {
- size: { height: 3, width: 5 },
- pixelFormat: 3,
- editable: true,
- alphaType: 1,
- scaleMode: 1
- }
- image.createPixelMap(buffer, opt).then((pixelMap) => {
- var record = pasteboard.createPixelMapRecord(pixelMap);
- })
- ```
+| [PasteDataRecord](#pastedatarecord7) | 一条新建的PixelMap内容条目。 |
+
+**示例:**
+
+```js
+import image from '@ohos.multimedia.image';
+
+var buffer = new ArrayBuffer(128)
+var opt = {
+ size: { height: 3, width: 5 },
+ pixelFormat: 3,
+ editable: true,
+ alphaType: 1,
+ scaleMode: 1
+}
+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();
+```
## ShareOption9+
可粘贴数据的范围类型枚举。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
| 名称 | 说明 |
| ----- | ----------------------- |
@@ -326,15 +365,15 @@ createPixelMapRecord(pixelMap:image.PixelMap): PasteDataRecord
定义了剪贴板中所有内容条目的属性,包含时间戳、数据类型、粘贴范围以及一些附加数据等。
-**系统能力**: 以下各项对应的系统能力均为SystemCapability.MiscServices.Pasteboard。
+**系统能力:** SystemCapability.MiscServices.Pasteboard
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
-| additions7+ | {[key: string]: object} | 是 | 是 | 设置的其他附加属性数据。 |
-| mimeTypes7+ | Array<string> | 是 | 否 | 剪贴板内容条目的数据类型, 非重复的类型列表。 |
+| additions7+ | {[key:string]:object} | 是 | 是 | 设置的其他附加属性数据。 |
+| mimeTypes7+ | Array<string> | 是 | 否 | 剪贴板内容条目的数据类型,非重复的类型列表。 |
| tag7+ | string | 是 | 是 | 用户自定义标签。 |
-| timestamp7+ | number | 是 | 否 | 剪贴板数据的写入时间戳(毫秒)。 |
-| localOnly7+ | boolean | 是 | 是 | 配置剪贴板内容的“仅在本地”标志位。
- 默认情况为true。
- 配置为true时,表示内容仅在本地,不会在设备之间传递。
- 配置为false时,表示内容将在设备间传递。 |
+| timestamp7+ | number | 是 | 否 | 剪贴板数据的写入时间戳(单位:ms)。 |
+| localOnly7+ | boolean | 是 | 是 | 配置剪贴板内容是否为“仅在本地”。默认值为true。
- 配置为true时,表示内容仅在本地,不会在设备之间传递。
- 配置为false时,表示内容将在设备间传递。 |
| shareOption9+ | [ShareOption](#shareoption9) | 是 | 是 | 指示剪贴板数据可以粘贴到的范围。 |
@@ -345,14 +384,14 @@ createPixelMapRecord(pixelMap:image.PixelMap): PasteDataRecord
### 属性
-**系统能力**: 以下各项对应的系统能力均为SystemCapability.MiscServices.Pasteboard。
+**系统能力:** SystemCapability.MiscServices.Pasteboard
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
-| htmlText7+ | string | 是 | 否 | HTML文本内容。 |
-| want7+ | [Want](js-apis-application-Want.md) | 是 | 否 | Want文本内容。 |
+| htmlText7+ | string | 是 | 否 | HTML内容。 |
+| want7+ | [Want](js-apis-application-Want.md) | 是 | 否 | Want内容。 |
| mimeType7+ | string | 是 | 否 | 数据类型。 |
-| plainText7+ | string | 是 | 否 | 文本内容。 |
+| plainText7+ | string | 是 | 否 | 纯文本内容。 |
| uri7+ | string | 是 | 否 | URI内容。 |
| pixelMap9+ | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | 否 | PixelMap内容。 |
@@ -361,59 +400,63 @@ createPixelMapRecord(pixelMap:image.PixelMap): PasteDataRecord
convertToText(): Promise<string>
-实例方法,将一个PasteData中的内容强制转换为文本内容,并使用Promise异步方式返回结果。
+将一个PasteData中的内容强制转换为文本内容,使用Promise异步回调。
+
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**返回值:**
-**返回值**
| 类型 | 说明 |
| -------- | -------- |
-| Promise<void> | 异步回调函数,调用成功则返回强制转换的文本内容,调用失败则返回error信息。 |
+| Promise<string> | Promise对象,返回强制转换的文本内容。 |
-**示例**
+**示例:**
- ```js
- var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
- record.convertToText().then((data) => {
- console.info('convertToText success data : ' + JSON.stringify(data));
- }).catch((error) => {
- console.error('convertToText failed because ' + JSON.stringify(error));
- });
- ```
+```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) => {
+ console.error('Failed to convert to text. Cause: ' + JSON.stringify(err));
+});
+```
### convertToText7+
convertToText(callback: AsyncCallback<string>): void
-实例方法,将一个PasteData中的内容强制转换为文本内容,并使用callback方式返回结果。
+将一个PasteData中的内容强制转换为文本内容,使用callback异步回调。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
-| callback | AsyncCallback<string> | 是 | 回调函数,调用成功则返回强制转换的文本内容,调用失败则返回error信息。 |
+| callback | AsyncCallback<string> | 是 | 回调函数,当转换成功,err为undefined,data为强制转换的文本内容;否则返回错误信息。 |
-**示例**
+**示例:**
- ```js
- var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1/user.txt");
- record.convertToText((err, data) => {
- if (err) {
- console.error('convertToText failed because ' + JSON.stringify(err));
- return;
- }
- console.info('convertToText success data : ' + JSON.stringify(data));
- });
- ```
+```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;
+ }
+ console.info('Succeeded in converting to text. Data: ' + JSON.stringify(data));
+});
+```
## PasteData
+剪贴板内容对象。
+
在调用PasteData的接口前,需要先获取一个PasteData对象。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
### getPrimaryText
@@ -424,42 +467,44 @@ getPrimaryText(): string
获取首个条目的纯文本内容。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**返回值**
+**返回值:**
+
| 类型 | 说明 |
| -------- | -------- |
| string | 纯文本内容。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createPlainTextData("hello");
- var plainText = pasteData.getPrimaryText();
- ```
+```js
+var pasteData = pasteboard.createPlainTextData("hello");
+var plainText = pasteData.getPrimaryText();
+```
### getPrimaryHtml7+
getPrimaryHtml(): string
-获取首个条目的HTML文本内容。
+获取首个条目的HTML内容。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**返回值:**
-**返回值**
| 类型 | 说明 |
| -------- | -------- |
-| string | HTML文本数据。 |
+| string | HTML内容。 |
-**示例**
+**示例:**
- ```js
- var html = "\n" + "\n" + "\n" + "\n" + "HTML-PASTEBOARD_HTML\n" + "\n" + "\n" + " HEAD
\n" + " \n" + "\n" + "";
- var pasteData = pasteboard.createHtmlData(html);
- var htmlText = pasteData.getPrimaryHtml();
- ```
+```js
+var html = "\n" + "\n" + "\n" + "\n" + "HTML-PASTEBOARD_HTML\n" + "\n" + "\n" + " HEAD
\n" + " \n" + "\n" + "";
+var pasteData = pasteboard.createHtmlData(html);
+var htmlText = pasteData.getPrimaryHtml();
+```
### getPrimaryWant7+
@@ -468,77 +513,80 @@ getPrimaryWant(): Want
获取首个条目的Want对象内容。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**返回值:**
-**返回值**
| 类型 | 说明 |
| -------- | -------- |
| [Want](js-apis-application-Want.md) | Want对象内容。 |
-**示例**
+**示例:**
- ```js
- var object = {
- bundleName: "com.example.aafwk.test",
- abilityName: "com.example.aafwk.test.TwoAbility"
- };
- var pasteData = pasteboard.createWantData(object);
- var want = pasteData.getPrimaryWant();
- ```
+```js
+var object = {
+ bundleName: "com.example.aafwk.test",
+ abilityName: "com.example.aafwk.test.TwoAbility"
+};
+var pasteData = pasteboard.createWantData(object);
+var want = pasteData.getPrimaryWant();
+```
### getPrimaryUri7+
getPrimaryUri(): string
-获取首个条目的URI文本内容。
+获取首个条目的URI内容。
+
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**返回值:**
-**返回值**
| 类型 | 说明 |
| -------- | -------- |
-| string | URI文本内容。 |
+| string | URI内容。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createUriData("dataability:///com.example.myapplication1/user.txt");
- var uri = pasteData.getPrimaryUri();
- ```
+```js
+var pasteData = pasteboard.createUriData("dataability:///com.example.myapplication1/user.txt");
+var uri = pasteData.getPrimaryUri();
+```
### getPrimaryPixelMap9+
getPrimaryPixelMap(): image.PixelMap
-获取首个条目的PixelMap对象内容。
+获取首个条目的PixelMap内容。
+
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**返回值:**
-**返回值**
| 类型 | 说明 |
| -------- | -------- |
-| [image.PixelMap](js-apis-image.md#pixelmap7) | PixelMap对象内容。 |
-
-**示例**
-
- ```js
- import image from '@ohos.multimedia.image';
-
- var buffer = new ArrayBuffer(128)
- var opt = {
- size: { height: 3, width: 5 },
- pixelFormat: 3,
- editable: true,
- alphaType: 1,
- scaleMode: 1
- }
- image.createPixelMap(buffer, opt).then((pixelMap) => {
- var pasteData = pasteboard.createPixelMapData(pixelMap);
- var pixelMap = pasteData.getPrimaryPixelMap();
- })
- ```
+| [image.PixelMap](js-apis-image.md#pixelmap7) | PixelMap内容。 |
+
+**示例:**
+
+```js
+import image from '@ohos.multimedia.image';
+
+var buffer = new ArrayBuffer(128)
+var opt = {
+ size: { height: 3, width: 5 },
+ pixelFormat: 3,
+ editable: true,
+ alphaType: 1,
+ scaleMode: 1
+}
+image.createPixelMap(buffer, opt).then((pixelMap) => {
+ var pasteData = pasteboard.createPixelMapData(pixelMap);
+ var pixelMap = pasteData.getPrimaryPixelMap();
+})
+```
### addTextRecord7+
@@ -549,43 +597,45 @@ addTextRecord(text: string): void
剪贴板内容中添加的条目达到数量上限128后,后续的添加操作无效。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| text | string | 是 | 纯文本内容。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createPlainTextData("hello");
- pasteData.addTextRecord("good");
- ```
+```js
+var pasteData = pasteboard.createPlainTextData("hello");
+pasteData.addTextRecord("good");
+```
### addHtmlRecord7+
addHtmlRecord(htmlText: string): void
-向当前剪贴板内容中添加一条HTML文本条目,并将MIMETYPE_TEXT_HTML添加到[PasteDataProperty](#pastedataproperty7)的mimeTypes中。入参均不能为空,否则添加失败。
+向当前剪贴板内容中添加一条HTML内容条目,并将MIMETYPE_TEXT_HTML添加到[PasteDataProperty](#pastedataproperty7)的mimeTypes中。入参均不能为空,否则添加失败。
剪贴板内容中添加的条目达到数量上限128后,后续的添加操作无效。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
-| htmlText | string | 是 | HTML格式的文本内容。 |
+| htmlText | string | 是 | HTML内容。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createPlainTextData("hello");
- var html = "\n" + "\n" + "\n" + "\n" + "HTML-PASTEBOARD_HTML\n" + "\n" + "\n" + " HEAD
\n" + " \n" + "\n" + "";
- pasteData.addHtmlRecord(html);
- ```
+```js
+var pasteData = pasteboard.createPlainTextData("hello");
+var html = "\n" + "\n" + "\n" + "\n" + "HTML-PASTEBOARD_HTML\n" + "\n" + "\n" + " HEAD
\n" + " \n" + "\n" + "";
+pasteData.addHtmlRecord(html);
+```
### addWantRecord7+
@@ -596,23 +646,24 @@ addWantRecord(want: Want): void
剪贴板内容中添加的条目达到数量上限128后,后续的添加操作无效。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** 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);
- ```
+```js
+var pasteData = pasteboard.createPlainTextData("hello");
+var object = {
+ bundleName: "com.example.aafwk.test",
+ abilityName: "com.example.aafwk.test.TwoAbility"
+};
+pasteData.addWantRecord(object);
+```
### addUriRecord7+
@@ -623,19 +674,20 @@ addUriRecord(uri: string): void
剪贴板内容中添加的条目达到数量上限128后,后续的添加操作无效。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
-| uri | string | 是 | URI文本内容。 |
+| uri | string | 是 | URI内容。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createPlainTextData("hello");
- pasteData.addUriRecord("dataability:///com.example.myapplication1/user.txt");
- ```
+```js
+var pasteData = pasteboard.createPlainTextData("hello");
+pasteData.addUriRecord("dataability:///com.example.myapplication1/user.txt");
+```
### addPixelMapRecord9+
@@ -645,29 +697,31 @@ addPixelMapRecord(pixelMap: image.PixelMap): void
剪贴板内容中添加的条目达到数量上限512后,后续的添加操作无效。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
-| pixelMap | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | PixelMap对象内容。 |
-
-**示例**
-
- ```js
- import image from '@ohos.multimedia.image';
- var buffer = new ArrayBuffer(128)
- var opt = {
- size: { height: 3, width: 5 },
- pixelFormat: 3,
- editable: true,
- alphaType: 1,
- scaleMode: 1
- }
- image.createPixelMap(buffer, opt).then((pixelMap) => {
- var record = pasteboard.createPlainTextData("hello").addPixelMapRecord(pixelMap);
- })
- ```
+| pixelMap | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | PixelMap内容。 |
+
+**示例:**
+
+```js
+import image from '@ohos.multimedia.image';
+
+var buffer = new ArrayBuffer(128)
+var opt = {
+ size: { height: 3, width: 5 },
+ pixelFormat: 3,
+ editable: true,
+ alphaType: 1,
+ scaleMode: 1
+}
+image.createPixelMap(buffer, opt).then((pixelMap) => {
+ var record = pasteboard.createPlainTextData("hello").addPixelMapRecord(pixelMap);
+})
+```
### addRecord7+
@@ -678,23 +732,24 @@ addRecord(record: PasteDataRecord): void
剪贴板内容中添加的条目达到数量上限128后,后续的添加操作无效。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| record | [PasteDataRecord](#pastedatarecord7) | 是 | 待添加的条目。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createUriData("dataability:///com.example.myapplication1/user.txt");
- var textRecord = pasteboard.createPlainTextRecord("hello");
- var html = "\n" + "\n" + "\n" + "\n" + "HTML-PASTEBOARD_HTML\n" + "\n" + "\n" + " HEAD
\n" + " \n" + "\n" + "";
- var htmlRecord = pasteboard.createHtmlTextRecord(html);
- pasteData.addRecord(textRecord);
- pasteData.addRecord(htmlRecord);
- ```
+```js
+var pasteData = pasteboard.createUriData("dataability:///com.example.myapplication1/user.txt");
+var textRecord = pasteboard.createPlainTextRecord("hello");
+var html = "\n" + "\n" + "\n" + "\n" + "HTML-PASTEBOARD_HTML\n" + "\n" + "\n" + " HEAD
\n" + " \n" + "\n" + "";
+var htmlRecord = pasteboard.createHtmlTextRecord(html);
+pasteData.addRecord(textRecord);
+pasteData.addRecord(htmlRecord);
+```
### getMimeTypes7+
@@ -703,259 +758,254 @@ getMimeTypes(): Array<string>
获取剪贴板中[PasteDataProperty](#pastedataproperty7)的mimeTypes列表,当剪贴板内容为空时,返回列表为空。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**返回值:**
-**返回值**
| 类型 | 说明 |
| -------- | -------- |
-| Array<string> | 非重复的类型列表。 |
+| Array<string> | 剪贴板内容条目的数据类型,非重复的类型列表。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createPlainTextData("hello");
- var types = pasteData.getMimeTypes();
- ```
+```js
+var pasteData = pasteboard.createPlainTextData("hello");
+var types = pasteData.getMimeTypes();
+```
### getPrimaryMimeType7+
getPrimaryMimeType(): string
-获取首个条目的数据类型。
+获取剪贴板内容中首个条目的数据类型。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**返回值:**
-**返回值**
| 类型 | 说明 |
| -------- | -------- |
| string | 首个条目的数据类型。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createPlainTextData("hello");
- var type = pasteData.getPrimaryMimeType();
- ```
+```js
+var pasteData = pasteboard.createPlainTextData("hello");
+var type = pasteData.getPrimaryMimeType();
+```
### getProperty7+
getProperty(): PasteDataProperty
-获取属性描述对象。
+获取剪贴板内容的属性描述对象。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**返回值:**
-**返回值**
| 类型 | 说明 |
| -------- | -------- |
| [PasteDataProperty](#pastedataproperty7) | 属性描述对象。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createPlainTextData("hello");
- var property = pasteData.getProperty();
- ```
+```js
+var pasteData = pasteboard.createPlainTextData("hello");
+var property = pasteData.getProperty();
+```
### setProperty9+
setProperty(property: PasteDataProperty): void
-设置属性描述对象,当前仅支持设置shareOption属性。
+设置剪贴板内容的属性描述对象,当前仅支持设置shareOption属性。
+
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| property | [PasteDataProperty](#pastedataproperty7) | 是 | 属性描述对象。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createHtmlData('application/xml');
- let prop = pasteData.getProperty();
- prop.shareOption = pasteboard.ShareOption.InApp;
- pasteData.setProperty(prop);
- ```
+```js
+var pasteData = pasteboard.createHtmlData('application/xml');
+let prop = pasteData.getProperty();
+prop.shareOption = pasteboard.ShareOption.InApp;
+pasteData.setProperty(prop);
+```
### getRecordAt7+
getRecordAt(index: number): PasteDataRecord
-获取指定下标的条目。
+获取剪贴板内容中指定下标的条目。
+
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| index | number | 是 | 指定条目的下标。 |
-**返回值**
+**返回值:**
+
| 类型 | 说明 |
| -------- | -------- |
| [PasteDataRecord](#pastedatarecord7) | 指定下标的条目。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createPlainTextData("hello");
- var record = pasteData.getRecordAt(0);
- ```
+```js
+var pasteData = pasteboard.createPlainTextData("hello");
+var record = pasteData.getRecordAt(0);
+```
### getRecordCount7+
getRecordCount(): number
-获取剪贴板中条目的个数。
+获取剪贴板内容中条目的个数。
+
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**返回值:**
-**返回值**
| 类型 | 说明 |
| -------- | -------- |
| number | 条目的个数。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createPlainTextData("hello");
- var count = pasteData.getRecordCount();
- ```
+```js
+var pasteData = pasteboard.createPlainTextData("hello");
+var count = pasteData.getRecordCount();
+```
### getTag7+
getTag(): string
-获取用户自定义的标签内容,如果没有设置用户自定义的标签内容将返回空。
+获取剪贴板内容中用户自定义的标签内容,如果没有设置用户自定义的标签内容将返回空。
+
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**返回值:**
-**返回值**
| 类型 | 说明 |
| -------- | -------- |
-| string | 获取用户自定义的标签内容,如果没有设置用户自定义的标签内容将返回空。 |
+| string | 返回用户自定义的标签内容,如果没有设置用户自定义的标签内容,将返回空。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createPlainTextData("hello");
- var tag = pasteData.getTag();
- ```
+```js
+var pasteData = pasteboard.createPlainTextData("hello");
+var tag = pasteData.getTag();
+```
### hasMimeType7+
hasMimeType(mimeType: string): boolean
-检查内容中是否有指定的数据类型。
+检查剪贴板内容中是否有指定的数据类型。
+
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| mimeType | string | 是 | 待查询的数据类型。 |
-**返回值**
+**返回值:**
+
| 类型 | 说明 |
| -------- | -------- |
| boolean | 有指定的数据类型返回true,否则返回false。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createPlainTextData("hello");
- var hasType = pasteData.hasMimeType(pasteboard.MIMETYPE_TEXT_PLAIN);
- ```
+```js
+var pasteData = pasteboard.createPlainTextData("hello");
+var hasType = pasteData.hasMimeType(pasteboard.MIMETYPE_TEXT_PLAIN);
+```
### removeRecordAt7+
removeRecordAt(index: number): boolean
-移除指定下标的条目。
+移除剪贴板内容中指定下标的条目。
+
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| index | number | 是 | 指定的下标。 |
-**返回值**
+**返回值:**
+
| 类型 | 说明 |
| -------- | -------- |
| boolean | 成功移除返回true,失败返回false。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createPlainTextData("hello");
- var isRemove = pasteData.removeRecordAt(0);
- ```
+```js
+var pasteData = pasteboard.createPlainTextData("hello");
+var isRemove = pasteData.removeRecordAt(0);
+```
### replaceRecordAt7+
replaceRecordAt(index: number, record: PasteDataRecord): boolean
-替换指定下标的条目。
+替换剪贴板内容中指定下标的条目。
+
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| index | number | 是 | 指定的下标。 |
| 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的接口前,需要先通过[getSystemPasteboard](#pasteboardgetsystempasteboard)获取系统剪切板。
+系统剪贴板对象。
-```
+在调用SystemPasteboard的接口前,需要先通过[getSystemPasteboard](#pasteboardgetsystempasteboard)获取系统剪贴板。
+
+```js
var systemPasteboard = pasteboard.getSystemPasteboard();
```
@@ -964,112 +1014,117 @@ var systemPasteboard = pasteboard.getSystemPasteboard();
setPasteData(data:PasteData, callback:AsyncCallback<void>): void
-将数据写入系统剪切板,并使用callback方式返回结果。
+将数据写入系统剪贴板,使用callback异步回调。
+
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| data | [PasteData](#pastedata) | 是 | PasteData对象。 |
-| callback | AsyncCallback<void> | 是 | 回调函数,表示是否成功将数据写入系统剪切板。 |
+| callback | AsyncCallback<void> | 是 | 回调函数。当写入成功,err为undefined,否则为错误对象。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createPlainTextData("content");
- var systemPasteboard = pasteboard.getSystemPasteboard();
- systemPasteboard.setPasteData(pasteData, (error, data) => {
- if (error) {
- console.error('Failed to setPasteData. Cause: ' + error.message);
- return;
- }
- console.info('setPasteData successfully.');
- });
- ```
+```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
setPasteData(data:PasteData): Promise<void>
-将数据写入系统剪切板,并使用Promise异步方式返回结果。
+将数据写入系统剪贴板,使用Promise异步回调。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**参数:**
-**参数**
| 参数名 | 类型 | 说明 |
| -------- | -------- | -------- |
| data | [PasteData](#pastedata) | PasteData对象。 |
-**返回值**
+**返回值:**
+
| 类型 | 说明 |
| -------- | -------- |
-| Promise<void> | 异步回调函数,表示是否成功将数据写入系统剪切板。 |
+| Promise<void> | 无返回结果的Promise对象。 |
-**示例**
+**示例:**
- ```js
- var pasteData = pasteboard.createPlainTextData("content");
- var systemPasteboard = pasteboard.getSystemPasteboard();
- systemPasteboard.setPasteData(pasteData).then((data) => {
- console.info('setPasteData success.');
- }).catch((error) => {
- console.error('Failed to setPasteData. Cause: ' + error.message);
- });
- ```
+```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);
+});
+```
### getPasteData
getPasteData( callback:AsyncCallback<PasteData>): void
-读取系统剪切板内容,并使用callback方式返回结果。
+读取系统剪贴板内容,使用callback异步回调。
+
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
-| callback | AsyncCallback<[PasteData](#pastedata)> | 是 | 回调函数,返回系统剪切板数据。 |
+| callback | AsyncCallback<[PasteData](#pastedata)> | 是 | 回调函数。当读取成功,err为undefined,data为返回的系统剪贴板数据;否则返回错误对象。 |
-**示例**
+**示例:**
- ```js
- var systemPasteboard = pasteboard.getSystemPasteboard();
- systemPasteboard.getPasteData((error, pasteData) => {
- if (error) {
- console.error('Failed to getPasteData. Cause: ' + error.message);
- return;
- }
- var text = pasteData.getPrimaryText();
- });
- ```
+```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();
+});
+```
### getPasteData
getPasteData(): Promise<PasteData>
-读取系统剪切板内容,并使用Promise异步方式返回结果。
+读取系统剪贴板内容,使用Promise异步回调。
+
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**返回值:**
-**返回值**
| 类型 | 说明 |
| -------- | -------- |
-| Promise<[PasteData](#pastedata)> | 异步回调函数,调返回系统剪切板数据。 |
+| Promise<[PasteData](#pastedata)> | Promise对象,返回系统剪贴板数据。 |
-**示例**
+**示例:**
- ```js
- var systemPasteboard = pasteboard.getSystemPasteboard();
- systemPasteboard.getPasteData().then((pasteData) => {
- var text = pasteData.getPrimaryText();
- }).catch((error) => {
- console.error('Failed to getPasteData. Cause: ' + error.message);
- })
- ```
+```js
+var systemPasteboard = pasteboard.getSystemPasteboard();
+systemPasteboard.getPasteData().then((pasteData) => {
+ var text = pasteData.getPrimaryText();
+}).catch((err) => {
+ console.error('Failed to get PasteData. Cause: ' + err.message);
+})
+```
### on('update')7+
@@ -1078,23 +1133,24 @@ on(type: 'update', callback: () =>void ): void
订阅系统剪贴板内容变化事件,当系统剪贴板中内容变化时触发用户程序的回调。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取值为'update',表示系统剪贴板内容变化事件。 |
| callback | function | 是 | 剪贴板中内容变化时触发的用户程序的回调。 |
-**示例**
+**示例:**
- ```js
- var systemPasteboard = pasteboard.getSystemPasteboard();
- var listener = () => {
- console.info('The system pasteboard has changed');
- };
- systemPasteboard.on('update', listener);
- ```
+```js
+var systemPasteboard = pasteboard.getSystemPasteboard();
+var listener = () => {
+ console.info('The system pasteboard has changed.');
+};
+systemPasteboard.on('update', listener);
+```
### off('update')7+
@@ -1103,120 +1159,124 @@ off(type: 'update', callback?: () =>void ): void
取消订阅系统剪贴板内容变化事件。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
+
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取值为'update',表示系统剪贴板内容变化事件。 |
| callback | function | 否 | 剪贴板中内容变化时触发的用户程序的回调。 |
-**示例**
+**示例:**
- ```js
- let listener = () => {
- console.info('The system pasteboard has changed');
- };
- systemPasteboard.off('update', listener);
- ```
+```js
+let listener = () => {
+ console.info('The system pasteboard has changed.');
+};
+systemPasteboard.off('update', listener);
+```
### hasPasteData7+
hasPasteData(callback: AsyncCallback<boolean>): void
-判断系统剪切板中是否有内容,并使用callback异步方式返回结果。
+判断系统剪贴板中是否有内容,使用callback异步回调。
+
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
-| callback | AsyncCallback<boolean> | 是 | 返回为true表示系统剪切板中有内容,返回false表示系统剪切板中没有内容。 |
-
-**示例**
-
- ```js
- systemPasteboard.hasPasteData((err, data) => {
- if (err) {
- console.error('failed to hasPasteData because ' + JSON.stringify(err));
- return;
- }
- console.info('success hasPasteData : ' + JSON.stringify(data));
- });
- ```
+| callback | AsyncCallback<boolean> | 是 | 返回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));
+});
+```
### hasPasteData7+
hasPasteData(): Promise<boolean>
-判断系统剪切板中是否有内容,并使用Promise异步方式返回结果。
+判断系统剪贴板中是否有内容,使用Promise异步回调。
+
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**返回值:**
-**返回值**
| 类型 | 说明 |
| -------- | -------- |
-| Promise<boolean> | 返回为true表示系统剪切板中有内容,返回false表示系统剪切板中没有内容。 |
+| Promise<boolean> | 返回true表示系统剪贴板中有内容,返回false表示系统剪贴板中没有内容。 |
-**示例**
+**示例:**
- ```js
- systemPasteboard.hasPasteData().then((data) => {
- console.info('success hasPasteData : ' + JSON.stringify(data));
- }).catch((error) => {
- console.error('failed to hasPasteData because ' + JSON.stringify(error));
- });
- ```
+```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));
+});
+```
### clear7+
clear(callback: AsyncCallback<void>): void
-清空系统剪切板内容,并使用callback异步方式返回结果。
+清空系统剪贴板内容,使用callback异步回调。
+
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**参数:**
-**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
-| callback | AsyncCallback<void> | 是 | 回调函数,表示是否成功清空系统剪切板内容。 |
-
-**示例**
-
- ```js
- systemPasteboard.clear((err, data) => {
- if (err) {
- console.error('failed to clear because ' + JSON.stringify(err));
- return;
- }
- console.info('success clear');
- });
- ```
+| callback | AsyncCallback<void> | 是 | 回调函数。当成功清空时,err为undefined;否则为错误对象。 |
+
+**示例:**
+
+```js
+systemPasteboard.clear((err, data) => {
+ if (err) {
+ console.error('Failed to clear the PasteData. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in clearing the PasteData.');
+});
+```
### clear7+
clear(): Promise<void>
-清空系统剪切板内容,并使用Promise异步方式返回结果。
+清空系统剪贴板内容,使用Promise异步回调。
-**系统能力**: SystemCapability.MiscServices.Pasteboard
+**系统能力:** SystemCapability.MiscServices.Pasteboard
-**返回值**
+**返回值:**
| 类型 | 说明 |
| -------- | -------- |
-| Promise<void> | 异步回调函数,表示是否成功清空系统剪切板内容。 |
+| Promise<void> | 无返回结果的Promise对象。 |
-**示例**
+**示例:**
- ```js
- systemPasteboard.clear().then((data) => {
- console.info('success clear');
- }).catch((error) => {
- console.error('failed to clear because ' + JSON.stringify(error));
- });
- ```
+```js
+systemPasteboard.clear().then((data) => {
+ console.info('Succeeded in clearing the PasteData.');
+}).catch((err) => {
+ console.error('Failed to clear the PasteData. Cause: ' + JSON.stringify(err));
+});
+```
\ No newline at end of file