chrome.documentScan

refresh date: 2026-09-25 robots: noindex

Wichtig: Diese API funktioniert nur unter ChromeOS.

Beschreibung

Mit der chrome.documentScan API können Sie Bilder von angeschlossenen Dokumentenscannern finden und abrufen.

Berechtigungen

documentScan

Verfügbarkeit

Chrome 44 und höher Nur ChromeOS

Document Scan API

Die Document Scan API wurde entwickelt, um Apps und Erweiterungen zu ermöglichen, den Inhalt von Papierdokumenten auf einem angeschlossenen Dokumentenscanner anzuzeigen.

Hinweis: Diese API hängt von Betriebssystemfunktionen ab, die je nach zugrunde liegendem Betriebssystem möglicherweise nicht verfügbar sind. Zum Zeitpunkt der Erstellung dieses Artikels ist nur bekannt, dass ChromeOS für bestimmte über USB angeschlossene Geräte erfolgreich funktioniert.

Typen

CancelScanResponse

Chrome 125 oder höher

Attribute

• Job

  String

  Stellt dasselbe Job-Handle bereit, das an cancelScan() übergeben wurde.

• Ergebnis

  OperationResult

  Das Ergebnis des Abbruchs des Scans durch das Backend. Wenn das Ergebnis OperationResult.SUCCESS oder OperationResult.CANCELLED lautet, wurde der Scan abgebrochen und der Scanner ist bereit, einen neuen Scan zu starten. Wenn das Ergebnis OperationResult.DEVICE_BUSY ist, verarbeitet der Scanner die angeforderte Stornierung noch. Der Aufrufer sollte kurz warten und die Anfrage dann noch einmal senden. 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 das Handle ungültig und sollte nicht für weitere Vorgänge verwendet werden.

• scannerHandle

  String

  Dasselbe Scanner-Handle, das 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 durch Umschalten oder Drücken einer Taste am Scanner festgelegt werden.

ConnectionType

Chrome 125 oder höher

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

Enum

"UNSPECIFIED"

USB

"NETWORK"

ConstraintType

Chrome 125 oder höher

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

Enum

"INT_RANGE"
Die Einschränkung für einen Bereich von OptionType.INT-Werten. Die Attribute min, max und quant von OptionConstraint werden auf long gesetzt und das Attribut list wird nicht festgelegt.

"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 ist nicht festgelegt.

"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 sind 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 sind 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 sind nicht festgelegt.

DeviceFilter

Chrome 125 oder höher

Attribute

• lokal

  Boolesch optional

  Nur Scanner zurückgeben, die direkt mit dem Computer verbunden sind.

• sicher

  Boolesch optional

  Geben 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 den Wert SUCCESS hat, wird eine Liste der Optionsgruppen in der vom Scannertreiber bereitgestellten Reihenfolge angezeigt.

• Ergebnis

  OperationResult

  Das Ergebnis des Abrufs der Optionsgruppen. Wenn der Wert SUCCESS ist, wird das Attribut groups ausgefüllt.

• scannerHandle

  String

  Dasselbe Scanner-Handle, das an getOptionGroups übergeben wurde.

GetScannerListResponse

Chrome 125 oder höher

Attribute

• Ergebnis

  OperationResult

  Das Ergebnis der Aufzählung. 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 dem angegebenen DeviceFilter übereinstimmen.

OpenScannerResponse

Chrome 125 oder höher

Attribute

• Optionen

  Objekt optional

  Wenn result den Wert SUCCESS hat, wird eine Schlüssel/Wert-Zuordnung bereitgestellt, bei der 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 ist, werden die Properties scannerHandle und options ausgefüllt.

• scannerHandle

  String optional

  Wenn result den Wert SUCCESS hat, ein Handle für den Scanner, das für weitere Vorgänge verwendet werden kann.

• scannerId

  String

  Die an openScanner() übergebene Scanner-ID.

OperationResult

Chrome 125 oder höher

Ein Enum, das 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 beschäftigt.

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

"WRONG_TYPE"
Der angegebene Wert hat den falschen Datentyp für die zugrunde liegende Option.

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

