chrome.clipboard

Beschrijving

De chrome.clipboard API wordt aangeboden om gebruikers toegang te geven tot gegevens op het klembord. Dit is een tijdelijke oplossing voor ChromeOS-platform-apps totdat er een alternatief voor het open web beschikbaar is. Deze functie wordt beëindigd zodra de open-weboplossing beschikbaar is. Dit is mogelijk in het 4e kwartaal van 2017.

Rechten

clipboard

Beschikbaarheid

Dev-kanaal Alleen ChromeOS

Typen

AdditionalDataItem

Eigenschappen

  • gegevens

    tekenreeks

    Content van het aanvullende gegevensitem. De tekenreeks met platte tekst als type textPlain is of de opmaaktekenreeks als type textHtml is. De gegevens mogen niet groter zijn dan 2 MB.

  • Type van het aanvullende gegevensitem.

DataItemType

Enum

"textPlain"

"textHtml"

ImageType

Ondersteunde afbeeldingstypen.

Enum

"png"

"jpeg"

Methoden

setImageData()

Promise Chrome 57+ 
chrome.clipboard.setImageData(
  imageData: ArrayBuffer,
  type: ImageType,
  additionalItems?: AdditionalDataItem[],
  callback?: function,
): Promise<void>

Stelt afbeeldingsgegevens in op het klembord.

Parameters

  • imageData

    ArrayBuffer

    Chrome 60+

    De gecodeerde afbeeldingsgegevens.

  • type

    ImageType

    Het type afbeelding dat wordt doorgegeven.

  • additionalItems

    AdditionalDataItem[] optioneel

    Chrome 60+

    Aanvullende gegevensitems om afbeeldingsgegevens te beschrijven. De callback wordt aangeroepen met chrome.runtime.lastError ingesteld op de foutcode als er een fout is. Vereist de rechten clipboard en clipboardWrite.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    () => void

Retourzendingen

  • Promise<void>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

Evenementen

onClipboardDataChanged

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

Wordt geactiveerd als de klembordgegevens veranderen. Vereist de rechten clipboard en clipboardRead om een listener toe te voegen aan de gebeurtenis chrome.clipboard.onClipboardDataChanged. Nadat deze gebeurtenis is geactiveerd, zijn de klembordgegevens beschikbaar door document.execCommand('paste') aan te roepen.

Parameters

  • callback

    functie

    De parameter callback ziet er zo uit: 

    () => void