chrome.documentScan

Descrição

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

Permissões

documentScan

Disponibilidade

Chrome 44 ou superior Somente ChromeOS

API Document Scan

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

Tipos

CancelScanResponse

Chrome 125 ou versões mais recentes

Propriedades

  • job

    string

    Fornece o mesmo identificador de 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, a verificação foi cancelada e o scanner está pronto para iniciar uma nova verificação. Se o resultado for OperationResult.DEVICE_BUSY , o scanner ainda está processando o cancelamento solicitado. o autor da chamada precisa aguardar um pouco e tentar a solicitação novamente. Outros valores de resultados indicam um erro permanente que não deve ser repetido.

CloseScannerResponse

Chrome 125 ou versões mais recentes

Propriedades

  • resultado

    OperationResult

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

  • scannerHandle

    string

    O mesmo identificador do scanner que foi transmitido para closeScanner.

Configurability

Chrome 125 ou versões mais recentes

Como uma opção pode ser alterada.

Enumeração

"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 ativando ou pressionando um botão no scanner.

ConnectionType

Chrome 125 ou versões mais recentes

Indica como o scanner está conectado ao computador.

Enumeração

"NÃO ESPECIFICADO"

"USB"

"REDE"

ConstraintType

Chrome 125 ou versões mais recentes

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

Enumeração

"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 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 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 versões mais recentes

Propriedades

  • Local

    booleano opcional

    Só retorne scanners que estejam diretamente conectados ao computador.

  • seguro

    booleano opcional

    Só retorna scanners que usam um transporte seguro, como USB ou TLS.

GetOptionGroupsResponse

Chrome 125 ou versões mais recentes

Propriedades

  • grupos

    OptionGroup[] opcional

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

  • resultado

    OperationResult

    O resultado do recebimento dos 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 versões mais recentes

Propriedades

  • resultado

    OperationResult

    O resultado da enumeração. É possível retornar resultados parciais mesmo que isso indique um erro.

  • scanners

    ScannerInfo [em inglês]

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

OpenScannerResponse

Chrome 125 ou versões mais recentes

Propriedades

  • opções

    objeto opcional

    Se result for SUCCESS, fornece 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 versões mais recentes

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

Enumeração

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

"SUCCESS"
A operação foi bem-sucedida.

"UNSUPPORTED"
A operação não é compatível.

"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 dado incorreto para a opção subjacente.

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

"ADF_JAMMED"
O alimentador de documentos está obstruído.

"ADF_EMPTY"
O alimentador de documentos está vazio.

"COVER_OPEN"
A capa da mesa está aberta.

"IO_ERROR"
Ocorreu um erro de comunicação com o dispositivo.

"ACCESS_DENIED"
O dispositivo exige autenticação.

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

"UNREACHABLE"
O dispositivo não está acessível.

"MISSING"
O dispositivo está desconectado.

"INTERNAL_ERROR"
Ocorreu um erro em algum lugar diferente do aplicativo de chamada.

OptionConstraint

Chrome 125 ou versões mais recentes

Propriedades

  • list

    string[] | number[] opcional

  • max

    número opcional

  • min

    número opcional

  • quantitativa

    número opcional

OptionGroup

Chrome 125 ou versões mais recentes

Propriedades

  • membros

    string[]

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

  • título

    string

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

OptionSetting

Chrome 125 ou versões mais recentes

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 | número | boolean | number[] opcional

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

OptionType

Chrome 125 ou versões mais recentes

O tipo de dados de uma opção.

Enumeração

"UNKNOWN"
O tipo de dados da opção é desconhecido. A propriedade value não será definida.

"BOOL"
A propriedade value será uma das truefalsas.

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

"FIXED"
Um duplo no intervalo -32768-32767.9999 com resolução de 1/65535. A propriedade value será double ou double[], dependendo de a opção ter 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 bytes, exceto NUL ("\0"). A propriedade value será uma DOMString.

"Botão"
Uma opção desse 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 digitada por botão pode ser usada por um driver de digitalização para fornecer um meio de selecionar valores padrão ou informar um alimentador automático de documentos para avançar para a próxima folha de papel.

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

OptionUnit

Chrome 125 ou versões mais recentes

Indica o tipo de dados para ScannerOption.unit.

Enumeração

"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 verificação.

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

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

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

ReadScanDataResponse

Chrome 125 ou versões mais recentes

Propriedades

  • dados

    ArrayBuffer opcional

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

  • estimatedCompletion

    número opcional

    Se result for SUCCESS, uma estimativa de quanto do total de dados de verificação foi entregue 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 conterá o próximo bloco de dados de imagem (possivelmente com comprimento zero) que está pronto para leitura. Se o valor for EOF, data conterá o último bloco de dados da imagem.

ScannerInfo

Chrome 125 ou versões mais recentes

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 podem ser solicitados para as verificações retornadas.

  • fabricante

    string

    O fabricante do scanner.

  • modelo

    string

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

  • nome

    string

    Um nome legível para o scanner 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 protocolos.

  • scannerId

    string

    O ID de um scanner específico.

  • seguro

    booleano

    Se for "true", o transporte da conexão do scanner não poderá ser interceptado por um listener passivo, como TLS ou USB.

