Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
4f4ef6dd
D
Docs
项目概览
OpenHarmony
/
Docs
接近 2 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
4f4ef6dd
编写于
8月 20, 2022
作者:
L
LVB8189
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Signed-off-by: LVB8189 <lvbai1@huawei.com>
Changes to be committed:
上级
78ea2907
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
100 addition
and
6 deletion
+100
-6
zh-cn/application-dev/reference/apis/js-apis-pasteboard.md
zh-cn/application-dev/reference/apis/js-apis-pasteboard.md
+100
-6
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-pasteboard.md
浏览文件 @
4f4ef6dd
...
...
@@ -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:
string]:
object} | 是 | 是 | 设置的其他附加属性数据。 |
| mimeTypes | Array
<
string
>
| 是 | 否 | 剪贴板内容条目的数据类型,
非重复的类型列表。 |
| tag | string | 是 | 是 | 用户自定义标签。 |
| timestamp | number | 是 | 否 | 剪贴板数据的写入时间戳(毫秒)。 |
| localOnly | boolean | 是 | 是 | 配置剪贴板内容的“仅在本地”标志位。
<br/>
-
默认情况为true。
<br/>
-
配置为true时,表示内容仅在本地,不会在设备之间传递。
<br/>
-
配置为false时,表示内容将在设备间传递。 |
| additions
<sup>
7+
</sup>
| {[key:
string]:
object} | 是 | 是 | 设置的其他附加属性数据。 |
| mimeTypes
<sup>
7+
</sup>
| Array
<
string
>
| 是 | 否 | 剪贴板内容条目的数据类型,
非重复的类型列表。 |
| tag
<sup>
7+
</sup>
| string | 是 | 是 | 用户自定义标签。 |
| timestamp
<sup>
7+
</sup>
| number | 是 | 否 | 剪贴板数据的写入时间戳(毫秒)。 |
| localOnly
<sup>
7+
</sup>
| boolean | 是 | 是 | 配置剪贴板内容的“仅在本地”标志位。
<br/>
-
默认情况为true。
<br/>
-
配置为true时,表示内容仅在本地,不会在设备之间传递。
<br/>
-
配置为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:
string]:
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.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录