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,
)

將圖片資料設為剪貼簿。

參數

  • 圖片資料

    ArrayBuffer

    Chrome 60 以上版本

    經過編碼的圖片資料。

  • 類型

    ImageType

    傳遞的圖片類型。

  • additionalItems

    AdditionalDataItem[] 選用

    Chrome 60 以上版本

    用於描述圖片資料的其他資料項目。如果發生錯誤，則會在 chrome.runtime.lastError 設為錯誤代碼，呼叫回呼。必須具備「剪貼簿」和「剪貼簿寫入」權限。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    () => void

傳回

  • 承諾<void>

    Chrome 91 以上版本

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

活動

onClipboardDataChanged

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

剪貼簿資料變更時觸發。需要剪貼簿和剪貼簿讀取權限，才能將事件監聽器新增至 chrome.clipboard.onClipboardDataChanged 事件。在此事件觸發後，呼叫 document.execCommand('paste' 即可取得剪貼簿資料。

參數

  • 回呼

    函式

    callback 參數如下所示： 

    () => void