chrome.documentScan

Wichtig: Diese API funktioniert nur unter ChromeOS.

Beschreibung

Verwenden Sie die chrome.documentScan API, um Bilder von angehängten Dokumentenscannern zu ermitteln und abzurufen.

Berechtigungen

documentScan

Verfügbarkeit

Chrome (ab Version 44) Nur ChromeOS

Document Scan API

Die Document Scan API ermöglicht Apps und Erweiterungen das Anzeigen der Inhalt von Papierdokumenten in einem angeschlossenen Dokumentenscanner.

Hinweis:Diese API hängt von Funktionen des Betriebssystems ab, die je nach auf dem zugrunde liegenden Betriebssystem. Zum Zeitpunkt der Abfassung dieser E-Mail gilt nur ChromeOS für bestimmte USB-Geräte funktionieren bekanntermaßen fehlerfrei.

Typen

CancelScanResponse

Chrome 125 oder höher

Attribute

• Job

  String

  Stellt die gleiche Job-Handle-Nummer bereit, die an cancelScan() übergeben wurde.

• Ergebnis

  OperationResult

  Ergebnis des Abbruchs des Scans des Back-Ends. Wenn das Ergebnis OperationResult.SUCCESS oder OperationResult.CANCELLED lautet, wurde der Scan abgebrochen und der Scanner kann einen neuen Scan starten. Lautet das Ergebnis OperationResult.DEVICE_BUSY , verarbeitet der Scanner die angeforderte Stornierung noch. sollte der Aufrufer kurz warten und die Anfrage wiederholen. Andere Ergebniswerte weisen auf einen dauerhaften Fehler hin, der nicht wiederholt werden sollte.

CloseScannerResponse

Chrome 125 oder höher

Attribute

• Ergebnis

  OperationResult

  Das Ergebnis des Schließens des Scanners. Auch wenn dieser Wert nicht SUCCESS ist, ist der Alias ungültig und sollte nicht für weitere Vorgänge verwendet werden.

• scannerHandle

  String

  Derselbe Scanner-Handle, der an closeScanner übergeben wurde.

Configurability

Chrome 125 oder höher

Wie eine Option geändert werden kann.

Enum

"NOT_CONFIGURABLE"
Die Option ist schreibgeschützt.

„SOFTWARE_CONFIGURABLE“
Die Option kann in der Software festgelegt werden.

"HARDWARE_CONFIGURABLE"
Die Option kann vom Nutzer festgelegt werden, indem er am Scanner eine Taste ein- oder ausschaltet.

ConnectionType

Chrome 125 oder höher

Gibt an, wie der Scanner mit dem Computer verbunden ist.

Enum

"UNSPECIFIED"

„USB“

„NETZWERK“

ConstraintType

Chrome 125 oder höher

Der Datentyp der Einschränkung, der durch ein OptionConstraint dargestellt wird.

Enum

"INT_RANGE"
Die Einschränkung für einen Bereich von OptionType.INT-Werten. Die Attribute min, max und quant von OptionConstraint sind long und ihre list-Property wird aufgehoben.

"FIXED_RANGE"
Die Einschränkung für einen Bereich von OptionType.FIXED-Werten. Die Attribute min, max und quant von OptionConstraint sind double und das Attribut list wird aufgehoben.

"INT_LIST"
Die Einschränkung für eine bestimmte Liste von OptionType.INT-Werten. Das Attribut OptionConstraint.list enthält long-Werte und die anderen Attribute werden nicht festgelegt.

"FIXED_LIST"
Die Einschränkung für eine bestimmte Liste von OptionType.FIXED-Werten. Das Attribut OptionConstraint.list enthält double-Werte und die anderen Attribute werden nicht festgelegt.

"STRING_LIST"
Die Einschränkung für eine bestimmte Liste von OptionType.STRING-Werten. Das Attribut OptionConstraint.list enthält DOMString-Werte und die anderen Attribute werden nicht festgelegt.

