chrome.documentScan

refresh date: 2026-09-25 robots: noindex

Opis

Użyj interfejsu chrome.documentScan API, aby wykrywać i pobierać obrazy z podłączonych skanerów dokumentów.

Uprawnienia

documentScan

Dostępność

Chrome 44 lub nowszy Tylko ChromeOS

Document Scan API

Interfejs Document Scan API umożliwia aplikacjom i rozszerzeniom wyświetlanie treści dokumentów papierowych na podłączonym skanerze dokumentów.

Typy

CancelScanResponse

Chrome 125 lub nowsza

Właściwości

  • zadanie

    tekst

    Zwraca ten sam uchwyt zadania, który został przekazany do cancelScan().

  • Wynik anulowania skanowania z backendu. Jeśli wynikiem jest OperationResult.SUCCESS lub OperationResult.CANCELLED, skanowanie zostało anulowane, a skaner jest gotowy do rozpoczęcia nowego skanowania. Jeśli wynikiem jest OperationResult.DEVICE_BUSY , skaner nadal przetwarza żądanie anulowania. Dzwoniący powinien poczekać chwilę i ponownie spróbować wysłać żądanie. Pozostałe wartości wyniku wskazują na trwały błąd, którego nie należy ponawiać.

CloseScannerResponse

Chrome 125 lub nowsza

Właściwości

  • Wynik zamknięcia skanera. Nawet jeśli ta wartość nie jest równa SUCCESS, uchwyt będzie nieprawidłowy i nie należy go używać do żadnych dalszych operacji.

  • scannerHandle

    tekst

    Ten sam uchwyt skanera, który został przekazany do funkcji closeScanner.

Configurability

Chrome 125 lub nowsza

Jak można zmienić opcję.

Typ wyliczeniowy

„NOT_CONFIGURABLE”
Opcja jest tylko do odczytu.

„SOFTWARE_CONFIGURABLE”
Opcję można ustawić w oprogramowaniu.

„HARDWARE_CONFIGURABLE”
Opcję można ustawić, przełączając lub naciskając przycisk na skanerze.

ConnectionType

Chrome 125 lub nowsza

Określa sposób połączenia skanera z komputerem.

Typ wyliczeniowy

"UNSPECIFIED"

„USB”

„NETWORK”

ConstraintType

Chrome 125 lub nowsza

Typ danych ograniczenia reprezentowanego przez OptionConstraint.

Typ wyliczeniowy

„INT_RANGE”
Ograniczenie zakresu wartości OptionType.INT. Właściwości min, max i quant obiektu OptionConstraint będą miały wartość long, a właściwość list będzie niezdefiniowana.

„FIXED_RANGE”
Ograniczenie dotyczące zakresu OptionType.FIXED wartości. Właściwości min, max i quant usługi OptionConstraint będą miały wartość double, a właściwość list będzie niezdefiniowana.

„INT_LIST”
Ograniczenie dotyczące konkretnej listy wartości OptionType.INT. Właściwość OptionConstraint.list będzie zawierać long wartości, a pozostałe właściwości nie będą ustawione.

„FIXED_LIST”
Ograniczenie dotyczące konkretnej listy OptionType.FIXED wartości. Właściwość OptionConstraint.list będzie zawierać double wartości, a pozostałe właściwości nie będą ustawione.

„STRING_LIST”
Ograniczenie dotyczące określonej listy OptionType.STRING wartości. Właściwość OptionConstraint.list będzie zawierać DOMString wartości, a pozostałe właściwości nie będą ustawione.

DeviceFilter

Chrome 125 lub nowsza

Właściwości

  • lokalne

    wartość logiczna opcjonalna

    Zwraca tylko skanery podłączone bezpośrednio do komputera.

  • Bezpieczny

    wartość logiczna opcjonalna

    Zwracaj tylko skanery, które korzystają z bezpiecznego transportu, np. USB lub TLS.

GetOptionGroupsResponse

