chrome.clipboard

說明

chrome.clipboard API 可讓使用者存取剪貼簿資料。在開放網路替代方案推出前，這是 ChromeOS 平台應用程式的臨時解決方案。開放網路解決方案推出後，這項功能就會淘汰，時間可能在 2017 年第 4 季。

權限

clipboard

可用性

開發人員版 僅適用於 ChromeOS

類型

AdditionalDataItem

屬性

  • 資料

    字串

    其他資料項目的內容。如果 type 為「textPlain」，則為純文字字串；如果 type 為「textHtml」，則為標記字串。資料不得超過 2 MB。

  • 類型

    DataItemType

    其他資料項目的類型。

DataItemType

列舉

"textPlain"

"textHtml"

ImageType

支援的圖片類型。

列舉

"png"

"jpeg"

方法

setImageData()

Promise Chrome 57 以上版本 
chrome.clipboard.setImageData(
  imageData: ArrayBuffer,
  type: ImageType,
  additionalItems?: AdditionalDataItem[],
  callback?: function,
): Promise<void>

將圖片資料設定到剪貼簿。

參數

  • imageData

    ArrayBuffer

    Chrome 60 以上版本

    編碼的圖片資料。

  • 類型

    ImageType

    傳遞的圖片類型。

  • additionalItems

    AdditionalDataItem[] 選用

    Chrome 60 以上版本

    用於描述圖片資料的其他資料項目。如果發生錯誤，系統會呼叫回呼，並將 chrome.runtime.lastError 設為錯誤代碼。需要 clipboard 和 clipboardWrite 權限。

  • callback

    函式 選填

    callback 參數如下： 

    () => void

傳回

  • 承諾<void>

    Chrome 91 以上版本

    Promise 僅適用於 Manifest V3 以上版本，其他平台則須使用回呼。

事件

onClipboardDataChanged

Chrome 56 以上版本 
chrome.clipboard.onClipboardDataChanged.addListener(
  callback: function,
)

剪貼簿資料變更時觸發。必須具備 clipboard 和 clipboardRead 權限，才能將事件監聽器新增至 chrome.clipboard.onClipboardDataChanged 事件。這個事件觸發後，呼叫 document.execCommand('paste') 即可取得剪貼簿資料。

參數

  • callback

    函式

    callback 參數如下： 

    () => void