DeviceFilter

Chrome 125 oder höher

Attribute

• lokal

  Boolescher Wert optional

  Senden Sie nur Scanner zurück, die direkt am Computer befestigt sind.

• sicher

  Boolescher Wert optional

  Senden Sie nur Scanner zurück, die eine sichere Übertragung wie USB oder TLS verwenden.

GetOptionGroupsResponse

Chrome 125 oder höher

Attribute

• Gruppen

  OptionGroup[] optional

  Wenn result auf SUCCESS gesetzt ist, erhalten Sie eine Liste der Optionsgruppen in der vom Scannertreiber angegebenen Reihenfolge.

• Ergebnis

  OperationResult

  Das Ergebnis des Abrufens der Optionsgruppen. Wenn der Wert dafür SUCCESS ist, wird das Attribut groups mit Daten gefüllt.

• scannerHandle

  String

  Derselbe Scanner-Handle, der an getOptionGroups übergeben wurde.

GetScannerListResponse

Chrome 125 oder höher

Attribute

• Ergebnis

  OperationResult

  Das Aufzählungsergebnis. Beachten Sie, dass Teilergebnisse zurückgegeben werden können, auch wenn dies auf einen Fehler hinweist.

• Scanner

  ScannerInfo[]

  Eine möglicherweise leere Liste von Scannern, die mit den angegebenen DeviceFilter übereinstimmen.

OpenScannerResponse

Chrome 125 oder höher

Attribute

• Optionen

  Objekt optional

  Wenn result den Wert SUCCESS hat, wird eine Schlüssel/Wert-Paar-Zuordnung bereitgestellt, wobei der Schlüssel eine gerätespezifische Option und der Wert eine Instanz von ScannerOption ist.

• Ergebnis

  OperationResult

  Das Ergebnis des Öffnens des Scanners. Wenn der Wert SUCCESS lautet, werden die Attribute scannerHandle und options ausgefüllt.

• scannerHandle

  String optional

  Wenn result SUCCESS ist, ein Handle zum Scanner, der für weitere Vorgänge verwendet werden kann.

• scannerId

  String

  Die Scanner-ID, die an openScanner() übergeben wurde.

OperationResult

Chrome 125 oder höher

Ein Enum-Wert, der das Ergebnis jedes Vorgangs angibt.

Enum

"UNKNOWN"
Ein unbekannter oder allgemeiner Fehler ist aufgetreten.

"SUCCESS"
Der Vorgang war erfolgreich.

"UNSUPPORTED"
Der Vorgang wird nicht unterstützt.

"CANCELLED"
Der Vorgang wurde abgebrochen.

"DEVICE_BUSY"
Das Gerät ist nicht verfügbar.

"INVALID"
Entweder die an die Methode übergebenen Daten oder ein Argument sind ungültig.

"WRONG_TYPE"
Der angegebene Wert ist der falsche Datentyp für die zugrunde liegende Option.

"EOF"
Es sind keine weiteren Daten verfügbar.

"ADF_JAMMED"
Der Dokumenteneinzug klemmt.

"ADF_EMPTY"
Der Dokumenteneinzug ist leer.

"COVER_OPEN"
Die Abdeckung des Flachbetts ist offen.

"IO_ERROR"
Bei der Kommunikation mit dem Gerät ist ein Fehler aufgetreten.

"ACCESS_DENIED"
Das Gerät erfordert eine Authentifizierung.

"NO_MEMORY"
Auf dem Chromebook ist nicht genügend Speicher verfügbar, um den Vorgang abzuschließen.

"UNREACHABLE"
Das Gerät ist nicht erreichbar.

FEHLT
Das Gerät ist nicht verbunden.

"INTERNAL_ERROR"
Nicht in der aufrufenden Anwendung ist ein Fehler aufgetreten.

OptionConstraint

Chrome 125 oder höher

Attribute

• list

  string[] | number[] optional

• max

  Zahl optional

• Min.

  Zahl optional