Chrome 125 lub nowsza

Właściwości

  • grupy

    OptionGroup[] opcjonalny

    Jeśli result ma wartość SUCCESS, podaje listę grup opcji w kolejności dostarczonej przez sterownik skanera.

  • Wynik pobierania grup opcji. Jeśli wartość tego parametru to SUCCESS, zostanie wypełniona właściwość groups.

  • scannerHandle

    tekst

    Ten sam uchwyt skanera, który został przekazany do funkcji getOptionGroups.

GetScannerListResponse

Chrome 125 lub nowsza

Właściwości

  • Wynik wyliczenia. Pamiętaj, że nawet jeśli ten kod wskazuje błąd, mogą zostać zwrócone częściowe wyniki.

  • skanery,

    ScannerInfo[]

    Lista skanerów, które pasują do podanego parametru DeviceFilter. Może być pusta.

OpenScannerResponse

Chrome 125 lub nowsza

Właściwości

  • Opcje

    obiekt opcjonalny

    Jeśli result ma wartość SUCCESS, udostępnia mapowanie klucz-wartość, w którym kluczem jest opcja specyficzna dla urządzenia, a wartością jest instancja ScannerOption.

  • Wynik otwarcia skanera. Jeśli wartość tego parametru to SUCCESS, zostaną wypełnione właściwości scannerHandle i options.

  • scannerHandle

    ciąg znaków opcjonalny

    Jeśli result ma wartość SUCCESS, jest to uchwyt skanera, którego można używać do dalszych operacji.

  • scannerId

    tekst

    Identyfikator skanera przekazany do openScanner().

OperationResult

Chrome 125 lub nowsza

Wyliczenie wskazujące wynik każdej operacji.

Typ wyliczeniowy

„UNKNOWN”
Wystąpił nieznany lub ogólny błąd.

„SUCCESS”
Operacja zakończyła się powodzeniem.

„UNSUPPORTED”
Ta operacja nie jest obsługiwana.

„ANULOWANO”
Operacja została anulowana.

„DEVICE_BUSY”
Urządzenie jest zajęte.

„INVALID”
Dane lub argument przekazany do metody są nieprawidłowe.

„WRONG_TYPE”
Podana wartość ma nieprawidłowy typ danych dla opcji bazowej.

„EOF”
Brak dostępnych danych.

„ADF_JAMMED”
Podajnik dokumentów jest zablokowany.

„ADF_EMPTY”
Podajnik dokumentów jest pusty.

„COVER_OPEN”
Pokrywa skanera płaskiego jest otwarta.

„IO_ERROR”
Podczas komunikacji z urządzeniem wystąpił błąd.

„ACCESS_DENIED”
Urządzenie wymaga uwierzytelnienia.

„NO_MEMORY”
Na Chromebooku nie ma wystarczającej ilości pamięci, aby ukończyć operację.

„UNREACHABLE”
Urządzenie jest nieosiągalne.

„MISSING”
Urządzenie jest odłączone.

„INTERNAL_ERROR”
Wystąpił błąd w miejscu innym niż aplikacja wywołująca.

OptionConstraint

Chrome 125 lub nowsza

Właściwości

  • lista

    string[] | number[] opcjonalnie

  • maksimum

    number opcjonalny

  • min

    number opcjonalny

  • quant

    number opcjonalny

OptionGroup

Chrome 125 lub nowsza

Właściwości

  • członkowie

    string[]

    Tablica nazw opcji w kolejności podanej przez kierowcę.

  • tytuł

    tekst

    Zawiera tytuł do wydruku, np. „Opcje geometrii”.

OptionSetting

Chrome 125 lub nowsza

Właściwości

  • nazwa

    tekst

    Wskazuje nazwę opcji do ustawienia.

  • Wskazuje typ danych opcji. Żądany typ danych musi być zgodny z rzeczywistym typem danych opcji bazowej.

  • wartość

    string | number | boolean | number[] opcjonalnie

    Wskazuje wartość do ustawienia. Pozostaw to pole bez ustawienia, aby poprosić o automatyczne ustawienie opcji, które mają włączoną funkcję autoSettable. Typ danych podany dla value musi być zgodny z type.