"ADF_JAMMED"
Der Dokumenteneinzug ist blockiert.

"ADF_EMPTY"
Der Dokumenteneinzug ist leer.

"COVER_OPEN"
Die Abdeckung des Flachbettscanners 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 Arbeitsspeicher verfügbar, um den Vorgang abzuschließen.

„UNREACHABLE“
Das Gerät ist nicht erreichbar.

"MISSING"
Das Gerät ist nicht verbunden.

"INTERNAL_ERROR"
Es ist ein Fehler aufgetreten, der nicht von der aufrufenden Anwendung verursacht wurde.

OptionConstraint

Chrome 125 oder höher

Attribute

• list

  string[] | number[] optional

• max

  number optional

• Min.

  number optional

• quant

  number optional

• Typ

  ConstraintType

OptionGroup

Chrome 125 oder höher

Attribute

• Mitglieder

  String[]

  Ein Array von Optionsnamen in der vom Treiber bereitgestellten Reihenfolge.

• Titel

  String

  Stellt einen druckbaren Titel bereit, 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 | number | boolean | number[] optional

  Gibt den festzulegenden Wert an. Lassen Sie das Feld leer, um die automatische Einstellung für Optionen anzufordern, für die 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. Das Attribut value wird aufgehoben.

"BOOL"
Die Property value ist truefalse.

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

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

"STRING"
Eine Folge beliebiger Bytes außer NUL ('\0'). Das Attribut value ist ein DOMString.

"BUTTON"
Eine Option dieses Typs hat keinen Wert. Stattdessen wird durch das Festlegen einer Option dieses Typs ein optionsspezifischer Nebeneffekt im Scannertreiber verursacht. Eine Schaltflächenoption könnte beispielsweise von einem Scannertreiber verwendet werden, um Standardwerte auszuwählen oder einen automatischen Dokumenteneinzug anzuweisen, zum nächsten Blatt Papier zu wechseln.

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

OptionUnit

Chrome 125 oder höher

Gibt den Datentyp für ScannerOption.unit an.

Enum

"UNITLESS"
Der Wert ist eine Zahl ohne Einheit. Das kann beispielsweise ein Schwellenwert sein.

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

"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 Prozentsatz, z. B. die Helligkeit.

"MICROSECOND"
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 es den nächsten Block gescannter Bilddaten. Wenn result den Wert EOF hat, enthält es den letzten Block der gescannten Bilddaten.

• estimatedCompletion

  number optional

  Wenn result den Wert SUCCESS hat, wird ein Schätzwert für den Anteil der bisher gelieferten Scandaten im Bereich von 0 bis 100 angegeben.

• Job

  String

  Stellt das Job-Handle bereit, das an readScanData() übergeben wurde.

• Ergebnis

  OperationResult

  Das Ergebnis des Lesens von Daten. Wenn der Wert SUCCESS ist, enthält data den nächsten (möglicherweise leeren) Block von Bilddaten, der zum Lesen bereit ist. Wenn der Wert EOF ist, enthält data den letzten Block von 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 menschenlesbarer Name für den Scanner, der in der Benutzeroberfläche angezeigt werden soll.

• protocolType

  String

  Eine menschenlesbare Beschreibung des Protokolls oder Treibers, der für den Zugriff auf den Scanner verwendet wird, z. B. Mopria, WSD oder epsonds. Das ist vor allem dann nützlich, wenn ein Nutzer zwischen Protokollen wählen kann, falls ein Gerät mehrere Protokolle unterstützt.

• scannerId

  String

  Die ID eines bestimmten Scanners.

• sicher

  boolean

  Wenn „true“, 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. Wenn „false“, wird das Attribut value nicht festgelegt.

• isAdvanced

  boolean

  Gibt an, dass diese Option standardmäßig nicht in der Benutzeroberfläche angezeigt werden soll.

• isAutoSettable

  boolean

  Kann automatisch vom Scannertreiber festgelegt werden.

• isDetectable

  boolean

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

• isEmulated

  boolean

  Wird vom Scannertreiber emuliert, wenn „true“.

