chrome.clipboard

説明

chrome.clipboard API は、ユーザーがクリップボードのデータにアクセスできるようにするために用意されています。これは、オープンウェブの代替手段が提供されるまでの chromeos プラットフォーム アプリの一時的な解決策です。2017 年第 4 四半期にオープンウェブ ソリューションが利用可能になった時点で、サポートを終了する予定です。

権限

clipboard

対象

Dev チャンネル ChromeOS のみ

型

AdditionalDataItem

プロパティ

  • data

    文字列

    追加データ項目の内容です。type が「textPlain」の場合は書式なしテキスト文字列、type が「textHTML」の場合はマークアップ文字列。データは 2MB 以下である必要があります。

  • タイプ

    DataItemType

    追加データ項目の型。

DataItemType

Enum

ImageType

サポートされている画像タイプ。

Enum

"png"

"jpeg"

Methods

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

    関数（省略可）

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

    ()=>void

戻り値

  • Promise<void>

    Chrome 91 以降

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

イベント

onClipboardDataChanged

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

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

パラメータ

  • callback

    機能

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

    ()=>void