OptionType

Chrome 125 lub nowsza

Typ danych opcji.

Typ wyliczeniowy

„UNKNOWN”
Typ danych opcji jest nieznany. Właściwość value zostanie cofnięta.

„BOOL”
Właściwość value będzie miała wartość truefalse.

„INT”
32-bitowa liczba całkowita ze znakiem. Właściwość value będzie miała wartość long lub long[], w zależności od tego, czy opcja przyjmuje więcej niż jedną wartość.

„FIXED”
Liczba zmiennoprzecinkowa o podwójnej precyzji z zakresu od -32768 do 32767,9999 i rozdzielczości 1/65535. Właściwość value będzie miała wartość double lub double[], w zależności od tego, czy opcja przyjmuje więcej niż jedną wartość. Wartości typu double, których nie można dokładnie przedstawić, zostaną zaokrąglone do dostępnego zakresu i dokładności.

„STRING”
Sekwencja dowolnych bajtów z wyjątkiem znaku NUL („\0”). Właściwość value będzie ciągiem DOMString.

„BUTTON”
Opcja tego typu nie ma wartości. Ustawienie opcji tego typu powoduje efekt uboczny w sterowniku skanera, który jest specyficzny dla danej opcji. Na przykład opcja typu przycisku może być używana przez sterownik skanera do wybierania wartości domyślnych lub do informowania automatycznego podajnika dokumentów, aby przesunął się do następnego arkusza papieru.

„GROUP”
Opcja grupowania. Brak wartości. Jest to uwzględnione ze względu na zgodność, ale zwykle nie jest zwracane w wartościach ScannerOption. Użyj getOptionGroups(), aby pobrać listę grup z opcjami członków.

OptionUnit

Chrome 125 lub nowsza

Określa typ danych dla ScannerOption.unit.

Typ wyliczeniowy

„UNITLESS”
Wartość jest liczbą bez jednostki. Może to być na przykład wartość progowa.

„PIXEL”
Wartość to liczba pikseli, np. wymiary skanu.

„BIT”
Wartość to liczba bitów, np. głębia koloru.

„MM”
Wartość jest mierzona w milimetrach, np. wymiary skanu.

„DPI”
Wartość jest mierzona w punktach na cal, np. rozdzielczość.

„PERCENT”
Wartość jest procentem, np. jasność.

„MICROSECOND”
Wartość jest mierzona w mikrosekundach, np. czas ekspozycji.

ReadScanDataResponse

Chrome 125 lub nowsza

Właściwości

  • dane

    ArrayBuffer opcjonalny

    Jeśli result to SUCCESS, zawiera kolejny fragment danych zeskanowanego obrazu. Jeśli result ma wartość EOF, zawiera ostatni fragment zeskanowanych danych obrazu.

  • estimatedCompletion

    number opcjonalny

    Jeśli result ma wartość SUCCESS, szacunkowa wartość procentowa danych skanowania, które zostały do tej pory dostarczone, w zakresie od 0 do 100.

  • zadanie

    tekst

    Zwraca uchwyt zadania przekazany do readScanData().

  • Wynik odczytu danych. Jeśli jego wartość to SUCCESS, data zawiera następny (prawdopodobnie pusty) fragment danych obrazu, który jest gotowy do odczytu. Jeśli jego wartość to EOF, data zawiera ostatni fragment danych obrazu.

ScannerInfo

Chrome 125 lub nowsza