• Quant

  Zahl optional

• Typ

  ConstraintType

OptionGroup

Chrome 125 oder höher

Attribute

• Mitglieder

  String[]

  Ein Array von Optionsnamen in der vom Treiber angegebenen Reihenfolge.

• Titel

  String

  Liefert einen druckbaren Titel, z. B. „Geometrieoptionen“.

OptionSetting

Chrome 125 oder höher

Attribute

• Name

  String

  Gibt den Namen der festzulegenden Option an.

• Typ

  OptionType

  Gibt den Datentyp der Option an. Der angeforderte Datentyp muss mit dem tatsächlichen Datentyp der zugrunde liegenden Option übereinstimmen.

• Wert

  string | Zahl | boolean | number[] optional

  Gibt den festzulegenden Wert an. Lassen Sie die Richtlinie nicht konfiguriert, um eine automatische Einstellung für Optionen anzufordern, bei denen autoSettable aktiviert ist. Der für value angegebene Datentyp muss mit type übereinstimmen.

OptionType

Chrome 125 oder höher

Der Datentyp einer Option.

Enum

"UNKNOWN"
Der Datentyp der Option ist unbekannt. Die Festlegung des Attributs „value“ wird aufgehoben.

"BOOL"
Die Eigenschaft value hat den Wert truefalse.

"INT"
Eine 32-Bit-Ganzzahl mit Vorzeichen. Das Attribut value ist „long“ oder „long[]“, je nachdem, ob die Option mehr als einen Wert annimmt.

"FIXED"
Ein Double im Bereich -32768-32767.9999 mit einer Auflösung von 1/65535. Das Attribut value hat je nachdem, ob die Option mehr als einen Wert annimmt, „Double“ oder „Double[]“. Werte vom Typ „Double“, die nicht genau dargestellt werden können, werden auf den verfügbaren Bereich und die verfügbare Genauigkeit gerundet.

"STRING"
Eine Sequenz mit beliebigen Byte außer NUL ("\0"). Das Attribut value ist ein DOMString.

"SCHALTFLÄCHE"
Eine Option dieses Typs hat keinen Wert. Stattdessen führt das Festlegen einer Option dieses Typs zu einem optionspezifischen Nebeneffekt im Scanner-Treiber. Beispielsweise könnte ein Scannertreiber eine schaltflächenbasierte Option verwenden, um Standardwerte auszuwählen oder einen automatischen Dokumenteneinzug zu veranlassen, zum nächsten Blatt Papier zu wechseln.

"GROUP"
Gruppierungsoption. Kein Wert. Dieser Wert ist aus Kompatibilitätsgründen enthalten, wird aber normalerweise nicht in ScannerOption-Werten zurückgegeben. Verwenden Sie getOptionGroups(), um die Liste der Gruppen mit den entsprechenden Mitgliederoptionen abzurufen.

OptionUnit

Chrome 125 oder höher

Gibt den Datentyp für ScannerOption.unit an.

Enum

"UNITLESS"
Der Wert ist eine Zahl ohne Einheit. Es kann beispielsweise ein Grenzwert sein.

"PIXEL"
Der Wert ist eine Anzahl von Pixeln, z. B. Scanabmessungen.

"BIT"
Der Wert ist die Anzahl der Bits, z. B. die Farbtiefe.

"MM"
Der Wert wird in Millimetern gemessen, z. B. Scanabmessungen.

"DPI"
Der Wert wird in Punkten pro Zoll gemessen, z. B. die Auflösung.

"PERCENT"
Der Wert ist ein Prozentwert, z. B. die Helligkeit.

"MICROSECONDS"
Der Wert wird in Mikrosekunden gemessen, z. B. die Belichtungszeit.

ReadScanDataResponse

Chrome 125 oder höher

Attribute

• Daten

  ArrayBuffer optional

  Wenn result den Wert SUCCESS hat, enthält dieser den nächsten Teil der gescannten Bilddaten. Wenn result den Wert EOF hat, enthält er den letzten Teil der gescannten Bilddaten.

