chrome.clipboard

说明

我们提供了 chrome.clipboard API，以允许用户访问剪贴板中的数据。在有开放 Web 替代方案可用之前，对于 chromeos 平台应用而言，这是一种临时解决方案。一旦开放网络解决方案可用，它就会被弃用，可能在 2017 年第 4 季度。

权限

clipboard

可用性

开发渠道 仅限 ChromeOS

类型

AdditionalDataItem

属性

  • data

    string

    其他数据项的内容。如果 type 为“textPlain”，则为纯文本字符串；如果 type 为“textHTML”，则为标记字符串。数据不得超过 2 MB。

  • 类型

    DataItemType

    其他数据项的类型。

DataItemType

枚举

"textPlain"

ImageType

支持的图片类型。

枚举

"png"

方法

setImageData()

Promise Chrome 57 及更高版本 
chrome.clipboard.setImageData(
  imageData: ArrayBuffer,
  type: ImageType,
  additionalItems?: AdditionalDataItem[],
  callback?: function,
)

将图片数据设置为剪贴板。

参数

  • imageData

    ArrayBuffer

    Chrome 60 及更高版本

    编码后的图片数据。

  • 类型

    ImageType

    要传递的图片的类型。

  • additionalItems

    AdditionalDataItem[] 可选

    Chrome 60 及更高版本

    用于描述图片数据的其他数据项。如果出现错误，系统将调用该回调函数，并将 chrome.runtime.lastError 设置为错误代码。需要剪贴板和剪贴板写入权限。

  • callback

    函数（可选）

    callback 参数如下所示：

    ()=>void

返回

  • Promise<void>

    Chrome 91 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

活动

onClipboardDataChanged

Chrome 56 及更高版本 
chrome.clipboard.onClipboardDataChanged.addListener(
  callback: function,
)

在剪贴板数据发生变化时触发。需要剪贴板和 firebaseRead 权限，才能向 chrome.clipboard.onClipboardDataChanged 事件添加监听器。触发此事件后，可通过调用 document.execCommand('paste') 获取剪贴板数据。

参数

  • callback

    功能

    callback 参数如下所示：

    ()=>void