Właściwości

  • connectionType

    ConnectionType

    Określa sposób połączenia skanera z komputerem.

  • deviceUuid

    tekst

    Do dopasowywania do innych wpisów ScannerInfo, które wskazują to samo urządzenie fizyczne.

  • imageFormats

    string[]

    Tablica typów MIME, o które można poprosić w przypadku zwracanych skanów.

  • producent

    tekst

    Producent skanera.

  • model

    tekst

    Model skanera, jeśli jest dostępny, lub ogólny opis.

  • nazwa

    tekst

    Zrozumiała dla człowieka nazwa skanera, która będzie wyświetlana w interfejsie.

  • protocolType

    tekst

    Zrozumiały dla człowieka opis protokołu lub sterownika używanego do uzyskiwania dostępu do skanera, np. Mopria, WSD lub epsonds. Jest to przydatne przede wszystkim wtedy, gdy użytkownik ma możliwość wyboru protokołu, ponieważ urządzenie obsługuje ich kilka.

  • scannerId

    tekst

    Identyfikator konkretnego skanera.

  • Bezpieczny

    wartość logiczna

    Jeśli wartość to „true”, połączenie skanera nie może zostać przechwycone przez pasywnego odbiorcę, takiego jak TLS lub USB.

ScannerOption

Chrome 125 lub nowsza

Właściwości

  • możliwość konfiguracji,

    Możliwość konfiguracji

    Wskazuje, czy i jak można zmienić opcję.

  • ograniczenie

    OptionConstraint opcjonalny

    Definiuje OptionConstraint w bieżącej opcji skanera.

  • opis

    tekst

    Dłuższy opis opcji.

  • isActive

    wartość logiczna

    Wskazuje, że opcja jest aktywna i można ją ustawić lub pobrać. Jeśli ma wartość Fałsz, właściwość value nie zostanie ustawiona.

  • isAdvanced

    wartość logiczna

    Wskazuje, że interfejs nie powinien domyślnie wyświetlać tej opcji.

  • isAutoSettable

    wartość logiczna

    Może być automatycznie ustawiony przez sterownik skanera.

  • isDetectable

    wartość logiczna

    Wskazuje, że tę opcję można wykryć za pomocą oprogramowania.

  • isEmulated

    wartość logiczna

    Emulowane przez sterownik skanera, jeśli ma wartość Prawda.

  • nazwa

    tekst

    Nazwa opcji zawierająca małe litery ASCII, cyfry i myślniki. Znaki diakrytyczne są niedozwolone.

  • tytuł

    tekst

    drukowalny tytuł w jednym wierszu;

  • Typ danych zawarty we właściwości value, który jest potrzebny do ustawienia tej opcji.

  • Jednostka

    OptionUnit

    Jednostka miary dla tej opcji.

  • wartość

    string | number | boolean | number[] opcjonalnie

    Bieżąca wartość opcji (w stosownych przypadkach). Pamiętaj, że typ danych tej właściwości musi być zgodny z typem danych określonym w type.

ScanOptions

Właściwości

  • maxImages

    number opcjonalny

    Liczba dozwolonych skanowanych obrazów. Wartość domyślna to 1.

  • mimeTypes

    string[] opcjonalnie

    Typy MIME akceptowane przez rozmówcę.

ScanResults

Właściwości

  • dataUrls

    string[]

    Tablica adresów URL obrazów danych w formacie, który można przekazać jako wartość „src” do tagu obrazu.

  • mimeType

    tekst

    Typ MIME dataUrls.

SetOptionResult

Chrome 125 lub nowsza

Właściwości

  • nazwa

    tekst

    Wskazuje nazwę ustawionej opcji.

  • Wskazuje wynik ustawienia opcji.

SetOptionsResponse

Chrome 125 lub nowsza