• estimatedCompletion

  Zahl optional

  Wenn result SUCCESS ist, eine Schätzung, wie viele der gesamten Scandaten bisher übermittelt wurden. Sie liegt im Bereich von 0 bis 100.

• Job

  String

  Stellt die an readScanData() übergebene Job-Handle bereit.

• Ergebnis

  OperationResult

  Das Ergebnis des Lesens von Daten. Wenn der Wert SUCCESS ist, enthält data den nächsten (möglicherweise null) Teil der Bilddaten, der gelesen werden kann. Wenn der Wert EOF ist, enthält data den letzten Teil der Bilddaten.

ScannerInfo

Chrome 125 oder höher

Attribute

• connectionType

  ConnectionType

  Gibt an, wie der Scanner mit dem Computer verbunden ist.

• deviceUuid

  String

  Zum Abgleich mit anderen ScannerInfo-Einträgen, die auf dasselbe physische Gerät verweisen.

• imageFormats

  String[]

  Ein Array von MIME-Typen, die für zurückgegebene Scans angefordert werden können.

• Hersteller

  String

  Der Hersteller des Scanners.

• Modell

  String

  Das Scannermodell, falls verfügbar, oder eine allgemeine Beschreibung.

• Name

  String

  Ein visuell lesbarer Name für den Scanner, der auf der Benutzeroberfläche angezeigt werden soll.

• protocolType

  String

  Eine für Menschen lesbare Beschreibung des Protokolls oder Treibers, mit dem auf den Scanner zugegriffen wird, z. B. Mopria, WSD oder epsonds. Dies ist in erster Linie nützlich, um Nutzern die Auswahl zwischen Protokollen zu ermöglichen, wenn ein Gerät mehrere Protokolle unterstützt.

• scannerId

  String

  Die ID eines bestimmten Scanners.

• sicher

  boolean

  Ist dieser Wert auf „true“ gesetzt, kann die Übertragung der Scannerverbindung nicht von einem passiven Listener wie TLS oder USB abgefangen werden.

ScannerOption

Chrome 125 oder höher

Attribute

• Konfigurierbarkeit

  Konfigurierbarkeit

  Gibt an, ob und wie die Option geändert werden kann.

• Einschränkung

  OptionConstraint optional

  Definiert OptionConstraint für die aktuelle Scanneroption.

• Beschreibung

  String

  Eine längere Beschreibung der Option

• isActive (Aktiv)

  boolean

  Gibt an, dass die Option aktiv ist und festgelegt oder abgerufen werden kann. Bei „false“ wird das Attribut value nicht festgelegt.

• isAdvanced

  boolean

  Gibt an, dass die Benutzeroberfläche diese Option nicht standardmäßig anzeigen soll.

• isAutoSettable

  boolean

  Kann automatisch vom Scannertreiber festgelegt werden.

• isDetectable

  boolean

  Gibt an, dass diese Option von der Software erkannt werden kann.

• isEmulated

  boolean

  Wird vom Scannertreiber emuliert, wenn dies wahr ist.

• Name

  String

  Der Name der Option mit ASCII-Kleinbuchstaben, Ziffern und Bindestrichen. Diakritische Zeichen sind nicht zulässig.

• Titel

  String

  Ein einzeiliger, druckbarer Titel.

• Typ

  OptionType

  Der Datentyp im Attribut value, der zum Festlegen dieser Option erforderlich ist.

• Einheit

  OptionUnit

  Die Maßeinheit für diese Option.

• Wert

  string | Zahl | boolean | number[] optional

  Der aktuelle Wert der Option, falls relevant. Der Datentyp dieses Attributs muss mit dem in type angegebenen Datentyp übereinstimmen.

ScanOptions

Attribute

• maxImages

  Zahl optional

  Die zulässige Anzahl von gescannten Bildern. Der Standardwert ist 1.

