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

將圖片資料設為剪貼簿。

參數

  • imageData

    ArrayBuffer

    Chrome 60 以上版本

    編碼的圖片資料。

  • 類型

    ImageType

    要傳遞的圖片類型。

  • additionalItems

    AdditionalDataItem[] 選用

    Chrome 60 以上版本

    描述圖片資料的其他資料項目。如果發生錯誤，系統會在呼叫回呼時，將 chrome.runtime.lastError 設為錯誤代碼。需要剪貼簿和剪貼簿寫入權限。

  • 回呼

    函式選用

    callback 參數如下所示： 

    ()=>void

傳回

  • Promise<void>

    Chrome 91 以上版本

    Promise 僅支援 Manifest V3 以上版本，其他平台就必須使用回呼。

活動

onClipboardDataChanged

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

剪貼簿資料變更時觸發。需要剪貼簿和剪貼簿讀取權限，才能將事件監聽器新增至 chrome.clipboard.onClipboardDataChanged 事件。這個事件啟動時，系統會呼叫 document.execCommand('paste') 以取得剪貼簿資料。

參數

  • 回呼

    功能

    callback 參數如下所示： 

    ()=>void