chrome.documentScan

refresh date: 2026-09-25 robots: noindex

Mô tả

Sử dụng API chrome.documentScan để khám phá và truy xuất hình ảnh từ trình quét tài liệu đính kèm.

Quyền

documentScan

Phạm vi cung cấp

Chrome 44 trở lên Chỉ ChromeOS

API Quét tài liệu

Document Scan API được thiết kế để cho phép các ứng dụng và tiện ích xem nội dung của tài liệu giấy trên một trình quét tài liệu đính kèm.

Loại

CancelScanResponse

Chrome 125 trở lên

Thuộc tính

  • công việc

    chuỗi

    Cung cấp cùng một tay điều khiển công việc đã được truyền đến cancelScan().

  • kết quả

    OperationResult

    Kết quả huỷ quét của phần phụ trợ. Nếu kết quả là OperationResult.SUCCESS hoặc OperationResult.CANCELLED, thì quá trình quét đã bị huỷ và máy quét đã sẵn sàng bắt đầu một quá trình quét mới. Nếu kết quả là OperationResult.DEVICE_BUSY , thì trình quét vẫn đang xử lý yêu cầu huỷ; phương thức gọi nên đợi một lúc rồi thử lại yêu cầu. Các giá trị kết quả khác cho biết lỗi vĩnh viễn không nên thử lại.

CloseScannerResponse

Chrome 125 trở lên

Thuộc tính

  • kết quả

    OperationResult

    Kết quả của việc đóng trình quét. Ngay cả khi giá trị này không phải là SUCCESS, thì tay điều khiển vẫn không hợp lệ và không được dùng cho bất kỳ thao tác nào khác.

  • scannerHandle

    chuỗi

    Cùng một trình xử lý máy quét như đã truyền đến closeScanner.

Configurability

Chrome 125 trở lên

Cách thay đổi một lựa chọn.

Enum

"NOT_CONFIGURABLE"
Lựa chọn này ở chế độ chỉ có thể đọc.

"SOFTWARE_CONFIGURABLE"
Bạn có thể đặt tuỳ chọn này trong phần mềm.

"HARDWARE_CONFIGURABLE"
Người dùng có thể đặt tuỳ chọn này bằng cách bật/tắt hoặc nhấn nút trên máy quét.

ConnectionType

Chrome 125 trở lên

Cho biết cách máy quét kết nối với máy tính.

Enum

"UNSPECIFIED"

"USB"

"NETWORK"

ConstraintType

Chrome 125 trở lên

Kiểu dữ liệu của quy tắc ràng buộc được biểu thị bằng OptionConstraint.

Enum

"INT_RANGE"
Quy tắc ràng buộc đối với một dải giá trị OptionType.INT. Các thuộc tính min, max và quant của OptionConstraint sẽ là long và thuộc tính list của đối tượng này sẽ không được đặt.

"FIXED_RANGE"
Quy tắc ràng buộc đối với một dải giá trị OptionType.FIXED. Các thuộc tính min, max và quant của OptionConstraint sẽ là double và thuộc tính list của nó sẽ không được đặt.

"INT_LIST"
Quy tắc ràng buộc đối với một danh sách cụ thể gồm các giá trị OptionType.INT. Thuộc tính OptionConstraint.list sẽ chứa các giá trị long và các thuộc tính khác sẽ không được đặt.

"FIXED_LIST"
Quy tắc ràng buộc đối với một danh sách cụ thể gồm các giá trị OptionType.FIXED. Thuộc tính OptionConstraint.list sẽ chứa các giá trị double và các thuộc tính khác sẽ không được đặt.

"STRING_LIST"
Quy tắc ràng buộc đối với một danh sách cụ thể gồm các giá trị OptionType.STRING. Thuộc tính OptionConstraint.list sẽ chứa các giá trị DOMString và các thuộc tính khác sẽ không được đặt.

DeviceFilter

