chrome.documentScan

Descrição

Use a API chrome.documentScan para descobrir e recuperar imagens dos scanners de documentos anexados.

Permissões

documentScan

Disponibilidade

Chrome 44+ Apenas no ChromeOS

API Document Scan

A API Document Scan foi projetada para permitir que apps e extensões visualizem o conteúdo de documentos em papel em um scanner de documentos anexado.

Tipos

CancelScanResponse

Chrome 125 ou mais recente

Propriedades

  • job

    string

    Fornece o mesmo identificador do job que foi transmitido para cancelScan().

  • resultado

    OperationResult

    O resultado da verificação de cancelamento do back-end. Se o resultado for OperationResult.SUCCESS ou OperationResult.CANCELLED, isso significa que a verificação foi cancelada e o scanner está pronto para iniciar uma nova verificação. Se o resultado for OperationResult.DEVICE_BUSY , isso significa que o scanner ainda está processando o cancelamento solicitado. O autor da chamada deve aguardar um pouco e tentar a solicitação novamente. Outros valores de resultado indicam um erro permanente que não deve ser repetido.

CloseScannerResponse

Chrome 125 ou mais recente

Propriedades

  • resultado

    OperationResult

    O resultado do fechamento do scanner. Mesmo que o valor não seja SUCCESS, o identificador será inválido e não poderá ser usado em outras operações.

  • scannerHandle

    string

    O mesmo identificador do scanner que foi transmitido para closeScanner.

Configurability

Chrome 125 ou mais recente

Como uma opção pode ser alterada.

Tipo enumerado

"NOT_CONFIGURABLE"
A opção é somente leitura.

"SOFTWARE_CONFIGURABLE"
A opção pode ser definida no software.

"HARDWARE_CONFIGURABLE"
A opção pode ser definida pelo usuário pressionando ou pressionando um botão no scanner.

ConnectionType

Chrome 125 ou mais recente

Indica como o scanner está conectado ao computador.

Tipo enumerado

"USB"

ConstraintType

Chrome 125 ou mais recente

O tipo de dados da restrição representado por uma OptionConstraint.

Tipo enumerado

"INT_RANGE"
é a restrição em um intervalo de valores OptionType.INT. As propriedades min, max e quant de OptionConstraint serão long, e a propriedade list delas não será definida.

"FIXED_RANGE"
a restrição em um intervalo de valores OptionType.FIXED. As propriedades min, max e quant de OptionConstraint serão double, e a propriedade list delas não será definida.

"INT_LIST"
a restrição em uma lista específica de valores OptionType.INT. A propriedade OptionConstraint.list vai conter valores long, e as outras propriedades não serão definidas.

"FIXED_LIST"
é a restrição em uma lista específica de valores OptionType.FIXED. A propriedade OptionConstraint.list vai conter valores double, e as outras propriedades não serão definidas.

"STRING_LIST"
A restrição em uma lista específica de valores OptionType.STRING. A propriedade OptionConstraint.list vai conter valores DOMString, e as outras propriedades não serão definidas.

DeviceFilter

Chrome 125 ou mais recente

Propriedades

  • Local

    booleano opcional

    Devolva apenas scanners que estejam diretamente conectados ao computador.

  • seguro

    booleano opcional

    Devolva apenas scanners que usam um transporte seguro, como USB ou TLS.

GetOptionGroupsResponse

Chrome 125 ou mais recente

Propriedades

  • grupos

    OptionGroup[] opcional

    Se result for SUCCESS, será fornecida uma lista de grupos de opções na ordem fornecida pelo driver do scanner.

  • resultado

    OperationResult

    O resultado de conseguir os grupos de opções. Se o valor for SUCCESS, a propriedade groups será preenchida.

  • scannerHandle

    string

    O mesmo identificador do scanner que foi transmitido para getOptionGroups.

GetScannerListResponse

Chrome 125 ou mais recente

Propriedades

  • resultado

    OperationResult

    O resultado da enumeração. Resultados parciais podem ser retornados mesmo que isso indique um erro.

  • scanners

    ScannerInfo[]

    Uma lista possivelmente vazia de scanners que correspondem ao DeviceFilter fornecido.

