> For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt.

# getClipboardData

获取剪贴板内容。

## 扫码预览

![扫码预览 getClipboardData](https://api.qrserver.com/v1/create-qr-code/?size=200x200\&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fdevice%252Fclipboard%252Findex)

## 支持版本

前端库版本不低于 `0.0.25`。

## 支持平台

<table>
<thead>
<tr><th>平台</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>Android</td><td>支持</td></tr>
<tr><td>iOS</td><td>支持</td></tr>
<tr><td>PC</td><td>不支持</td></tr>
<tr><td>HarmonyOS</td><td>不支持</td></tr>
</tbody>
</table>

## 支持场景

<table>
<thead>
<tr><th>场景</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>页面</td><td>支持</td></tr>
<tr><td>卡片</td><td>支持</td></tr>
</tbody>
</table>

## 接入准备

### 权限要求

<table>
<thead>
<tr><th>类型</th><th>标识</th><th>是否必须</th><th>平台</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td>豆包能力</td><td><code>剪贴板能力</code></td><td>按条件</td><td>Android、iOS</td><td>需要豆包提供剪贴板能力，未开通时调用失败</td></tr>
</tbody>
</table>

### 授权行为

- 该接口不主动弹出授权，仅在豆包已提供剪贴板能力时读取；能力缺失时调用直接失败，需在支持该能力的豆包版本中调用

## 使用说明

- 剪贴板内容属于敏感信息，请仅在用户明确操作后读取

## 调用方式

### 异步 API

```typescript
getClipboardData(params?: object): Promise<GetClipboardDataResult>
```

## 入参

无。

## 调用示例

```typescript
import { getClipboardData } from '@doubao-dev/framework/api';

const { data } = await getClipboardData();

console.log(data);
```

## 成功返回

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>data</code></td><td><code>string</code></td><td>是</td><td>当前剪贴板内容。</td></tr>
</tbody>
</table>

### 返回示例

```json
{
  "data": "hello doubao"
}
```

## 错误处理

错误对象和通用错误码见 [通用错误处理](/apps-plugin/docs/js-api/common-errors.md#错误返回)。

### 失败示例

```json
{
  "errNo": 103,
  "errMsg": "feature not support"
}
```

### 错误码

<table>
<thead>
<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
</thead>
<tbody>
<tr><td><code>103</code></td><td><code>feature not support</code></td><td>Android、iOS</td><td>当前豆包版本不支持读取剪贴板</td><td>升级至支持剪贴板能力的豆包版本后重试。</td></tr>
</tbody>
</table>

#### 通用错误码

<table>
<thead>
<tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
</thead>
<tbody>
<tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android、iOS</td></tr>
</tbody>
</table>
