提交 4f4ef6dd 编写于 作者: L LVB8189

Signed-off-by: LVB8189 <lvbai1@huawei.com>

 Changes to be committed:
上级 78ea2907
......@@ -168,6 +168,32 @@ createPixelMapData((pixelMap: image.PixelMap): PasteData
})
```
## pasteboard.createData<sup>9+</sup>
createData(mineType:string, value: ArrayBuffer): PasteData;
构建一个具有mineType和value的剪贴板内容对象。
**系统能力**: SystemCapability.MiscServices.Pasteboard
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| mineType | string | 是 | 待保存的mineType内容。 |
| value | ArrayBuffer | 是 | 待保存的value内容。 |
**返回值**
| 类型 | 说明 |
| -------- | -------- |
| [PasteData](#pastedata) | 包含此内容的剪贴板内容对象。 |
**示例**
```js
var dataXml = new ArrayBuffer(256)
var pasteData = pasteboard.createData('app/xml', dataXml)
```
## pasteboard.createPlainTextRecord<sup>7+</sup>
......@@ -273,6 +299,7 @@ createUriRecord(uri:string): PasteDataRecord
var record = pasteboard.createUriRecord("dataability:///com.example.myapplication1?user.txt");
```
## pasteboard.createPixelMapRecord<sup>9+</sup>
createPixelMapRecord(pixelMap:image.PixelMap): PasteDataRecord
......@@ -309,7 +336,47 @@ createPixelMapRecord(pixelMap:image.PixelMap): PasteDataRecord
```
## PasteDataProperty<sup>7+</sup>
## pasteboard.createRecord<sup>9+</sup>
createRecord(mimeType:string, value: ArrayBuffer):PasteDataRecord;
创建一条具有mineType和value的对象内容的条目。
**系统能力**: SystemCapability.MiscServices.Pasteboard
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| mineType | string | 是 | mineType内容。 |
| value | ArrayBuffer | 是 | ArrayBuffer类型的value内容。 |
**返回值**
| 类型 | 说明 |
| -------- | -------- |
| [PasteDataRecord](#pastedatarecord7) | 一条新建的具有mineType和value的对象内容条目。 |
**示例**
```js
var dataXml = new ArrayBuffer(256)
var pasteDataRecord = pasteboard.createRecord('app/xml', dataXml);
```
## ShareOption <sup>9+</sup>
可粘贴数据的范围类型枚举。
**系统能力**: SystemCapability.MiscServices.Pasteboard
| 名称 | 说明 |
| ----- | ----------------------- |
| InApp<sup>9+</sup> |InApp表示仅允许应用内粘贴。 |
| LocalDevice<sup>9+</sup> |LocalDevice表示仅允许在此设备中粘贴。 |
| CrossDevice<sup>9+</sup> |CrossDevice表示允许跨设备在任何应用程序中粘贴。 |
## PasteDataProperty
定义了剪贴板中所有内容条目的属性,包含时间戳、数据类型以及一些附加数据等。
......@@ -317,11 +384,12 @@ createPixelMapRecord(pixelMap:image.PixelMap): PasteDataRecord
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| additions | {[key:&nbsp;string]:&nbsp;object} | 是 | 是 | 设置的其他附加属性数据。 |
| mimeTypes | Array&lt;string&gt; | 是 | 否 | 剪贴板内容条目的数据类型,&nbsp;非重复的类型列表。 |
| tag | string | 是 | 是 | 用户自定义标签。 |
| timestamp | number | 是 | 否 | 剪贴板数据的写入时间戳(毫秒)。 |
| localOnly | boolean | 是 | 是 | 配置剪贴板内容的“仅在本地”标志位。<br/>-&nbsp;默认情况为true。<br/>-&nbsp;配置为true时,表示内容仅在本地,不会在设备之间传递。<br/>-&nbsp;配置为false时,表示内容将在设备间传递。 |
| additions<sup>7+</sup> | {[key:&nbsp;string]:&nbsp;object} | 是 | 是 | 设置的其他附加属性数据。 |
| mimeTypes<sup>7+</sup> | Array&lt;string&gt; | 是 | 否 | 剪贴板内容条目的数据类型,&nbsp;非重复的类型列表。 |
| tag<sup>7+</sup> | string | 是 | 是 | 用户自定义标签。 |
| timestamp<sup>7+</sup> | number | 是 | 否 | 剪贴板数据的写入时间戳(毫秒)。 |
| localOnly<sup>7+</sup> | boolean | 是 | 是 | 配置剪贴板内容的“仅在本地”标志位。<br/>-&nbsp;默认情况为true。<br/>-&nbsp;配置为true时,表示内容仅在本地,不会在设备之间传递。<br/>-&nbsp;配置为false时,表示内容将在设备间传递。 |
| shareOption<sup>9+</sup> | ShareOption | 是 | 是 | 指示剪贴板数据可以粘贴到的范围,如果未设置或设置不正确,则默认值为CrossDevice。 |
## PasteDataRecord<sup>7+</sup>
......@@ -341,6 +409,7 @@ createPixelMapRecord(pixelMap:image.PixelMap): PasteDataRecord
| plainText<sup>7+</sup> | string | 是 | 否 | 文本内容。 |
| uri<sup>7+</sup> | string | 是 | 否 | URI内容。 |
| pixelMap<sup>9+</sup> | [image.PixelMap](js-apis-image.md) | 是 | 否 | PixelMap内容。 |
| data<sup>9+</sup> | {[mimeType:&nbsp;string]:&nbsp;ArrayBuffer} | 是 | 否 | 记录中的数据数组。 |
### convertToText<sup>7+</sup>
......@@ -655,6 +724,31 @@ addPixelMapRecord(pixelMap: image.PixelMap): void
```
### addRecord<sup>9+</sup>
addRecord(mineType: string, value: ArrayBuffer): void;
向当前剪贴板内容中添加一条键值对记录条目,同时也会将条目类型添加到[PasteDataProperty](#pastedataproperty7)的mimeTypes中。入参均不能为空,否则添加失败。
剪贴板内容中添加的条目达到数量上限128后,后续的添加操作无效。
**系统能力**: SystemCapability.MiscServices.Pasteboard
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| mineType | string | 是 | 待添加的mineType内容条目。 |
| value | ArrayBuffer | 是 | 要保存的ArrayBuffer类型的value内容。 |
**示例**
```js
var pasteData = pasteboard.createUriData("dataability:///com.example.myapplication1?user.txt");
var dataXml = new ArrayBuffer(256)
pasteData.addRecord('app/xml', dataXml);
```
### addRecord<sup>7+</sup>
addRecord(record: PasteDataRecord): void
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册