chrome.clipboard

Descrição

A API chrome.clipboard é fornecida para permitir que os usuários acessem dados da área de transferência. Essa é uma solução temporária para apps da plataforma ChromeOS até que uma alternativa de Web aberta esteja disponível. Ele será descontinuado quando uma solução de Web aberta estiver disponível, o que pode acontecer no quarto trimestre de 2017.

Permissões

clipboard

Disponibilidade

Canal Dev Somente no ChromeOS

Tipos

AdditionalDataItem

Propriedades

  • dados

    string

    Conteúdo do item de dados adicionais. A string de texto simples se type for "textPlain" ou a string de marcação se type for "textHtml". Os dados não podem exceder 2 MB.

  • Tipo do item de dados adicional.

DataItemType

Enumeração

"textPlain"

"textHtml"

ImageType

Tipos de imagens compatíveis.

Enumeração

"png"

"jpeg"

Métodos

setImageData()

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

Define os dados da imagem na área de transferência.

Parâmetros

  • imageData

    ArrayBuffer

    Chrome 60 ou mais recente

    Os dados de imagem codificados.

  • tipo

    ImageType

    O tipo de imagem transmitida.

  • additionalItems

    AdditionalDataItem[] opcional

    Chrome 60 ou mais recente

    Outros itens de dados para descrever dados de imagem. O callback é chamado com chrome.runtime.lastError definido como código de erro se houver um erro. Requer permissões de área de transferência e clipboardWrite.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 91+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

Eventos

onClipboardDataChanged

Chrome 56 ou mais recente 
chrome.clipboard.onClipboardDataChanged.addListener(
  callback: function,
)

Disparado quando os dados da área de transferência mudam. Requer permissões de área de transferência e clipboardRead para adicionar um listener ao evento chrome.clipboard.onClipboardDataChanged. Depois que esse evento é acionado, os dados da área de transferência ficam disponíveis chamando document.execCommand('paste').

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    () => void