chrome.clipboard

说明

chrome.clipboard API 旨在允许用户访问剪贴板中的数据。这是针对 chromeos 平台应用的临时解决方案，直到开放网络替代方案推出为止。开放网络解决方案推出后（可能在 2017 年第 4 季度推出），它将弃用。

权限

clipboard

可用性

<ph type="x-smartling-placeholder"></ph> 开发者版 仅限 ChromeOS

类型

AdditionalDataItem

属性

  • 数据

    字符串

    附加数据项的内容。如果 type 为“textPlain”，则为纯文本字符串或标记字符串（如果 type 为“textHTML”）。数据大小不得超过 2 MB。

  • 类型

    DataItemType

    其他数据项的类型。

DataItemType

枚举

"textPlain"

"textHTML"

ImageType

支持的图片类型。

枚举

“png”

“jpeg”

方法

setImageData()

<ph type="x-smartling-placeholder"></ph> 承诺 Chrome 57 及更高版本 
chrome.clipboard.setImageData(
  imageData: ArrayBuffer,
  type: ImageType,
  additionalItems?: AdditionalDataItem[],
  callback?: function,
)

将图片数据复制到剪贴板。

参数

  • imageData

    数组缓冲区

    Chrome 60 及更高版本

    经过编码的图片数据。

  • 类型

    ImageType

    传递的图片类型。

  • additionalItems

    AdditionalDataItem[] 可选

    Chrome 60 及更高版本

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

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • 承诺<void>

    Chrome 91 及更高版本

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

事件

onClipboardDataChanged

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

剪贴板数据更改时触发。要将监听器添加到 chrome.clipboard.onClipboardDataChanged 事件，需要剪贴板和剪贴板读取权限。此事件触发后，即可通过调用 document.execCommand('paste') 获取剪贴板数据。

参数

  • callback

    函数

    callback 参数如下所示： 

    () => void