Chrome 125 trở lên

Thuộc tính

  • trên thiết bị

    boolean không bắt buộc

    Chỉ trả về những máy quét được kết nối trực tiếp với máy tính.

  • bảo mật

    boolean không bắt buộc

    Chỉ trả về những máy quét sử dụng phương thức truyền tải an toàn, chẳng hạn như USB hoặc TLS.

GetOptionGroupsResponse

Chrome 125 trở lên

Thuộc tính

  • nhóm

    OptionGroup[] không bắt buộc

    Nếu result là SUCCESS, thì sẽ cung cấp danh sách các nhóm tuỳ chọn theo thứ tự do trình điều khiển máy quét cung cấp.

  • kết quả

    OperationResult

    Kết quả của việc lấy các nhóm lựa chọn. Nếu giá trị của thuộc tính này là SUCCESS, thì thuộc tính groups sẽ được điền sẵn.

  • scannerHandle

    chuỗi

    Cùng một trình xử lý máy quét như đã truyền đến getOptionGroups.

GetScannerListResponse

Chrome 125 trở lên

Thuộc tính

  • kết quả

    OperationResult

    Kết quả liệt kê. Xin lưu ý rằng kết quả một phần có thể được trả về ngay cả khi điều này cho biết có lỗi.

  • máy quét

    ScannerInfo[]

    Danh sách (có thể trống) gồm các máy quét khớp với DeviceFilter được cung cấp.

OpenScannerResponse

Chrome 125 trở lên

Thuộc tính

  • tùy chọn

    object không bắt buộc

    Nếu result là SUCCESS, thì sẽ cung cấp một mối liên kết khoá-giá trị, trong đó khoá là một tuỳ chọn dành riêng cho thiết bị và giá trị là một thực thể của ScannerOption.

  • kết quả

    OperationResult

    Kết quả của việc mở trình quét. Nếu giá trị của thuộc tính này là SUCCESS, thì các thuộc tính scannerHandle và options sẽ được điền sẵn.

  • scannerHandle

    chuỗi không bắt buộc

    Nếu result là SUCCESS, thì một tay điều khiển cho máy quét có thể được dùng cho các thao tác khác.

  • scannerId

    chuỗi

    Mã nhận dạng máy quét được chuyển đến openScanner().

OperationResult

Chrome 125 trở lên

Một enum cho biết kết quả của mỗi thao tác.

Enum

"UNKNOWN"
Đã xảy ra lỗi không xác định hoặc lỗi chung.

"SUCCESS"
Thao tác đã thành công.

"UNSUPPORTED"
Thao tác không được hỗ trợ.

"CANCELLED"
Thao tác đã bị huỷ.

"DEVICE_BUSY"
Thiết bị đang bận.

"INVALID"
Dữ liệu hoặc đối số được truyền đến phương thức không hợp lệ.

"WRONG_TYPE"
Giá trị được cung cấp có kiểu dữ liệu không chính xác cho lựa chọn cơ bản.

"EOF"
Không còn dữ liệu nào khác.

"ADF_JAMMED"
Khay nạp tài liệu bị kẹt.

"ADF_EMPTY"
Khay nạp tài liệu trống.

"COVER_OPEN"
Nắp máy quét phẳng đang mở.

"IO_ERROR"
Đã xảy ra lỗi khi giao tiếp với thiết bị.

"ACCESS_DENIED"
Thiết bị yêu cầu xác thực.

"NO_MEMORY"
Chromebook không có đủ bộ nhớ để hoàn tất thao tác.

"UNREACHABLE"
Không kết nối được với thiết bị.

"MISSING"
Thiết bị đã ngắt kết nối.

"INTERNAL_ERROR"
Đã xảy ra lỗi ở một nơi nào đó không phải là ứng dụng gọi.

OptionConstraint

Chrome 125 trở lên