OpenScannerResponse

Chrome 125 ou mais recente

Propriedades

  • do modelo.

    objeto opcional

    Se result for SUCCESS, vai fornecer um mapeamento de chave-valor em que a chave é uma opção específica do dispositivo e o valor é uma instância de ScannerOption.

  • resultado

    OperationResult

    O resultado da abertura do scanner. Se o valor for SUCCESS, as propriedades scannerHandle e options serão preenchidas.

  • scannerHandle

    string opcional

    Se result for SUCCESS, um identificador para o scanner que pode ser usado em outras operações.

  • scannerId

    string

    O ID do scanner transmitido para openScanner().

OperationResult

Chrome 125 ou mais recente

Um enum que indica o resultado de cada operação.

Tipo enumerado

"UNKNOWN"
Ocorreu uma falha desconhecida ou genérica.

"SUCCESS"
A operação foi concluída.

"INCOMPATÍVEL"
A operação não é aceita.

"CANCELLED"
A operação foi cancelada.

"DEVICE_BUSY"
O dispositivo está ocupado.

"INVALID"
Os dados ou um argumento passados para o método não são válidos.

"WRONG_TYPE"
O valor fornecido é o tipo de dados errado para a opção subjacente.

"EOF"
Não há mais dados disponíveis.

"ADF_JAMMED"
O alimentador de documentos está trancado.

"ADF_EMPTY"
O alimentador de documentos está vazio.

"COVER_OPEN"
A capa da cama plana está aberta.

"IO_ERROR"
Ocorreu um erro ao se comunicar com o dispositivo.

"ACCESS_DENIED"
O dispositivo exige autenticação.

"NO_MEMORY"
Não há memória suficiente disponível no Chromebook para concluir a operação.

INALCENTE
O dispositivo está inacessível.

AUSENTE
O dispositivo está desconectado.

"INTERNAL_ERROR"
Ocorreu um erro além do aplicativo de chamada.

OptionConstraint

Chrome 125 ou mais recente

Propriedades

  • lista

    string[]|number[] optional

  • max

    número opcional

  • min

    número opcional

  • quant.

    número opcional

OptionGroup

Chrome 125 ou mais recente

Propriedades

  • membros

    string[]

    Uma matriz de nomes de opções na ordem fornecida pelo driver.

  • title

    string

    Fornece um título para impressão, por exemplo, "Opções de geometria".

OptionSetting

Chrome 125 ou mais recente

Propriedades

  • nome

    string

    Indica o nome da opção a ser definida.

  • Tipo

    OptionType

    Indica o tipo de dados da opção. O tipo de dados solicitado precisa corresponder ao tipo de dados real da opção subjacente.

  • valor

    string|number|boolean|number[] optional

    Indica o valor a ser definido. Não defina a configuração automática para opções com autoSettable ativado. O tipo de dados fornecido para value precisa corresponder a type.

OptionType

Chrome 125 ou mais recente

O tipo de dados de uma opção.

Tipo enumerado

"UNKNOWN"
O tipo de dados da opção é desconhecido. A propriedade value será deixada sem definição.

"BOOL"
A propriedade value será truefalsa.

"INT"
Um número inteiro de 32 bits assinado. A propriedade value será longa ou longa[], dependendo de a opção assumir mais de um valor.

"FIXED"
Um duplo no intervalo -32768-32767.9999 com uma resolução de 1/65535. A propriedade value será dupla ou dupla[] se a opção assumir mais de um valor. Valores duplos que não podem ser representados exatamente serão arredondados para o intervalo e a precisão disponíveis.

"STRING"
Uma sequência de qualquer byte, exceto NUL ('\0'). A propriedade value será uma DOMString.

"BOTÃO"
Uma opção deste tipo não tem valor. Em vez disso, definir uma opção desse tipo causa um efeito colateral específico da opção no driver do scanner. Por exemplo, uma opção do tipo botão pode ser usada por um driver de scanner para selecionar valores padrão ou dizer a um alimentador automático de documentos para avançar para a próxima folha de papel.