Właściwości

  • Opcje

    obiekt opcjonalny

    Zaktualizowane mapowanie klucz-wartość z nazw opcji na wartości ScannerOption zawierające nową konfigurację po próbie ustawienia wszystkich podanych opcji. Ma taką samą strukturę jak usługa options w OpenScannerResponse.

    Ta właściwość zostanie ustawiona nawet wtedy, gdy niektóre opcje nie zostaną ustawione, ale zostanie usunięta, jeśli pobieranie zaktualizowanej konfiguracji się nie powiedzie (np. jeśli skaner zostanie odłączony w trakcie skanowania).

  • wyniki

    SetOptionResult[]

    Tablica wyników, po jednym dla każdego przekazanego parametru OptionSetting.

  • scannerHandle

    tekst

    Zapewnia uchwyt skanera przekazany do setOptions().

StartScanOptions

Chrome 125 lub nowsza

Właściwości

  • format

    tekst

    Określa typ MIME, w którym mają być zwracane zeskanowane dane.

  • maxReadSize

    number opcjonalny

    Jeśli podano wartość inną niż zero, ogranicza ona maksymalną liczbę zeskanowanych bajtów zwracanych w pojedynczej odpowiedzi readScanData do tej wartości. Najmniejsza dozwolona wartość to 32768 (32 KB). Jeśli ta właściwość nie jest określona, rozmiar zwróconego fragmentu może być równy rozmiarowi całego zeskanowanego obrazu.

StartScanResponse

Chrome 125 lub nowsza

Właściwości

  • zadanie

    ciąg znaków opcjonalny

    Jeśli result ma wartość SUCCESS, zwraca uchwyt, którego można użyć do odczytania danych skanowania lub anulowania zadania.

  • Wynik rozpoczęcia skanowania. Jeśli wartość tego parametru to SUCCESS, zostanie wypełniona właściwość job.

  • scannerHandle

    tekst

    Zwraca ten sam uchwyt skanera, który został przekazany do funkcji startScan().

Metody

cancelScan()

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

Anuluje rozpoczęte skanowanie i zwraca Promise, który jest rozwiązywany za pomocą obiektu CancelScanResponse. Jeśli używana jest funkcja wywołania zwrotnego, zamiast tego przekazywany jest do niej obiekt.

Parametry

  • zadanie

    tekst

    Uchwyt aktywnego zadania skanowania zwrócony wcześniej przez wywołanie funkcji startScan.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (response: CancelScanResponse) => void

Zwroty

  • Zwraca obiekt Promise, który jest rozwiązywany z wynikiem.

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

closeScanner()

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

Zamyka skaner za pomocą przekazanego uchwytu i zwraca obietnicę, która jest realizowana za pomocą obiektu CloseScannerResponse. Jeśli używana jest funkcja wywołania zwrotnego, zamiast tego przekazywany jest do niej obiekt. Nawet jeśli odpowiedź nie jest pozytywna, podany uchwyt staje się nieprawidłowy i nie należy go używać do dalszych operacji.

Parametry

  • scannerHandle

    tekst

    Określa uchwyt otwartego skanera, który został wcześniej zwrócony przez wywołanie funkcji openScanner.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (response: CloseScannerResponse) => void

Zwroty

  • Zwraca obiekt Promise, który jest rozwiązywany z wynikiem.

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

getOptionGroups()

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

Pobiera nazwy grup i opcje członków ze skanera otwartego wcześniej przez funkcję openScanner. Ta metoda zwraca obietnicę, która jest spełniana przez obiekt GetOptionGroupsResponse. Jeśli do tej funkcji zostanie przekazane wywołanie zwrotne, zamiast tego zostaną do niego przekazane zwrócone dane.

Parametry

Zwroty

  • Zwraca obiekt Promise, który jest rozwiązywany z wynikiem.

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

getScannerList()

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

Pobiera listę dostępnych skanerów i zwraca obiekt Promise, który jest rozwiązywany za pomocą obiektu GetScannerListResponse. Jeśli do tej funkcji zostanie przekazane wywołanie zwrotne, zamiast tego zostaną do niego przekazane zwrócone dane.

Parametry

Zwroty

  • Zwraca obiekt Promise, który jest rozwiązywany z wynikiem i listą skanerów.

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

openScanner()

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