Thuộc tính

  • danh sách

    string[] | number[] không bắt buộc

  • tối đa

    number không bắt buộc

  • phút

    number không bắt buộc

  • quant

    number không bắt buộc

OptionGroup

Chrome 125 trở lên

Thuộc tính

  • thành viên

    string[]

    Một mảng tên tuỳ chọn theo thứ tự do trình điều khiển cung cấp.

  • tiêu đề

    chuỗi

    Cung cấp tiêu đề có thể in, ví dụ: "Tuỳ chọn hình học".

OptionSetting

Chrome 125 trở lên

Thuộc tính

  • tên

    chuỗi

    Cho biết tên của tuỳ chọn cần đặt.

  • loại

    OptionType

    Cho biết loại dữ liệu của lựa chọn. Kiểu dữ liệu được yêu cầu phải khớp với kiểu dữ liệu thực của lựa chọn cơ bản.

  • value

    string | number | boolean | number[] không bắt buộc

    Cho biết giá trị cần đặt. Để trống để yêu cầu cài đặt tự động cho các lựa chọn đã bật autoSettable. Loại dữ liệu được cung cấp cho value phải khớp với type.

OptionType

Chrome 125 trở lên

Kiểu dữ liệu của một lựa chọn.

Enum

"UNKNOWN"
Không xác định được loại dữ liệu của lựa chọn. Thuộc tính value sẽ không được đặt.

"BOOL"
Thuộc tính value sẽ là một trong các giá trị truefalse.

"INT"
Số nguyên 32 bit có dấu. Thuộc tính value sẽ là long hoặc long[], tuỳ thuộc vào việc tuỳ chọn này có nhận nhiều giá trị hay không.

"FIXED"
Một số thực có độ chính xác kép trong khoảng từ -32768 đến 32767,9999 với độ phân giải là 1/65535. Thuộc tính value sẽ là double hoặc double[] tuỳ thuộc vào việc tuỳ chọn có nhận nhiều giá trị hay không. Các giá trị Double không thể biểu thị chính xác sẽ được làm tròn đến phạm vi và độ chính xác có sẵn.

"STRING"
Một chuỗi byte bất kỳ ngoại trừ NUL ('\0'). Thuộc tính value sẽ là DOMString.

"BUTTON"
Một lựa chọn thuộc loại này không có giá trị. Thay vào đó, việc đặt một tuỳ chọn thuộc loại này sẽ gây ra tác dụng phụ dành riêng cho tuỳ chọn trong trình điều khiển máy quét. Ví dụ: trình điều khiển máy quét có thể sử dụng một tuỳ chọn thuộc loại nút để cung cấp phương tiện chọn giá trị mặc định hoặc yêu cầu khay nạp tài liệu tự động chuyển sang tờ giấy tiếp theo.

"GROUP"
Lựa chọn nhóm. Không có giá trị. Giá trị này được đưa vào để đảm bảo khả năng tương thích, nhưng thường sẽ không được trả về trong các giá trị ScannerOption. Sử dụng getOptionGroups() để truy xuất danh sách các nhóm cùng với các lựa chọn thành viên của nhóm.

OptionUnit

Chrome 125 trở lên

Cho biết loại dữ liệu của ScannerOption.unit.

Enum

"UNITLESS"
Giá trị là một số không có đơn vị. Ví dụ: đó có thể là một ngưỡng.

"PIXEL"
Giá trị là số pixel, ví dụ: kích thước quét.

"BIT"
Giá trị là số bit, ví dụ: độ sâu màu.

"MM"
Giá trị được đo bằng milimét, ví dụ: kích thước quét.

"DPI"
Giá trị được đo bằng số điểm trên mỗi inch, ví dụ: độ phân giải.

"PERCENT"
Giá trị là phần trăm, ví dụ: độ sáng.

"MICROSECOND"
Giá trị được đo bằng micrô giây, ví dụ: thời gian phơi sáng.

ReadScanDataResponse

