説明
chrome.clipboard
API は、ユーザーがクリップボードのデータにアクセスできるようにするために提供されています。これは、オープンウェブの代替手段が利用可能になるまでの間、ChromeOS プラットフォーム アプリに対する一時的な解決策です。オープン ウェブ ソリューションが利用可能になり次第(2017 年第 4 四半期を予定)、サポートを終了します。
権限
clipboard
対象
型
AdditionalDataItem
プロパティ
-
データ
文字列
追加データ項目の内容。
type
が「textPlain」の場合は書式なしテキスト文字列、type
が「textHtml」の場合はマークアップ文字列。データは 2 MB を超えないようにしてください。 -
type
追加データ項目のタイプ。
DataItemType
列挙型
"textPlain"
"textHtml"
ImageType
サポートされている画像タイプ。
列挙型
"png"
"jpeg"
メソッド
setImageData()
chrome.clipboard.setImageData(
imageData: ArrayBuffer,
type: ImageType,
additionalItems?: AdditionalDataItem[],
callback?: function,
): Promise<void>
画像データをクリップボードに設定します。
パラメータ
-
imageData
ArrayBuffer
Chrome 60 以降エンコードされた画像データ。
-
type
渡される画像のタイプ。
-
additionalItems
AdditionalDataItem[] 省略可
Chrome 60 以降画像データを記述するための追加のデータ項目。エラーが発生した場合、コールバックは
chrome.runtime.lastError
がエラーコードに設定された状態で呼び出されます。clipboard と clipboardWrite の権限が必要です。 -
callback
関数 省略可
callback
パラメータは次のようになります。() => void
戻り値
-
Promise<void>
Chrome 91 以降Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
イベント
onClipboardDataChanged
chrome.clipboard.onClipboardDataChanged.addListener(
callback: function,
)
クリップボードのデータが変更されたときに呼び出されます。chrome.clipboard.onClipboardDataChanged イベントにリスナーを追加するには、clipboard 権限と clipboardRead 権限が必要です。このイベントが発生すると、document.execCommand('paste') を呼び出すことでクリップボードのデータを利用できるようになります。
パラメータ
-
callback
関数
callback
パラメータは次のようになります。() => void