• name

  String

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

• Titel

  String

  Ein druckbarer einzeiliger Titel.

• Typ

  OptionType

  Der Datentyp, der in der Property value enthalten ist und zum Festlegen dieser Option erforderlich ist.

• Einheit

  OptionUnit

  Die Maßeinheit für diese Option.

• Wert

  string | number | boolean | number[] optional

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

ScanOptions

Attribute

• maxImages

  number optional

  Die Anzahl der zulässigen gescannten Bilder. 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 einem Format, das als „src“-Wert an ein Bild-Tag übergeben werden kann.

• mimeType

  String

  Der MIME-Typ des dataUrls.

SetOptionResult

Chrome 125 oder höher

Attribute

• name

  String

  Gibt den Namen der Option an, die festgelegt wurde.

• 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. Diese hat dieselbe Struktur wie das Attribut options in OpenScannerResponse.

  Diese Property wird auch dann festgelegt, wenn einige Optionen nicht erfolgreich festgelegt wurden. Sie wird jedoch aufgehoben, wenn die aktualisierte Konfiguration nicht abgerufen werden kann (z. B. wenn der Scanner während des Scannens getrennt wird).

• Ergebnisse

  SetOptionResult[]

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

• scannerHandle

  String

  Stellt das Scanner-Handle bereit, 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

  number optional

  Wenn ein Wert ungleich null angegeben wird, wird die maximale Anzahl der gescannten Bytes, die in einer einzelnen readScanData-Antwort zurückgegeben werden, auf diesen Wert begrenzt. Der kleinste zulässige Wert ist 32768 (32 KB). Wenn dieses Attribut 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 bereitgestellt, mit dem Scandaten gelesen oder der Job abgebrochen werden kann.

• Ergebnis

  OperationResult

  Das Ergebnis des Startens eines Scans. Wenn der Wert SUCCESS ist, wird das Attribut job ausgefüllt.

• scannerHandle

  String

  Stellt dasselbe Scanner-Handle bereit, das an startScan() übergeben wurde.

Methoden

cancelScan()

Promise Chrome 125+

chrome.documentScan.cancelScan(
  job: string,
  callback?: function,
): Promise<CancelScanResponse>

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 das Objekt stattdessen an diesen übergeben.

Parameter

• Job

  String

  Das Handle eines aktiven Scan-Jobs, das zuvor von einem Aufruf von startScan zurückgegeben wurde.

• callback

  function optional

  Der Parameter callback sieht so aus:

  (response: CancelScanResponse) => void

  • Antwort

    CancelScanResponse

Ausgabe

• Promise<CancelScanResponse>

  Gibt ein Promise zurück, das mit dem Ergebnis aufgelöst wird.

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

closeScanner()

Promise Chrome 125+

chrome.documentScan.closeScanner(
  scannerHandle: string,
  callback?: function,
): Promise<CloseScannerResponse>

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

Parameter

• scannerHandle

  String

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

• callback

  function optional

  Der Parameter callback sieht so aus:

  (response: CloseScannerResponse) => void

  • Antwort

    CloseScannerResponse

Ausgabe

• Promise<CloseScannerResponse>

  Gibt ein Promise zurück, das mit dem Ergebnis aufgelöst wird.

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

getOptionGroups()

Promise Chrome 125+

chrome.documentScan.getOptionGroups(
  scannerHandle: string,
  callback?: function,
): Promise<GetOptionGroupsResponse>

Ruft die Gruppennamen und Mitgliederoptionen von 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 die zurückgegebenen Daten stattdessen an diesen übergeben.

Parameter

• scannerHandle

  String

  Das Handle eines geöffneten Scanners, das von einem Aufruf von openScanner zurückgegeben wurde.

• callback

  function optional

  Der Parameter callback sieht so aus:

  (response: GetOptionGroupsResponse) => void

  • Antwort

    GetOptionGroupsResponse

Ausgabe

• Promise<GetOptionGroupsResponse>

  Gibt ein Promise zurück, das mit dem Ergebnis aufgelöst wird.

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

