1# @ohos.pasteboard (剪贴板)(系统接口)
2
3本模块主要提供管理系统剪贴板的能力,为系统复制、粘贴功能提供支持。系统剪贴板支持对文本、HTML、URI、Want、PixelMap等内容的操作。
4
5> **说明:**
6>
7> - 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8> - 当前页面仅包含本模块的系统接口,其他公开接口参见[@ohos.pasteboard(剪贴板)](js-apis-pasteboard.md)。
9
10## 导入模块
11
12```ts
13import pasteboard from '@ohos.pasteboard';
14```
15
16### setAppShareOptions<sup>12+</sup>
17
18setShareOptions(shareOptions: ShareOption): void
19
20设置应用全局的可粘贴的范围。
21
22**系统接口:** 此接口为系统接口。
23
24**系统能力:** SystemCapability.MiscServices.Pasteboard
25
26**参数:**
27
28| 参数名 | 类型 | 必填 | 说明 |
29| -------- | -------- | -------- | -------- |
30| shareOptions | [ShareOption](js-apis-pasteboard.md#shareoption9) | 是 | 可粘贴的范围。 |
31
32**错误码:**
33
34以下错误码的详细介绍请参见[剪贴板错误码](errorcode-pasteboard.md)。
35
36| 错误码ID | 错误信息 |
37| -------- | -------- |
38| 202 | Permission verification failed. A non-system application calls a system API. |
39| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
40| 12900006 | Settings already exist. |
41
42**示例:**
43
44```ts
45let systemPasteboard: pasteboard.SystemPasteboard = pasteboard.getSystemPasteboard();
46try {
47  systemPasteboard.setAppShareOptions(pasteboard.ShareOption.INAPP);
48  console.info('Set app share options success.');
49} catch (err) {
50  let error: BusinessError = err as BusinessError;
51  console.error(`Set app share options failed, errorCode: ${error.code}, errorMessage: ${error.message}.`);
52}
53```
54
55### removeAppShareOptions<sup>12+</sup>
56
57removeShareOptions(): void
58
59删除应用全局的可粘贴的范围。
60
61**系统接口:** 此接口为系统接口。
62
63**系统能力:** SystemCapability.MiscServices.Pasteboard
64
65**错误码:**
66
67以下错误码的详细介绍请参见[剪贴板错误码](errorcode-pasteboard.md)。
68
69| 错误码ID | 错误信息 |
70| -------- | -------- |
71| 202 | Permission verification failed. A non-system application calls a system API. |
72
73**示例:**
74
75```ts
76let systemPasteboard: pasteboard.SystemPasteboard = pasteboard.getSystemPasteboard();
77try {
78  systemPasteboard.removeAppShareOptions();
79  console.info('Remove app share options success.');
80} catch (err) {
81  let error: BusinessError = err as BusinessError;
82  console.error(`Remove app share options failed, errorCode: ${error.code}, errorMessage: ${error.message}.`);
83}
84```
85