Chrome 125 trở lên

Thuộc tính

  • khác

    Không bắt buộc ArrayBuffer

    Nếu result là SUCCESS, thì sẽ chứa đoạn dữ liệu hình ảnh được quét tiếp theo. Nếu result là EOF, thì sẽ chứa phần dữ liệu hình ảnh được quét cuối cùng.

  • estimatedCompletion

    number không bắt buộc

    Nếu result là SUCCESS, thì đây là giá trị ước tính về lượng dữ liệu quét đã được phân phối cho đến nay, trong khoảng từ 0 đến 100.

  • công việc

    chuỗi

    Cung cấp tên người dùng công việc được truyền đến readScanData().

  • kết quả

    OperationResult

    Kết quả của việc đọc dữ liệu. Nếu giá trị của nó là SUCCESS, thì data chứa đoạn dữ liệu hình ảnh tiếp theo (có thể có độ dài bằng 0) đã sẵn sàng để đọc. Nếu giá trị của thuộc tính này là EOF, thì data sẽ chứa đoạn dữ liệu hình ảnh cuối cùng.

ScannerInfo

Chrome 125 trở lên

Thuộc tính

  • connectionType

    ConnectionType

    Cho biết cách máy quét kết nối với máy tính.

  • deviceUuid

    chuỗi

    Để so khớp với các mục ScannerInfo khác trỏ đến cùng một thiết bị thực.

  • imageFormats

    string[]

    Một mảng các loại MIME có thể được yêu cầu cho các bản quét được trả về.

  • nhà sản xuất

    chuỗi

    Nhà sản xuất máy quét.

  • kiểu máy

    chuỗi

    Mẫu máy quét (nếu có) hoặc nội dung mô tả chung.

  • tên

    chuỗi

    Tên con người có thể đọc được của máy quét để hiển thị trong giao diện người dùng.

  • protocolType

    chuỗi

    Nội dung mô tả mà con người có thể đọc được về giao thức hoặc trình điều khiển dùng để truy cập vào máy quét, chẳng hạn như Mopria, WSD hoặc epsonds. Điều này chủ yếu hữu ích trong việc cho phép người dùng chọn giữa các giao thức nếu thiết bị hỗ trợ nhiều giao thức.

  • scannerId

    chuỗi

    Mã của một máy quét cụ thể.

  • bảo mật

    boolean

    Nếu đúng, thì trình nghe thụ động (chẳng hạn như TLS hoặc USB) không thể chặn phương thức truyền tải của kết nối máy quét.

ScannerOption

Chrome 125 trở lên

Thuộc tính

  • khả năng định cấu hình

    Khả năng định cấu hình

    Cho biết liệu có thể thay đổi lựa chọn này hay không và thay đổi như thế nào.

  • giới hạn

    OptionConstraint không bắt buộc

    Xác định OptionConstraint trên tuỳ chọn máy quét hiện tại.

  • mô tả

    chuỗi

    Nội dung mô tả dài hơn về lựa chọn.

  • isActive

    boolean

    Cho biết tuỳ chọn đang hoạt động và có thể được đặt hoặc truy xuất. Nếu bạn đặt thành false, thuộc tính value sẽ không được đặt.

  • isAdvanced

    boolean

    Cho biết rằng giao diện người dùng không nên hiển thị tuỳ chọn này theo mặc định.

  • isAutoSettable

    boolean

    Trình điều khiển máy quét có thể tự động đặt giá trị này.

  • isDetectable

    boolean

    Cho biết rằng phần mềm có thể phát hiện tuỳ chọn này.

  • isEmulated

    boolean

    Được trình điều khiển máy quét mô phỏng nếu đúng.

  • tên

    chuỗi

    Tên lựa chọn sử dụng chữ cái ASCII viết thường, số và dấu gạch ngang. Không được phép sử dụng dấu phụ.

  • tiêu đề

    chuỗi

    Tiêu đề một dòng có thể in được.

  • loại

    OptionType

    Kiểu dữ liệu có trong thuộc tính value, cần thiết để đặt tuỳ chọn này.

  • đơn vị

    OptionUnit

    Đơn vị đo lường cho lựa chọn này.

  • value

    string | number | boolean | number[] không bắt buộc

    Giá trị hiện tại của lựa chọn (nếu có). Xin lưu ý rằng loại dữ liệu của thuộc tính này phải khớp với loại dữ liệu được chỉ định trong type.

