chrome.clipboard

説明

chrome.clipboard API は、ユーザーがクリップボードのデータにアクセスできるようにするためのものです。これは、オープンウェブの代替手段が利用可能になるまで、chromeos プラットフォーム アプリに対する一時的なソリューションです。2017 年第 4 四半期には、オープンウェブ ソリューションが利用可能になり次第非推奨となります。

権限

clipboard

対象

<ph type="x-smartling-placeholder"></ph> Dev チャンネル ChromeOS のみ をご覧ください。

型

AdditionalDataItem

プロパティ

  • データ

    文字列

    追加データ項目の内容。type が「textPlain」の場合は書式なしテキストの文字列またはマークアップ文字列（type が「text まり」）。データのサイズが 2 MB を超えないようにしてください。

  • 追加データ項目の型。

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

    ArrayBuffer

    Chrome 60 以降

    エンコードされた画像データ。

  • type

    ImageType

    渡される画像のタイプ。

  • additionalItems

    AdditionalDataItem[] 省略可

    Chrome 60 以降

    画像データを記述するための追加のデータ項目。エラーが発生した場合は、chrome.runtime.lastError をエラーコードに設定してコールバックが呼び出されます。クリップボードとクリップボードの書き込み権限が必要です。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

イベント

onClipboardDataChanged

Chrome 56 以降 
chrome.clipboard.onClipboardDataChanged.addListener(
  callback: function,
)

クリップボード データが変更されたときに呼び出されます。chrome.clipboard.onClipboardDataChanged イベントにリスナーを追加するには、クリップボードとクリップボードの読み取り権限が必要です。このイベントが発生した後、document.execCommand('paste' を呼び出して、クリップボード データが利用可能になります。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    () => void