getScannerList()

Promise Chrome 125+

chrome.documentScan.getScannerList(
  filter: DeviceFilter,
  callback?: function,
): Promise<GetScannerListResponse>

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 die zurückgegebenen Daten stattdessen an diesen übergeben.

Parameter

• Filter

  DeviceFilter

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

• callback

  function optional

  Der Parameter callback sieht so aus:

  (response: GetScannerListResponse) => void

  • Antwort

    GetScannerListResponse

Ausgabe

• Promise<GetScannerListResponse>

  Gibt ein Promise zurück, das mit dem Ergebnis und der Liste der Scanner aufgelöst wird.

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

openScanner()

Promise Chrome 125+

chrome.documentScan.openScanner(
  scannerId: string,
  callback?: function,
): Promise<OpenScannerResponse>

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

Parameter

• scannerId

  String

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

• callback

  function optional

  Der Parameter callback sieht so aus:

  (response: OpenScannerResponse) => void

  • Antwort

    OpenScannerResponse

Ausgabe

• Promise<OpenScannerResponse>

  Gibt ein Promise zurück, das mit dem Ergebnis aufgelöst wird.

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

readScanData()

Promise Chrome 125+

chrome.documentScan.readScanData(
  job: string,
  callback?: function,
): Promise<ReadScanDataResponse>

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 das Objekt stattdessen an diesen übergeben.

**Hinweis:**Es ist zulässig, dass ein Antwortergebnis SUCCESS mit einem data-Element der Länge 0 ist. Das bedeutet, dass der Scanner noch arbeitet, aber noch keine zusätzlichen Daten bereitgestellt hat. Der Anrufer sollte kurz warten und es dann noch einmal versuchen.

Wenn der Scanvorgang abgeschlossen ist, hat die Antwort den Ergebniswert EOF. Diese Antwort kann ein abschließendes data-Mitglied ungleich null enthalten.

Parameter

• Job

  String

  Aktives Job-Handle, das zuvor von startScan zurückgegeben wurde.

• callback

  function optional

  Der Parameter callback sieht so aus:

  (response: ReadScanDataResponse) => void

  • Antwort

    ReadScanDataResponse

Ausgabe

• Promise<ReadScanDataResponse>

  Gibt ein Promise zurück, das mit dem Ergebnis aufgelöst wird.

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

scan()

Promise

chrome.documentScan.scan(
  options: ScanOptions,
  callback?: function,
): Promise<ScanResults>

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

Parameter

• Optionen

  ScanOptions

  Ein Objekt mit Scanparametern.

• callback

  function optional

  Der Parameter callback sieht so aus:

  (result: ScanResults) => void

  • Ergebnis

    ScanResults

Ausgabe

• Promise<ScanResults>

  Chrome 96 oder höher

  Gibt ein Promise zurück, das mit den Scanergebnissen aufgelöst wird.

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

setOptions()

Promise Chrome 125+

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

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

Parameter

• scannerHandle

  String

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

• Optionen

  OptionSetting[]

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

• callback

  function optional

  Der Parameter callback sieht so aus:

  (response: SetOptionsResponse) => void

  • Antwort

    SetOptionsResponse

Ausgabe

• Promise<SetOptionsResponse>

  Gibt ein Promise zurück, das mit dem Ergebnis aufgelöst wird.

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

startScan()

Promise Chrome 125+

chrome.documentScan.startScan(
  scannerHandle: string,
  options: StartScanOptions,
  callback?: function,
): Promise<StartScanResponse>

Startet einen Scan auf dem angegebenen Scanner und gibt ein Promise zurück, das mit einem StartScanResponse aufgelöst wird. Wenn ein Callback verwendet wird, wird das Objekt stattdessen 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

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

• Optionen

  StartScanOptions

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

• callback

  function optional

  Der Parameter callback sieht so aus:

  (response: StartScanResponse) => void

  • Antwort

    StartScanResponse

Ausgabe

• Promise<StartScanResponse>

  Gibt ein Promise zurück, das mit dem Ergebnis aufgelöst wird.

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