ScanOptions

Thuộc tính

  • maxImages

    number không bắt buộc

    Số lượng hình ảnh được phép quét. Giá trị mặc định là 1.

  • mimeTypes

    string[] không bắt buộc

    Các loại MIME mà phương thức gọi chấp nhận.

ScanResults

Thuộc tính

  • dataUrls

    string[]

    Một mảng URL hình ảnh dữ liệu ở dạng có thể được truyền dưới dạng giá trị "src" đến thẻ hình ảnh.

  • mimeType

    chuỗi

    Loại MIME của dataUrls.

SetOptionResult

Chrome 125 trở lên

Thuộc tính

  • tên

    chuỗi

    Cho biết tên của lựa chọn đã được đặt.

  • kết quả

    OperationResult

    Cho biết kết quả của việc đặt tuỳ chọn.

SetOptionsResponse

Chrome 125 trở lên

Thuộc tính

  • tùy chọn

    object không bắt buộc

    Một mối liên kết khoá-giá trị mới từ tên tuỳ chọn đến giá trị ScannerOption chứa cấu hình mới sau khi cố gắng đặt tất cả tuỳ chọn được cung cấp. Thuộc tính này có cùng cấu trúc với thuộc tính options trong OpenScannerResponse.

    Thuộc tính này sẽ được đặt ngay cả khi một số tuỳ chọn không được đặt thành công, nhưng sẽ không được đặt nếu không truy xuất được cấu hình đã cập nhật (ví dụ: nếu máy quét bị ngắt kết nối giữa quá trình quét).

  • kết quả

    SetOptionResult[]

    Một mảng kết quả, mỗi kết quả cho mỗi OptionSetting được truyền vào.

  • scannerHandle

    chuỗi

    Cung cấp trình xử lý máy quét được truyền đến setOptions().

StartScanOptions

Chrome 125 trở lên

Thuộc tính

  • định dạng

    chuỗi

    Chỉ định loại MIME để trả về dữ liệu đã quét.

  • maxReadSize

    number không bắt buộc

    Nếu bạn chỉ định một giá trị khác 0, thì số byte tối đa được quét và trả về trong một phản hồi readScanData sẽ bị giới hạn ở giá trị đó. Giá trị nhỏ nhất được cho phép là 32768 (32 KB). Nếu bạn không chỉ định thuộc tính này, thì kích thước của một đoạn được trả về có thể lớn bằng toàn bộ hình ảnh được quét.

StartScanResponse

Chrome 125 trở lên

Thuộc tính

  • công việc

    chuỗi không bắt buộc

    Nếu result là SUCCESS, thì sẽ cung cấp một tay điều khiển có thể dùng để đọc dữ liệu quét hoặc huỷ công việc.

  • kết quả

    OperationResult

    Kết quả của việc bắt đầu quét. Nếu giá trị của thuộc tính này là SUCCESS, thì thuộc tính job sẽ được điền sẵn.

  • scannerHandle

    chuỗi

    Cung cấp cùng một tay điều khiển máy quét đã được truyền đến startScan().

Phương thức

cancelScan()

Promise Chrome 125 trở lên 
chrome.documentScan.cancelScan(
  job: string,
  callback?: function,
): Promise<CancelScanResponse>