• mimeTypes

  string[] optional

  Die MIME-Typen, die vom Aufrufer akzeptiert werden.

ScanResults

Attribute

• dataUrls

  String[]

  Ein Array von Datenbild-URLs in einer Form, die als „src“ übergeben werden kann -Wert zu einem Image-Tag hinzu.

• mimeType

  String

  Der MIME-Typ von dataUrls.

SetOptionResult

Chrome 125 oder höher

Attribute

• Name

  String

  Gibt den Namen der festgelegten Option an.

• Ergebnis

  OperationResult

  Gibt das Ergebnis der Einstellung der Option an.

SetOptionsResponse

Chrome 125 oder höher

Attribute

• Optionen

  Objekt optional

  Eine aktualisierte Schlüssel/Wert-Zuordnung von Optionsnamen zu ScannerOption-Werten, die die neue Konfiguration enthalten, nachdem versucht wurde, alle angegebenen Optionen festzulegen. Sie hat dieselbe Struktur wie das Attribut options in OpenScannerResponse.

  Dieses Attribut wird auch dann festgelegt, wenn einige Optionen nicht festgelegt wurden. Es wird jedoch nicht festgelegt, wenn das Abrufen der aktualisierten Konfiguration fehlschlägt, z. B. wenn der Scanner während des Scans getrennt wird.

• Ergebnisse

  SetOptionResult[]

  Ein Array von Ergebnissen, jeweils eines für jeden übergebenen OptionSetting.

• scannerHandle

  String

  Stellt das Scanner-Handle zur Verfügung, das an setOptions() übergeben wurde.

StartScanOptions

Chrome 125 oder höher

Attribute

• Format

  String

  Gibt den MIME-Typ an, in dem gescannte Daten zurückgegeben werden sollen.

• maxReadSize

  Zahl optional

  Wenn ein Wert ungleich Null angegeben ist, wird die maximale Anzahl gescannter Byte begrenzt, die in einer einzelnen readScanData-Antwort auf diesen Wert zurückgegeben werden. Der kleinste zulässige Wert ist 32.768 (32 KB). Wenn diese Eigenschaft nicht angegeben ist, kann die Größe eines zurückgegebenen Blocks so groß sein wie das gesamte gescannte Bild.

StartScanResponse

Chrome 125 oder höher

Attribute

• Job

  String optional

  Wenn result den Wert SUCCESS hat, wird ein Handle zum Lesen von Scandaten oder zum Abbrechen des Jobs bereitgestellt.

• Ergebnis

  OperationResult

  Das Ergebnis des Starts eines Scans. Wenn der Wert dafür SUCCESS ist, wird das Attribut job mit Daten gefüllt.

• scannerHandle

  String

  Bietet denselben Scanner-Handle, der an startScan() übergeben wurde.

Methoden

cancelScan()

<ph type="x-smartling-placeholder"></ph> Versprechen Chrome 125 oder höher

chrome.documentScan.cancelScan(
  job: string,
  callback?: function,
)

Bricht einen gestarteten Scan ab und gibt ein Promise zurück, das mit einem CancelScanResponse-Objekt aufgelöst wird. Wenn ein Callback verwendet wird, wird stattdessen das Objekt an diesen übergeben.

Parameter

• Job

  String

  Der Handle eines aktiven Scanjobs, der zuvor von einem Aufruf an startScan zurückgegeben wurde.

• callback

  Funktion optional

  Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

  (response: CancelScanResponse) => void

  • Antwort

    CancelScanResponse

Gibt Folgendes zurück:

• Promise&lt;CancelScanResponse&gt;

  Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

closeScanner()

<ph type="x-smartling-placeholder"></ph> Versprechen Chrome 125 oder höher

chrome.documentScan.closeScanner(
  scannerHandle: string,
  callback?: function,
)