Otwiera skaner do wyłącznego dostępu i zwraca obietnicę, która jest rozwiązywana za pomocą obiektu OpenScannerResponse. Jeśli do tej funkcji zostanie przekazane wywołanie zwrotne, zamiast tego zostaną do niego przekazane zwrócone dane.

Parametry

  • scannerId

    tekst

    Identyfikator skanera, który ma zostać otwarty. Ta wartość jest zwracana z poprzedniego wywołania funkcji getScannerList.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (response: OpenScannerResponse) => void

Zwroty

  • Zwraca obiekt Promise, który jest rozwiązywany z wynikiem.

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

readScanData()

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

Odczytuje następny fragment dostępnych danych obrazu z aktywnego uchwytu zadania i zwraca obietnicę, która jest spełniana przez obiekt ReadScanDataResponse. Jeśli używana jest funkcja wywołania zwrotnego, zamiast tego przekazywany jest do niej obiekt.

**Uwaga: prawidłowy wynik odpowiedzi może mieć wartość SUCCESS z elementem data o zerowej długości. Oznacza to, że skaner nadal działa, ale nie ma jeszcze gotowych dodatkowych danych. Dzwoniący powinien poczekać chwilę i spróbować ponownie.

Po zakończeniu skanowania w odpowiedzi pojawi się wartość EOF. Ta odpowiedź może zawierać końcowy element data o wartości innej niż 0.

Parametry

Zwroty

  • Zwraca obiekt Promise, który jest rozwiązywany z wynikiem.

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

scan()

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

Skanuje dokument i zwraca obiekt Promise, który jest rozwiązywany za pomocą obiektu ScanResults. Jeśli do tej funkcji zostanie przekazane wywołanie zwrotne, zamiast tego przekazywane są do niego zwrócone dane.

Parametry

  • Opcje

    ScanOptions

    Obiekt zawierający parametry skanowania.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (result: ScanResults) => void

Zwroty

  • Promise<ScanResults>

    Chrome 96 lub nowsza

    Zwraca obiekt Promise, który jest rozwiązywany z wynikami skanowania.

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

setOptions()

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

Ustawia opcje na określonym skanerze i zwraca Promise, który jest rozwiązywany za pomocą obiektu SetOptionsResponse zawierającego wynik próby ustawienia każdej wartości w kolejności przekazanego obiektu OptionSetting. Jeśli używana jest funkcja wywołania zwrotnego, zamiast tego przekazywany jest do niej obiekt.

Parametry

  • scannerHandle

    tekst

    Uchwyt skanera, na którym można ustawić opcje. Powinna to być wartość zwrócona wcześniej przez wywołanie funkcji openScanner.

  • Opcje

    OptionSetting[]

    Lista OptionSetting obiektów, które mają być zastosowane w skanerze.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (response: SetOptionsResponse) => void

Zwroty

  • Zwraca obiekt Promise, który jest rozwiązywany z wynikiem.

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

startScan()

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

Rozpoczyna skanowanie na określonym skanerze i zwraca obietnicę, która jest spełniana za pomocą obiektu StartScanResponse. Jeśli używana jest funkcja wywołania zwrotnego, zamiast tego przekazywany jest do niej obiekt. Jeśli wywołanie się powiedzie, odpowiedź zawiera uchwyt zadania, którego można użyć w kolejnych wywołaniach do odczytywania danych skanowania lub anulowania skanowania.

Parametry

  • scannerHandle

    tekst

    Uchwyt otwartego skanera. Powinna to być wartość zwrócona wcześniej przez wywołanie funkcji openScanner.

  • Obiekt StartScanOptions wskazujący opcje, które mają być używane podczas skanowania. Właściwość StartScanOptions.format musi być zgodna z jednym z wpisów zwróconych w parametrze ScannerInfo skanera.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (response: StartScanResponse) => void

Zwroty

  • Zwraca obiekt Promise, który jest rozwiązywany z wynikiem.

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.