Huỷ quá trình quét đã bắt đầu và trả về một Lời hứa sẽ phân giải bằng đối tượng CancelScanResponse. Nếu lệnh gọi lại được sử dụng, thì đối tượng sẽ được truyền đến lệnh gọi lại đó.

Thông số

  • công việc

    chuỗi

    Tên người dùng của một công việc quét đang hoạt động được trả về trước đó từ lệnh gọi đến startScan.

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (response: CancelScanResponse) => void

Giá trị trả về

  • Trả về một Promise phân giải bằng kết quả.

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

closeScanner()

Promise Chrome 125 trở lên 
chrome.documentScan.closeScanner(
  scannerHandle: string,
  callback?: function,
): Promise<CloseScannerResponse>

Đóng máy quét bằng tay điều khiển được truyền vào và trả về một Lời hứa phân giải bằng đối tượng CloseScannerResponse. Nếu lệnh gọi lại được sử dụng, thì đối tượng sẽ được truyền đến lệnh gọi lại đó. Ngay cả khi phản hồi không thành công, tay điều khiển được cung cấp sẽ không hợp lệ và không được dùng cho các thao tác khác.

Thông số

  • scannerHandle

    chuỗi

    Chỉ định tên người dùng của một trình quét đang mở, được trả về trước đó từ một lệnh gọi đến openScanner.

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (response: CloseScannerResponse) => void

Giá trị trả về

  • Trả về một Promise phân giải bằng kết quả.

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

getOptionGroups()

Promise Chrome 125 trở lên 
chrome.documentScan.getOptionGroups(
  scannerHandle: string,
  callback?: function,
): Promise<GetOptionGroupsResponse>

Lấy tên nhóm và các lựa chọn thành viên từ một trình quét đã được mở trước đó bằng openScanner. Phương thức này trả về một Lời hứa phân giải bằng đối tượng GetOptionGroupsResponse. Nếu một lệnh gọi lại được truyền đến hàm này, thì dữ liệu được trả về sẽ được truyền đến lệnh gọi lại đó.

Thông số

  • scannerHandle

    chuỗi

    Giá trị điều khiển của một trình quét đang mở được trả về từ lệnh gọi đến openScanner.

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (response: GetOptionGroupsResponse) => void

Giá trị trả về

  • Trả về một Promise phân giải bằng kết quả.

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

getScannerList()

Promise Chrome 125 trở lên 
chrome.documentScan.getScannerList(
  filter: DeviceFilter,
  callback?: function,
): Promise<GetScannerListResponse>

Lấy danh sách máy quét hiện có và trả về một Lời hứa phân giải bằng đối tượng GetScannerListResponse. Nếu một lệnh gọi lại được truyền đến hàm này, thì dữ liệu được trả về sẽ được truyền đến lệnh gọi lại đó.

Thông số

Giá trị trả về

  • Trả về một Lời hứa sẽ phân giải bằng kết quả và danh sách máy quét.

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

openScanner()

Promise Chrome 125 trở lên 
chrome.documentScan.openScanner(
  scannerId: string,
  callback?: function,
): Promise<OpenScannerResponse>

Mở một trình quét để có quyền truy cập độc quyền và trả về một Lời hứa sẽ phân giải bằng đối tượng OpenScannerResponse. Nếu một lệnh gọi lại được truyền đến hàm này, thì dữ liệu được trả về sẽ được truyền đến lệnh gọi lại đó.

Thông số

  • scannerId

    chuỗi

    Mã của trình quét cần mở. Giá trị này là giá trị được trả về từ lệnh gọi trước đó đến getScannerList.

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (response: OpenScannerResponse) => void

Giá trị trả về

  • Trả về một Promise phân giải bằng kết quả.

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

readScanData()

Promise Chrome 125 trở lên 
chrome.documentScan.readScanData(
  job: string,
  callback?: function,
): Promise<ReadScanDataResponse>