"GROUP"
Opção de agrupamento. Nenhum valor. Isso está incluído para compatibilidade, mas normalmente não é retornado em valores ScannerOption. Use getOptionGroups() para recuperar a lista de grupos com as opções de membros.

OptionUnit

Chrome 125 ou mais recente

Indica o tipo de dados de ScannerOption.unit.

Tipo enumerado

"UNITLESS"
O valor é um número sem unidade. Por exemplo, pode ser um limite.

"PIXEL"
O valor é um número de pixels, por exemplo, dimensões de verificação.

"BIT"
O valor é o número de bits, por exemplo, profundidade de cor.

"MM"
O valor é medido em milímetros, por exemplo, dimensões de leitura.

"DPI"
O valor é medido em pontos por polegada, por exemplo, resolução.

"PERCENT"
O valor é uma porcentagem, por exemplo, brilho.

"MICROSECUNDÁRIO"
O valor é medido em microssegundos, por exemplo, tempo de exposição.

ReadScanDataResponse

Chrome 125 ou mais recente

Propriedades

  • dados

    ArrayBuffer opcional

    Se result for SUCCESS, conterá o próximo bloco de dados de imagem digitalizados. Se result for EOF, contém o último bloco de dados da imagem verificada.

  • estimatedCompletion

    número opcional

    Se result for SUCCESS, é uma estimativa de quantos dados totais da verificação foram entregues até o momento, no intervalo de 0 a 100.

  • job

    string

    Fornece o identificador do job transmitido para readScanData().

  • resultado

    OperationResult

    O resultado da leitura de dados. Se o valor for SUCCESS, data vai conter o próximo bloco de dados de imagem (possivelmente com comprimento zero) que está pronto para leitura. Se o valor for EOF, o data vai conter o último bloco de dados da imagem.

ScannerInfo

Chrome 125 ou mais recente

Propriedades

  • connectionType

    ConnectionType

    Indica como o scanner está conectado ao computador.

  • deviceUuid

    string

    Para correspondência com outras entradas ScannerInfo que apontam para o mesmo dispositivo físico.

  • imageFormats

    string[]

    Uma matriz de tipos MIME que pode ser solicitada para verificações retornadas.

  • fabricante

    string

    O fabricante do scanner.

  • model

    string

    O modelo do scanner, se disponível, ou uma descrição genérica.

  • nome

    string

    Um nome legível para o scanner a exibir na interface.

  • protocolType

    string

    Uma descrição legível do protocolo ou driver usado para acessar o scanner, como Mopria, WSD ou epsonds. Isso é útil principalmente para permitir que um usuário escolha entre protocolos se um dispositivo oferecer suporte a vários deles.

  • scannerId

    string

    O ID de um scanner específico.

  • seguro

    boolean

    Se verdadeiro, o transporte da conexão do scanner não pode ser interceptado por um listener passivo, como TLS ou USB.

ScannerOption

Chrome 125 ou mais recente

Propriedades

  • configurabilidade

    Configurabilidade

    Indica se e como a opção pode ser alterada.

  • restrição

    OptionConstraint opcional

    Define OptionConstraint na opção atual do leitor.

  • description

    string

    Uma descrição mais longa da opção.

  • isActive

    boolean

    Indica que a opção está ativa e pode ser definida ou recuperada. Se for falso, a propriedade value não será definida.

  • isAdvanced

    boolean

    Indica que a interface não deve exibir essa opção por padrão.

  • isAutoSettable

    boolean

    Pode ser definido automaticamente pelo driver do scanner.

  • isDetectable

    boolean

    Indica que essa opção pode ser detectada no software.

  • isEmulated

    boolean

    Emulado pelo driver do scanner, se verdadeiro.

  • nome

    string

    O nome da opção usando letras ASCII minúsculas, números e traços. Diacríticos não são permitidos.

  • title

    string

    Um título de uma linha para impressão.

  • Tipo

    OptionType

    O tipo de dados contido na propriedade value, que é necessária para definir essa opção.

  • unidade

    OptionUnit

    A unidade de medida da opção.

  • valor

    string|number|boolean|number[] optional

    Valor atual da opção, se relevante. O tipo de dados dessa propriedade precisa corresponder ao tipo de dados especificado em type.