ScannerOption

Chrome 125 ou versões mais recentes

Propriedades

  • configurabilidade

    Configurabilidade

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

  • restrição

    OptionConstraint opcional

    Define OptionConstraint na opção de scanner atual.

  • descrição

    string

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

  • isActive

    booleano

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

  • isAdvanced

    booleano

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

  • isAutoSettable

    booleano

    Pode ser definido automaticamente pelo driver do scanner.

  • isDetectable

    booleano

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

  • isEmulated

    booleano

    Emulado pelo driver do scanner, se verdadeiro.

  • nome

    string

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

  • título

    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 desta opção.

  • valor

    string | número | boolean | number[] opcional

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

ScanOptions

Propriedades

  • maxImages

    número opcional

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

  • mimeTypes

    string[] opcional

    Os tipos MIME aceitos pelo autor da chamada.

ScanResults

Propriedades

  • dataUrls

    string[]

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

  • mimeType

    string

    É o tipo MIME da dataUrls.

SetOptionResult

Chrome 125 ou versões mais recentes

Propriedades

  • nome

    string

    Indica o nome da opção que foi definida.

  • resultado

    OperationResult

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

SetOptionsResponse

Chrome 125 ou versões mais recentes

Propriedades

  • opções

    objeto opcional

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

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

  • resultados

    SetOptionResult[]

    Uma matriz de resultados, um para cada OptionSetting transmitido.

  • scannerHandle

    string

    Fornece a alça do leitor transmitida para setOptions().

StartScanOptions

Chrome 125 ou versões mais recentes

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á o máximo de bytes verificados retornados em uma única resposta readScanData a esse valor. O menor valor permitido é 32.768 (32 KB). Se essa propriedade não for especificada, o tamanho de uma parte retornada pode ser tão grande quanto toda a imagem digitalizada.

StartScanResponse

Chrome 125 ou versões mais recentes

Propriedades

  • job

    string opcional

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

  • resultado

    OperationResult

    O resultado do início de 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()

Promessa Chrome 125 ou versões mais recentes 
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 para ele.

Parâmetros

  • job

    string

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

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (response: CancelScanResponse) => void

Retorna

  • Promise<CancelScanResponse>

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

closeScanner()

Promessa Chrome 125 ou versões mais recentes 
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 para ele. Mesmo que a resposta não seja bem-sucedida, o identificador fornecido se torna inválido e não deve ser usado para 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 opcional

    O parâmetro callback tem esta aparência: 

    (response: CloseScannerResponse) => void

Retorna

  • Promise<CloseScannerResponse>

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getOptionGroups()

Promessa Chrome 125 ou versões mais recentes 
chrome.documentScan.getOptionGroups(
  scannerHandle: string,
  callback?: function,
)

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

Parâmetros

Retorna

  • Promise<GetOptionGroupsResponse>

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getScannerList()

Promessa Chrome 125 ou versões mais recentes 
chrome.documentScan.getScannerList(
  filter: DeviceFilter,
  callback?: function,
)

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

Parâmetros

Retorna

  • Promise<GetScannerListResponse>

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

openScanner()

Promessa Chrome 125 ou versões mais recentes 
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 retorno de chamada for passado para essa função, os dados retornados serão passados 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 opcional

    O parâmetro callback tem esta aparência: 

    (response: OpenScannerResponse) => void

Retorna

  • Promise<OpenScannerResponse>

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

readScanData()

Promessa Chrome 125 ou versões mais recentes 
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 para ele.

**Observação:**é válido que um resultado de resposta seja SUCCESS com um membro data de comprimento zero. Isso significa que o scanner ainda está funcionando, mas ainda não tem dados adicionais prontos. O autor da chamada precisa aguardar um pouco 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 final diferente de zero.

Parâmetros

Retorna

  • Promise<ReadScanDataResponse>

    As promessas só têm suporte no Manifesto 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 retorno de chamada for passado para essa função, os dados retornados serão passados a ela.

Parâmetros

  • opções

    ScanOptions

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

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (result: ScanResults) => void

Retorna

  • Promise<ScanResults>

    Chrome 96 ou versão mais recente

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

setOptions()

Promessa Chrome 125 ou versões mais recentes 
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 todos os valores na ordem do objeto OptionSetting transmitido. Se um callback for usado, o objeto será passado para ele.

Parâmetros

  • scannerHandle

    string

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

  • opções

    OptionSetting[]

    Uma lista de objetos OptionSetting a serem aplicados ao scanner.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (response: SetOptionsResponse) => void

Retorna

  • Promise<SetOptionsResponse>

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

startScan()

Promessa Chrome 125 ou versões mais recentes 
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 para 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 de uma 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.

  • opções

    StartScanOptions

    Um objeto StartScanOptions que indica 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 opcional

    O parâmetro callback tem esta aparência: 

    (response: StartScanResponse) => void

Retorna

  • Promise<StartScanResponse>

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.