Đọc đoạn dữ liệu hình ảnh có sẵn tiếp theo từ một tay điều khiển công việc đang hoạt động và trả về một Lời hứa phân giải bằng đối tượng ReadScanDataResponse. Nếu lệnh gọi lại được sử dụng, thì đối tượng sẽ được truyền đến lệnh gọi lại đó.

**Lưu ý:**Kết quả phản hồi có thể là SUCCESS với thành viên data có độ dài bằng 0. Điều này có nghĩa là máy quét vẫn đang hoạt động nhưng chưa có thêm dữ liệu. Người gọi nên đợi một lát rồi thử lại.

Khi công việc quét hoàn tất, phản hồi sẽ có giá trị kết quả là EOF. Câu trả lời này có thể chứa một thành viên data khác 0 cuối cùng.

Thông số

  • công việc

    chuỗi

    Tên người dùng của công việc đang hoạt động được trả về trước đó từ startScan.

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (response: ReadScanDataResponse) => void

Giá trị trả về

  • Trả về một Promise phân giải bằng kết quả.

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

scan()

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

Thực hiện quét tài liệu và trả về một Promise phân giải bằng đối tượng ScanResults. Nếu một lệnh gọi lại được truyền đến hàm này, thì dữ liệu được trả về sẽ được truyền đến lệnh gọi lại đó.

Thông số

  • tùy chọn

    ScanOptions

    Một đối tượng chứa các tham số quét.

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (result: ScanResults) => void

Giá trị trả về

  • Promise<ScanResults>

    Chrome 96 trở lên

    Trả về một Lời hứa (Promise) phân giải bằng kết quả quét.

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

setOptions()

Promise Chrome 125 trở lên 
chrome.documentScan.setOptions(
  scannerHandle: string,
  options: OptionSetting[],
  callback?: function,
): Promise<SetOptionsResponse>

Đặt các tuỳ chọn trên máy quét được chỉ định và trả về một Promise phân giải bằng đối tượng SetOptionsResponse chứa kết quả của việc cố gắng đặt mọi giá trị theo thứ tự của đối tượng OptionSetting được truyền vào. Nếu lệnh gọi lại được sử dụng, thì đối tượng sẽ được truyền đến lệnh gọi lại đó.

Thông số

  • scannerHandle

    chuỗi

    Ô điều khiển của máy quét để đặt các tuỳ chọn. Đây phải là giá trị được trả về trước đó từ lệnh gọi đến openScanner.

  • tùy chọn

    OptionSetting[]

    Danh sách các đối tượng OptionSetting sẽ được áp dụng cho máy quét.

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (response: SetOptionsResponse) => void

Giá trị trả về

  • Trả về một Promise phân giải bằng kết quả.

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

startScan()

Promise Chrome 125 trở lên 
chrome.documentScan.startScan(
  scannerHandle: string,
  options: StartScanOptions,
  callback?: function,
): Promise<StartScanResponse>

Bắt đầu quét trên máy quét được chỉ định và trả về một Lời hứa sẽ phân giải bằng StartScanResponse. Nếu lệnh gọi lại được sử dụng, thì đối tượng sẽ được truyền đến lệnh gọi lại đó. Nếu lệnh gọi thành công, phản hồi sẽ bao gồm một tên người dùng có thể dùng trong các lệnh gọi tiếp theo để đọc dữ liệu quét hoặc huỷ quá trình quét.

Thông số

  • scannerHandle

    chuỗi

    Tay cầm của một máy quét đang mở. Đây phải là giá trị được trả về trước đó từ lệnh gọi đến openScanner.

  • tùy chọn

    StartScanOptions

    Đối tượng StartScanOptions cho biết các tuỳ chọn sẽ được dùng cho quá trình quét. Thuộc tính StartScanOptions.format phải khớp với một trong các mục nhập được trả về trong ScannerInfo của máy quét.

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (response: StartScanResponse) => void

Giá trị trả về

  • Trả về một Promise phân giải bằng kết quả.

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.