ScanOptions

Propriedades

  • maxImages

    número opcional

    O número de imagens digitalizadas permitidas. O padrão é 1.

  • mimeTypes

    string[] opcional

    Os tipos MIME que são aceitos pelo autor da chamada.

ScanResults

Propriedades

  • dataUrls

    string[]

    Uma matriz de URLs de imagens de dados em um formato que pode ser passado como o valor "src" para uma tag de imagem.

  • mimeType

    string

    O tipo MIME do dataUrls.

SetOptionResult

Chrome 125 ou mais recente

Propriedades

  • nome

    string

    Indica o nome da opção definida.

  • resultado

    OperationResult

    Indica o resultado da configuração da opção.

SetOptionsResponse

Chrome 125 ou mais recente

Propriedades

  • do modelo.

    objeto opcional

    Um mapeamento de chave-valor atualizado dos nomes de opções para valores ScannerOption contendo a nova configuração depois de tentar definir todas as opções fornecidas. Ele tem a mesma estrutura da propriedade options no OpenScannerResponse.

    Essa propriedade será definida mesmo que algumas opções não sejam definidas corretamente, mas não será definida se a recuperação da configuração atualizada falhar (por exemplo, se o scanner estiver desconectado no meio da verificação).

  • resultados

    SetOptionResult[]

    Uma matriz de resultados, um para cada OptionSetting transmitido.

  • scannerHandle

    string

    Fornece o identificador do scanner transmitido para setOptions().

StartScanOptions

Chrome 125 ou mais recente

Propriedades

  • formato

    string

    Especifica o tipo MIME para retornar os dados verificados.

  • maxReadSize

    número opcional

    Se um valor diferente de zero for especificado, limitará a esse valor o número máximo de bytes verificados retornados em uma única resposta readScanData. O menor valor permitido é 32768 (32 KB). Se essa propriedade não for especificada, o tamanho da parte retornada poderá ser tão grande quanto a imagem inteira digitalizada.

StartScanResponse

Chrome 125 ou mais recente

Propriedades

  • job

    string opcional

    Se result for SUCCESS, fornece um identificador que pode ser usado para ler dados de verificação ou cancelar o job.

  • resultado

    OperationResult

    O resultado de iniciar uma verificação. Se o valor for SUCCESS, a propriedade job será preenchida.

  • scannerHandle

    string

    Fornece o mesmo identificador do scanner que foi transmitido para startScan().

Métodos

cancelScan()

Promise Chrome 125+ 
chrome.documentScan.cancelScan(
  job: string,
  callback?: function,
)

Cancela uma verificação iniciada e retorna uma promessa que é resolvida com um objeto CancelScanResponse. Se um callback for usado, o objeto será passado a ele.

Parâmetros

  • job

    string

    O identificador de um job de verificação ativo retornado anteriormente de uma chamada para startScan.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (response: CancelScanResponse)=>void

Retorna

  • Promessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

closeScanner()

Promise Chrome 125+ 
chrome.documentScan.closeScanner(
  scannerHandle: string,
  callback?: function,
)

Fecha o scanner com o identificador transmitido e retorna uma promessa que é resolvida com um objeto CloseScannerResponse. Se um callback for usado, o objeto será passado a ele. Mesmo que a resposta não seja bem-sucedida, o identificador fornecido se torna inválido e não deve ser usado em outras operações.

Parâmetros

  • scannerHandle

    string

    Especifica o identificador de um scanner aberto que foi retornado anteriormente de uma chamada para openScanner.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (response: CloseScannerResponse)=>void

Retorna

  • Promessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getOptionGroups()

Promise Chrome 125+ 
chrome.documentScan.getOptionGroups(
  scannerHandle: string,
  callback?: function,
)

Extrai os nomes dos grupos e as opções de participantes de um scanner aberto anteriormente pelo openScanner. Esse método retorna uma promessa que é resolvida com um objeto GetOptionGroupsResponse. Se um callback for passado para essa função, os dados retornados serão transmitidos a ela.