Schließt den Scanner mit dem übergebenen Handle und gibt ein Versprechen zurück, das mit einem CloseScannerResponse-Objekt aufgelöst wird. Wenn ein Callback verwendet wird, wird stattdessen das Objekt an diesen übergeben. Selbst wenn die Antwort kein Erfolg ist, wird das angegebene Handle ungültig und sollte nicht für weitere Vorgänge verwendet werden.

Parameter

• scannerHandle

  String

  Gibt den Handle eines offenen Scanners an, der zuvor von einem Aufruf an openScanner zurückgegeben wurde.

• callback

  Funktion optional

  Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

  (response: CloseScannerResponse) => void

  • Antwort

    CloseScannerResponse

Gibt Folgendes zurück:

• Promise&lt;CloseScannerResponse&gt;

  Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getOptionGroups()

<ph type="x-smartling-placeholder"></ph> Versprechen Chrome 125 oder höher

chrome.documentScan.getOptionGroups(
  scannerHandle: string,
  callback?: function,
)

Ruft die Gruppennamen und Mitgliederoptionen aus einem Scanner ab, der zuvor von openScanner geöffnet wurde. Diese Methode gibt ein Promise zurück, das mit einem GetOptionGroupsResponse-Objekt aufgelöst wird. Wenn ein Callback an diese Funktion übergeben wird, werden stattdessen zurückgegebene Daten an diese Funktion übergeben.

Parameter

• scannerHandle

  String

  Der Handle eines geöffneten Scanners, der von einem Aufruf an openScanner zurückgegeben wurde.

• callback

  Funktion optional

  Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

  (response: GetOptionGroupsResponse) => void

  • Antwort

    GetOptionGroupsResponse

Gibt Folgendes zurück:

• Promise&lt;GetOptionGroupsResponse&gt;

  Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getScannerList()

<ph type="x-smartling-placeholder"></ph> Versprechen Chrome 125 oder höher

chrome.documentScan.getScannerList(
  filter: DeviceFilter,
  callback?: function,
)

Ruft die Liste der verfügbaren Scanner ab und gibt ein Promise zurück, das mit einem GetScannerListResponse-Objekt aufgelöst wird. Wenn ein Callback an diese Funktion übergeben wird, werden stattdessen zurückgegebene Daten an diese Funktion übergeben.

Parameter

• Filter

  DeviceFilter

  Ein DeviceFilter, das angibt, welche Arten von Scannern zurückgegeben werden sollen.

• callback

  Funktion optional

  Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

  (response: GetScannerListResponse) => void

  • Antwort

    GetScannerListResponse

Gibt Folgendes zurück:

• Promise&lt;GetScannerListResponse&gt;

  Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

openScanner()

<ph type="x-smartling-placeholder"></ph> Versprechen Chrome 125 oder höher

chrome.documentScan.openScanner(
  scannerId: string,
  callback?: function,
)

Öffnet einen Scanner für exklusiven Zugriff und gibt ein Versprechen zurück, das mit einem OpenScannerResponse-Objekt aufgelöst wird. Wenn ein Callback an diese Funktion übergeben wird, werden stattdessen zurückgegebene Daten an diese Funktion übergeben.

Parameter

• scannerId

  String

  Die ID des Scanners, der geöffnet werden soll. Dieser Wert wurde von einem vorherigen Aufruf an getScannerList zurückgegeben.

• callback

  Funktion optional

  Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

  (response: OpenScannerResponse) => void

  • Antwort

    OpenScannerResponse

Gibt Folgendes zurück:

• Promise&lt;OpenScannerResponse&gt;

  Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

readScanData()

<ph type="x-smartling-placeholder"></ph> Versprechen Chrome 125 oder höher

chrome.documentScan.readScanData(
  job: string,
  callback?: function,
)

Liest den nächsten Block verfügbarer Bilddaten aus einem aktiven Job-Handle und gibt ein Promise zurück, das mit einem ReadScanDataResponse-Objekt aufgelöst wird. Wenn ein Callback verwendet wird, wird stattdessen das Objekt an diesen übergeben.

