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, and this page is available as Markdown at /apps-plugin/docs/js-api/device/clipboard/setClipboardData.md.

setClipboardData

设置系统剪贴板内容。

扫码预览

扫码预览 setClipboardData

支持版本

前端库版本不低于 0.0.20。

支持平台

平台支持情况
Android支持
iOS支持
PC不支持
HarmonyOS不支持

支持场景

场景支持情况
页面支持
卡片支持

接入准备

权限要求

类型标识是否必须平台说明
豆包能力剪贴板能力按条件Android、iOS需要豆包提供剪贴板能力,未开通时调用失败

授权行为

  • 该接口不主动弹出授权,仅在豆包已提供剪贴板能力时写入;能力缺失时调用直接失败,需在支持该能力的豆包版本中调用

使用说明

  • 写入剪贴板前建议向用户说明,避免在无感知情况下修改系统剪贴板

调用方式

异步 API

setClipboardData(params: SetClipboardDataParams): Promise<object>

入参

名称类型必填默认值约束说明
datastring是--需要设置的剪贴板内容

调用示例

import { setClipboardData } from '@doubao-dev/framework/api';

await setClipboardData({ data: '复制内容' });

成功返回

无返回字段。

返回示例

{}

错误处理

错误对象和通用错误码见 通用错误处理。

失败示例

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

错误码

errNoerrMsg平台触发条件处理建议
103feature not supportAndroid、iOS当前豆包版本不支持写入剪贴板升级至支持剪贴板能力的豆包版本后重试。
106system permission deniedAndroid写入后系统未授予剪贴板访问权限,写入未生效引导用户在系统设置中开启剪贴板相关权限后重试。

通用错误码

errNoerrMsg说明平台
102internal error内部错误Android、iOS