Parâmetros

Retorna

  • Promessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getScannerList()

Promise Chrome 125+ 
chrome.documentScan.getScannerList(
  filter: DeviceFilter,
  callback?: function,
)

Recebe a lista de verificadores disponíveis e retorna uma promessa que é resolvida com um objeto GetScannerListResponse. Se um callback for passado para essa função, os dados retornados serão transmitidos a ela.

Parâmetros

Retorna

  • Promessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

openScanner()

Promise Chrome 125+ 
chrome.documentScan.openScanner(
  scannerId: string,
  callback?: function,
)

Abre um scanner para acesso exclusivo e retorna uma promessa que é resolvida com um objeto OpenScannerResponse. Se um callback for passado para essa função, os dados retornados serão transmitidos a ela.

Parâmetros

  • scannerId

    string

    O ID de um scanner a ser aberto. Esse valor é aquele retornado de uma chamada anterior para getScannerList.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (response: OpenScannerResponse)=>void

Retorna

  • Promessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

readScanData()

Promise Chrome 125+ 
chrome.documentScan.readScanData(
  job: string,
  callback?: function,
)

Lê o próximo bloco de dados de imagem disponíveis de um gerenciador de job ativo e retorna uma promessa que é resolvida com um objeto ReadScanDataResponse. Se um callback for usado, o objeto será passado a ele.

**Observação**: o resultado de uma resposta pode ser SUCCESS com um membro data de tamanho zero. Isso significa que o scanner ainda está funcionando, mas não tem dados adicionais prontos. O autor da chamada precisa aguardar e tentar novamente.

Quando o job de verificação for concluído, a resposta terá o valor de resultado EOF. Essa resposta pode conter um membro data diferente de zero.

Parâmetros

Retorna

  • Promessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

scan()

Promessa 
chrome.documentScan.scan(
  options: ScanOptions,
  callback?: function,
)

Executa uma verificação de documentos e retorna uma promessa que é resolvida com um objeto ScanResults. Se um callback for passado para essa função, os dados retornados serão transmitidos a ela.

Parâmetros

  • do modelo.

    ScanOptions

    Um objeto que contém parâmetros de verificação.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (result: ScanResults)=>void

Retorna

  • Promise<ScanResults>

    Chrome 96 ou mais recente

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

setOptions()

Promise Chrome 125+ 
chrome.documentScan.setOptions(
  scannerHandle: string,
  options: OptionSetting[],
  callback?: function,
)

Define as opções no scanner especificado e retorna uma promessa que é resolvida com um objeto SetOptionsResponse contendo o resultado da tentativa de definir cada valor na ordem do objeto OptionSetting transmitido. Se um callback for usado, o objeto será passado a ele.

Parâmetros

  • scannerHandle

    string

    A alça do scanner em que as opções serão definidas. Precisa ser um valor retornado anteriormente de uma chamada para openScanner.

  • do modelo.

    OptionSetting[]

    Uma lista de objetos OptionSetting a serem aplicados ao scanner.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (response: SetOptionsResponse)=>void

Retorna

  • Promessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

startScan()

Promise Chrome 125+ 
chrome.documentScan.startScan(
  scannerHandle: string,
  options: StartScanOptions,
  callback?: function,
)

Inicia uma verificação no scanner especificado e retorna uma promessa que é resolvida com um StartScanResponse. Se um callback for usado, o objeto será passado a ele. Se a chamada for bem-sucedida, a resposta incluirá um identificador de job que pode ser usado em chamadas subsequentes para ler os dados da verificação ou cancelar uma verificação.

Parâmetros

  • scannerHandle

    string

    A alça de um scanner aberto. Precisa ser um valor retornado anteriormente de uma chamada para openScanner.

  • do modelo.

    StartScanOptions

    Um objeto StartScanOptions indicando as opções a serem usadas para a verificação. A propriedade StartScanOptions.format precisa corresponder a uma das entradas retornadas no ScannerInfo do scanner.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (response: StartScanResponse)=>void

Retorna

  • Promessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.