**Hinweis:**Ein Antwortergebnis muss SUCCESS mit einem data-Mitglied der Länge null sein. Das bedeutet, dass der Scanner noch funktioniert, aber noch keine weiteren Daten zur Verfügung stehen. Der Anrufer sollte eine kurze Zeit warten und es dann noch einmal versuchen.

Wenn der Scanjob abgeschlossen ist, hat die Antwort den Ergebniswert EOF. Diese Antwort kann ein letztes data-Mitglied ungleich null enthalten.

Parameter

• Job

  String

  Aktive Job-Handles, die zuvor von startScan zurückgegeben wurden.

• callback

  Funktion optional

  Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

  (response: ReadScanDataResponse) => void

  • Antwort

    ReadScanDataResponse

Gibt Folgendes zurück:

• Promise&lt;ReadScanDataResponse&gt;

  Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

scan()

<ph type="x-smartling-placeholder"></ph> Versprechen

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

Führt einen Scan des Dokuments durch und gibt ein Promise zurück, das mit einem ScanResults-Objekt aufgelöst wird. Wenn ein Callback an diese Funktion übergeben wird, werden stattdessen die zurückgegebenen Daten an diese Funktion übergeben.

Parameter

• Optionen

  ScanOptions

  Ein Objekt mit Scanparametern.

• callback

  Funktion optional

  Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

  (result: ScanResults) => void

  • Ergebnis

    ScanResults

Gibt Folgendes zurück:

• Promise&lt;ScanResults&gt;

  Chrome 96 und höher

  Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

setOptions()

<ph type="x-smartling-placeholder"></ph> Versprechen Chrome 125 oder höher

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

Legt Optionen für den angegebenen Scanner fest und gibt ein Promise-Objekt zurück, das mit einem SetOptionsResponse-Objekt aufgelöst wird, das das Ergebnis des Versuchs enthält, jeden Wert in der Reihenfolge des übergebenen OptionSetting-Objekts festzulegen. Wenn ein Callback verwendet wird, wird stattdessen das Objekt an diesen übergeben.

Parameter

• scannerHandle

  String

  Der Ziehpunkt des Scanners, für den Optionen festgelegt werden sollen. Dies sollte ein Wert sein, der zuvor von einem Aufruf an openScanner zurückgegeben wurde.

• Optionen

  OptionSetting[]

  Eine Liste mit OptionSetting Objekten, die auf den Scanner angewendet werden sollen.

• callback

  Funktion optional

  Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

  (response: SetOptionsResponse) => void

  • Antwort

    SetOptionsResponse

Gibt Folgendes zurück:

• Promise&lt;SetOptionsResponse&gt;

  Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

startScan()

<ph type="x-smartling-placeholder"></ph> Versprechen Chrome 125 oder höher

chrome.documentScan.startScan(
  scannerHandle: string,
  options: StartScanOptions,
  callback?: function,
)

Startet einen Scan auf dem angegebenen Scanner und gibt ein Promise zurück, das mit StartScanResponse aufgelöst wird. Wenn ein Callback verwendet wird, wird stattdessen das Objekt an diesen übergeben. Wenn der Aufruf erfolgreich war, enthält die Antwort ein Job-Handle, das in nachfolgenden Aufrufen verwendet werden kann, um Scandaten zu lesen oder einen Scan abzubrechen.

Parameter

• scannerHandle

  String

  Der Griff eines geöffneten Scanners. Dies sollte ein Wert sein, der zuvor von einem Aufruf an openScanner zurückgegeben wurde.

• Optionen

  StartScanOptions

  Ein StartScanOptions-Objekt, das die Optionen angibt, die für den Scan verwendet werden sollen. Das Attribut StartScanOptions.format muss mit einem der Einträge übereinstimmen, die im ScannerInfo des Scanners zurückgegeben werden.

• callback

  Funktion optional

  Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

  (response: StartScanResponse) => void

  • Antwort

    StartScanResponse

Gibt Folgendes zurück:

• Promise&lt;StartScanResponse&gt;

  Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.