@heybox/hb-sdk API Reference - v0.9.5
    正在准备搜索索引...
    • 将调用方提供的纯文本写入 Host 的系统剪贴板。

      参数

      返回 Promise<void>

      Host 确认系统剪贴板写入完成后 resolve undefined;不会返回或回读剪贴板内容。

      HbMiniProgramSDKError INVALID_PARAMS:options 不是对象、包含 text 以外的字段,或 text 不是字符串、全为空白、超过 10000 个 UTF-16 code units。

      HbMiniProgramSDKError PERMISSION_NOT_IN_SNAPSHOT / PERMISSION_DENIED:当前运行快照 缺少或未启用 clipboard 权限。

      HbMiniProgramSDKError METHOD_FORBIDDEN / METHOD_NOT_FOUND:当前 Host 未开放或尚不认识该能力;Host 不支持本次写入形状时可返回 REQUEST_UNSUPPORTED。 其他握手、bridge 超时和 Host / 系统剪贴板失败会保留对应错误码。

      该 API 需要在 package.json#heybox.permissions 声明并启用 clipboard,不需要平台 批准、用户授权或可信用户手势。它通过 Host 原语写入系统剪贴板,不调用浏览器 navigator.clipboard,因此浏览器 Clipboard API 的权限与手势规则不适用;调用方仍应 在明确的用户操作后写入,避免意外覆盖用户剪贴板。

      Runtime 仅用 trim() 判断文本是否全为空白,然后把原始字符串完整交给 Host;前后 空格、换行和制表符都会保留。成功只表示 Host 已完成纯文本写入,不会追加内容、复制 富文本或图片、打开分享面板,也不会自动显示“复制成功”提示。

      复制任意业务文本或已有 URL 时使用本方法。要生成并复制当前小程序的标准分享链接, 使用 share.copyLink: 它要求 share 而不是 clipboard 权限、同样不要求可信用户手势,并在 Host 写入后返回 生成的完整链接。

      import hbSDK from '@heybox/hb-sdk'

      await hbSDK.device.setClipboard({
      // 前后空格会保留;该调用不会自动显示成功提示。
      text: ' 房间码: HB-2048 ',
      })
      showCopiedToast()

      0.4.4

      android

      ios

      ohos

      windows

      macos

      android none

      ios none

      ohos none

      windows none

      macos none