Mô tả
Sử dụng API chrome.documentScan
để khám phá và truy xuất hình ảnh qua trình quét tài liệu đính kèm.
Quyền
documentScan
Phạm vi cung cấp
API Quét tài liệu
API Quét tài liệu đượ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áy quét tài liệu đính kèm.
Loại
CancelScanResponse
Thuộc tính
-
việc làm
string
Cung cấp cùng một tên người dùng công việc đã được truyền đến
cancelScan()
. -
kết quả
Kết quả huỷ quét của máy chủ phụ trợ. Nếu kết quả là
OperationResult.SUCCESS
hoặcOperationResult.CANCELLED
, thì quá trình quét đã bị huỷ và trình quét sẵn sàng bắt đầu một lượt 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ỷ theo yêu cầu; phương thức gọi sẽ đợi một chút 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 và bạn không nên thử lại.
CloseScannerResponse
Thuộc tính
-
kết quả
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
, tên người dùng vẫn không hợp lệ và bạn không nên dùng tên người dùng này cho các thao tác khác. -
scannerHandle
string
Tên người dùng của trình quét tương tự như đã được truyền cho
closeScanner
.
Configurability
Cách thay đổi một lựa chọn.
Enum
"NOT_CONFIGURABLE"
Tuỳ chọn này là chỉ có thể đọc.
"SOFTWARE_CONFIGURABLE"
Bạn có thể đặt lựa 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 một nút trên máy quét.
ConnectionType
Cho biết cách kết nối máy quét với máy tính.
Enum
"KHÔNG XÁC ĐỊNH"
"USB"
"MẠNG"
ConstraintType
Loại dữ liệu của quy tắc ràng buộc được biểu thị bằng OptionConstraint
.
Enum
"INT_RANGE"
Hạn chế đố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à thế hệ list
của nó sẽ không được đặt.
"FIXED_RANGE"
Hạn chế đố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 thuộc tính này sẽ không được đặt.
"INT_LIST"
Quy tắc ràng buộc đối với một danh sách giá trị OptionType.INT
cụ thể. Thuộc tính OptionConstraint.list
sẽ chứa long
giá trị 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 giá trị OptionType.FIXED
cụ thể. Thuộc tính OptionConstraint.list
sẽ chứa double
giá trị 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 giá trị OptionType.STRING
cụ thể. Thuộc tính OptionConstraint.list
sẽ chứa DOMString
giá trị và các thuộc tính khác sẽ không được đặt.
DeviceFilter
Thuộc tính
-
local
boolean không bắt buộc
Chỉ trả lại các máy quét được gắn 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
Thuộc tính
-
nhóm
OptionGroup[] không bắt buộc
Nếu
result
làSUCCESS
, hãy 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ả
Kết quả của việc nhận 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ínhgroups
sẽ được điền sẵn. -
scannerHandle
string
Tên người dùng của trình quét tương tự như đã được truyền cho
getOptionGroups
.
GetScannerListResponse
Thuộc tính
-
kết quả
Kết quả liệt kê. Lưu ý rằng kết quả một phần có thể được trả về ngay cả khi điều này cho thấy có lỗi.
-
máy quét
Danh sách các trình quét có thể trống phù hợp với
DeviceFilter
được cung cấp.
OpenScannerResponse
Thuộc tính
-
tùy chọn
đối tượng không bắt buộc
Nếu
result
làSUCCESS
, hãy cung cấp mối liên kết khoá-giá trị, trong đó khoá là một lựa chọn dành riêng cho thiết bị và giá trị là một thực thể củaScannerOption
. -
kết quả
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ínhscannerHandle
vàoptions
sẽ được điền sẵn. -
scannerHandle
chuỗi không bắt buộc
Nếu
result
làSUCCESS
, bạn có thể dùng một tay cầm cho trình quét để thực hiện các thao tác khác. -
scannerId
string
Mã máy quét được truyền đến
openScanner()
.
OperationResult
Một giá trị 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 này 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 đều không hợp lệ.
"WRONG_TYPE"
Giá trị đã cung cấp không đúng loại dữ liệu cho lựa chọn cơ bản.
"EOF"
Không có thêm dữ liệu nào.
"ADF_JAMMED"
Trình nạp tài liệu bị kẹt.
"ADF_EMPTY"
Trình nạp tài liệu trống.
"COVER_OPEN"
Nắp đế phẳng đang mở.
"IO_ERROR"
Đã xảy ra lỗi khi kết nối với thiết bị.
"ACCESS_DENIED"
Thiết bị yêu cầu xác thực.
"NO_MEMORY"
Không có đủ bộ nhớ trên Chromebook để hoàn tất thao tác.
"UNREACHABLE"
Không kết nối được với thiết bị.
"MISSING"
Thiết bị đã bị ngắt kết nối.
"INTERNAL_ERROR"
Đã xảy ra lỗi ở nơi khác ngoài ứng dụng gọi.
OptionConstraint
Thuộc tính
-
danh sách
string[] | number[] không bắt buộc
-
tối đa
số không bắt buộc
-
phút
số không bắt buộc
-
lượng tử
số không bắt buộc
-
loại
OptionGroup
Thuộc tính
-
thành viên
chuỗi[]
Một mảng tên các lựa chọn theo thứ tự do người lái xe cung cấp.
-
tiêu đề
string
Cung cấp tiêu đề in được, ví dụ: "Tuỳ chọn hình học".
OptionSetting
Thuộc tính
-
tên
string
Cho biết tên của tuỳ chọn cần đặt.
-
loại
Cho biết loại dữ liệu của tuỳ chọn. Loại dữ liệu được yêu cầu phải khớp với loại dữ liệu thực của lựa chọn cơ bản.
-
value
string | số | boolean | number[] không bắt buộc
Cho biết giá trị cần đặt. Hãy không đặt để yêu cầu chế độ cài đặt tự động cho các lựa chọn đã bật
autoSettable
. Loại dữ liệu được cung cấp chovalue
phải khớp vớitype
.
OptionType
Loại dữ liệu của một lựa chọn.
Enum
"UNKNOWN"
Loại dữ liệu của lựa chọn này không xác định. Thuộc tính value
sẽ bị huỷ thiết lập.
"BOOL"
Thuộc tính value
sẽ có giá trị là true
false.
"INT"
Một số nguyên 32 bit đã ký. Thuộc tính value
sẽ dài 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"
Gấp đôi trong khoảng -32768-32767.9999 với độ phân giải 1/65535. Thuộc tính value
sẽ là gấp đôi hoặc kép [], tuỳ thuộc vào việc tuỳ chọn này có nhận nhiều giá trị hay không. Những giá trị kép không thể thể hiện chính xác sẽ được làm tròn thành phạm vi và độ chính xác có sẵn.
"STRING"
Một chuỗi gồm bất kỳ byte nào ngoại trừ NUL ('\0'). Thuộc tính value
sẽ là DOMString.
"NÚT"
Tuỳ chọn 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 hiệu ứng phụ tuỳ chọn cụ thể 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 tuỳ chọn nhập bằng nút để cung cấp phương tiện để chọn các giá trị mặc định hoặc để trình nạp tài liệu tự động chuyển đến trang giấy tiếp theo.
"GROUP"
Tuỳ chọn nhóm. Không có giá trị. Dữ liệu này được dùng để đả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 nhóm kèm theo các lựa chọn về thành viên.
Enum
"UNITLESS"
Giá trị là số không đơn vị. Ví dụ: đó có thể là một ngưỡng.
"PIXEL"
Giá trị là một 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 milimet, ví dụ: kích thước quét.
"DPI"
Giá trị này được đo bằng số điểm trên mỗi inch, chẳng hạn như độ phân giải.
"PERCENT"
Giá trị là phần trăm, ví dụ: độ sáng.
"MICROMETRIC"
Giá trị này được đo bằng micrô giây, chẳng hạn như thời gian phơi sáng.
ReadScanDataResponse
Thuộc tính
-
dữ liệu
ArrayBuffer không bắt buộc
Nếu
result
làSUCCESS
, thì chứa phân đoạn tiếp theo của dữ liệu hình ảnh đã quét. Nếuresult
làEOF
, thì chứa đoạn cuối của dữ liệu hình ảnh đã quét. -
estimatedCompletion
số không bắt buộc
Nếu
result
làSUCCESS
, thì ước tính lượng dữ liệu quét đã phân phối tính đến thời điểm hiện tại, trong phạm vi từ 0 đến 100. -
việc làm
string
Cung cấp tên người dùng được truyền đến
readScanData()
. -
kết quả
Kết quả của việc đọc dữ liệu. Nếu giá trị của lớp này là
SUCCESS
, thìdata
sẽ 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 tệp này làEOF
, thìdata
sẽ chứa đoạn cuối của dữ liệu hình ảnh.
ScannerInfo
Thuộc tính
-
connectionType
Cho biết cách kết nối máy quét với máy tính.
-
deviceUuid
string
Để so khớp với các mục nhập
ScannerInfo
khác trỏ đến cùng một thiết bị thực. -
imageFormats
chuỗi[]
Một mảng các loại MIME có thể được yêu cầu cho các lần quét trả về.
-
nhà sản xuất
string
Nhà sản xuất máy quét.
-
kiểu máy
string
Mô hình máy quét (nếu có) hoặc nội dung mô tả chung chung.
-
tên
string
Tên mà con người có thể đọc được để trình quét hiển thị trong giao diện người dùng.
-
protocolType
string
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 cho 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
string
Mã của một trình quét cụ thể.
-
bảo mật
boolean
Nếu đúng, quá trình truyền tải kết nối của trình quét sẽ không bị chặn bằng một trình nghe thụ động, chẳng hạn như TLS hoặc USB.
ScannerOption
Thuộc tính
-
khả năng định cấu hình
Cho biết liệu có thể thay đổi tuỳ chọn này hay không và bằng cách nào.
-
quy tắc ràng buộc
OptionConstraint không bắt buộc
Xác định
OptionConstraint
trên tuỳ chọn trình quét hiện tại. -
description
string
Nội dung mô tả dài hơn về lựa chọn.
-
isActive
boolean
Cho biết tuỳ chọn này đang hoạt động và có thể được đặt hoặc truy xuất. Nếu đặt là false, thuộc tính
value
sẽ không được đặt. -
isAdvanced
boolean
Cho biết rằng theo mặc định, giao diện người dùng không nên hiển thị tuỳ chọn này.
-
isAutoSettable
boolean
Trình điều khiển máy quét có thể tự động thiết lập.
-
isDetectable
boolean
Cho biết lựa chọn này có thể được phát hiện qua phần mềm.
-
isEmulated
boolean
Được mô phỏng bằng trình điều khiển máy quét nếu đúng.
-
tên
string
Tên tuỳ 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 dùng dấu phụ.
-
tiêu đề
string
Tiêu đề 1 dòng có thể in được.
-
loại
Loại dữ liệu có trong thuộc tính
value
cần thiết để đặt tuỳ chọn này. -
đơn vị
Đơn vị đo lường cho lựa chọn này.
-
value
string | số | boolean | number[] không bắt buộc
Giá trị hiện tại của lựa chọn, nếu thích hợp. Lưu ý rằng loại dữ liệu của tài sản này phải khớp với loại dữ liệu đã chỉ định trong
type
.
ScanOptions
Thuộc tính
-
maxImages
số không bắt buộc
Số lượng ảnh đã quét được phép. Giá trị mặc định là 1.
-
mimeTypes
string[] không bắt buộc
Loại MIME được phương thức gọi chấp nhận.
ScanResults
Thuộc tính
-
dataUrls
chuỗi[]
Một mảng URL hình ảnh dữ liệu trong một biểu mẫu có thể được chuyển dưới dạng "src" thành một thẻ hình ảnh.
-
mimeType
string
Loại MIME của
dataUrls
.
SetOptionResult
Thuộc tính
-
tên
string
Cho biết tên của tuỳ chọn đã được đặt.
-
kết quả
Cho biết kết quả của việc đặt lựa chọn này.
SetOptionsResponse
Thuộc tính
-
tùy chọn
đối tượng không bắt buộc
Đã cập nhật ánh xạ khoá-giá trị từ tên tuỳ chọn đến các 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ấu trúc giống như thuộc tínhoptions
trongOpenScannerResponse
.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 trong quá trình quét).
-
kết quả
Một mảng kết quả, mỗi kết quả cho mỗi
OptionSetting
được truyền vào. -
scannerHandle
string
Cung cấp tay điều khiển trình quét được truyền đến
setOptions()
.
StartScanOptions
Thuộc tính
-
định dạng
string
Chỉ định loại MIME để trả về dữ liệu đã quét.
-
maxReadSize
số không bắt buộc
Nếu một giá trị khác 0 được chỉ định, hãy giới hạn số byte đã quét tối đa được trả về trong một phản hồi
readScanData
duy nhất cho giá trị đó. Giá trị nhỏ nhất được phép là 32768 (32 KB). Nếu thuộc tính này không được chỉ định, kích thước của phân đoạn được trả về có thể lớn bằng toàn bộ hình ảnh được quét.
StartScanResponse
Thuộc tính
-
việc làm
chuỗi không bắt buộc
Nếu
result
làSUCCESS
, hãy cung cấp một tên người dùng có thể dùng để đọc dữ liệu quét hoặc huỷ lệnh. -
kết quả
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ínhjob
sẽ được điền sẵn. -
scannerHandle
string
Cung cấp cùng một tên người dùng của trình quét đã được truyền đến
startScan()
.
Phương thức
cancelScan()
chrome.documentScan.cancelScan(
job: string,
callback?: function,
)
Huỷ quá trình quét đã bắt đầu và trả về một Promise phân giải bằng đối tượng CancelScanResponse
. Nếu bạn sử dụng lệnh gọi lại, thì đối tượng sẽ được truyền vào đối tượng đó.
Tham số
-
việc làm
string
Quá trình xử lý của một lệnh quét đang hoạt động mà trước đó được trả về từ một lệnh gọi đến
startScan
. -
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(response: CancelScanResponse) => void
-
phản hồi
-
Giá trị trả về
-
Promise<CancelScanResponse>
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()
chrome.documentScan.closeScanner(
scannerHandle: string,
callback?: function,
)
Đóng trình quét bằng tên người dùng được truyền vào và trả về một Lời hứa (Promise) phân giải bằng đối tượng CloseScannerResponse
. Nếu bạn sử dụng lệnh gọi lại, thì đối tượng sẽ được truyền vào đối tượng đó. Ngay cả khi phản hồi không thành công, tên người dùng đã cung cấp sẽ không hợp lệ và bạn không nên dùng tên người dùng này cho các thao tác khác.
Tham số
-
scannerHandle
string
Chỉ định xử lý của một trình quét đang mở mà trước đó được lệnh gọi đến
openScanner
trả về. -
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(response: CloseScannerResponse) => void
-
phản hồi
-
Giá trị trả về
-
Promise<CloseScannerResponse>
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()
chrome.documentScan.getOptionGroups(
scannerHandle: string,
callback?: function,
)
Lấy tên nhóm và các lựa chọn thành viên từ trình quét do openScanner
mở trước đó. 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 vào hàm này, thì dữ liệu trả về sẽ được truyền vào hàm đó.
Tham số
-
scannerHandle
string
Tài khoản xử lý của một trình quét đang mở được trả về từ lệnh gọi đến
openScanner
. -
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(response: GetOptionGroupsResponse) => void
-
phản hồi
-
Giá trị trả về
-
Promise<GetOptionGroupsResponse>
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()
chrome.documentScan.getScannerList(
filter: DeviceFilter,
callback?: function,
)
Lấy danh sách các trình quét hiện có và trả về một Lời hứa (Promise) sẽ phân giải bằng đối tượng GetScannerListResponse
. Nếu một lệnh gọi lại được truyền vào hàm này, thì dữ liệu trả về sẽ được truyền vào hàm đó.
Tham số
-
filter
DeviceFilter
cho biết loại trình quét cần được trả về. -
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(response: GetScannerListResponse) => void
-
phản hồi
-
Giá trị trả về
-
Promise<GetScannerListResponse>
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()
chrome.documentScan.openScanner(
scannerId: string,
callback?: function,
)
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 (Promise) sẽ phân giải bằng đối tượng OpenScannerResponse
. Nếu một lệnh gọi lại được truyền vào hàm này, thì dữ liệu trả về sẽ được truyền vào hàm đó.
Tham số
-
scannerId
string
Mã nhận dạng của trình quét sẽ được mở. Giá trị này được trả về từ lệnh gọi
getScannerList
trước đó. -
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(response: OpenScannerResponse) => void
-
phản hồi
-
Giá trị trả về
-
Promise<OpenScannerResponse>
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()
chrome.documentScan.readScanData(
job: string,
callback?: function,
)
Đọc đoạn dữ liệu hình ảnh có sẵn tiếp theo từ một xử lý công việc đang hoạt động và trả về một Promise phân giải bằng đối tượng ReadScanDataResponse
. Nếu bạn sử dụng lệnh gọi lại, thì đối tượng sẽ được truyền vào đối tượng đó.
**Lưu ý:**Kết quả phản hồi phải là SUCCESS
với thành phần data
có độ dài bằng 0. Điều này có nghĩa là trình quét vẫn đang hoạt động nhưng chưa có thêm dữ liệu sẵn sàng. Phương thức gọi sẽ đợi một chút rồi thử lại.
Khi lệnh quét hoàn tất, phản hồi sẽ có giá trị kết quả là EOF
. Phản hồi này có thể chứa một thành phần cuối cùng khác 0 của data
.
Tham số
-
việc làm
string
Tên người dùng đang hoạt động được trả về trước đó từ
startScan
. -
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(response: ReadScanDataResponse) => void
-
phản hồi
-
Giá trị trả về
-
Promise<ReadScanDataResponse>
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()
chrome.documentScan.scan(
options: ScanOptions,
callback?: function,
)
Quét tài liệu và trả về một Lời hứa (Promise) phân giải bằng đối tượng ScanResults
. Nếu một lệnh gọi lại được truyền vào hàm này, thì dữ liệu trả về sẽ được chuyển vào hàm đó.
Tham số
-
tùy chọn
Đối tượng chứa các tham số quét.
-
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(result: ScanResults) => void
-
kết quả
-
Giá trị trả về
-
Promise<ScanResults>
Chrome 96 trở lênLờ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()
chrome.documentScan.setOptions(
scannerHandle: string,
options: OptionSetting[],
callback?: function,
)
Đặt các tuỳ chọn trên trình quét được chỉ định và trả về một Lời hứa 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 bạn sử dụng lệnh gọi lại, thì đối tượng sẽ được truyền vào đối tượng đó.
Tham số
-
scannerHandle
string
Tay cầm của trình quét để đặt các tuỳ chọn. Đây phải là một giá trị trước đó được trả về từ lệnh gọi
openScanner
. -
tùy chọn
Danh sách đối tượng
OptionSetting
sẽ được áp dụng cho trình quét. -
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(response: SetOptionsResponse) => void
-
phản hồi
-
Giá trị trả về
-
Promise<SetOptionsResponse>
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()
chrome.documentScan.startScan(
scannerHandle: string,
options: StartScanOptions,
callback?: function,
)
Bắt đầu một lượt quét trên trình quét đã chỉ định và trả về một Lời hứa (Promise) sẽ phân giải bằng một StartScanResponse
. Nếu bạn sử dụng lệnh gọi lại, thì đối tượng sẽ được truyền vào đối tượng đó. Nếu lệnh gọi thành công thì phản hồi sẽ bao gồm một tên xử lý công việc có thể dùng trong các lệnh gọi tiếp theo để đọc dữ liệu quét hoặc huỷ một lượt quét.
Tham số
-
scannerHandle
string
Tay cầm của một trình quét đang mở. Đây phải là một giá trị trước đó được trả về từ lệnh gọi
openScanner
. -
tùy chọn
Đối tượng
StartScanOptions
cho biết các tuỳ chọn sẽ dùng để quét. Thuộc tínhStartScanOptions.format
phải khớp với một trong các mục trả về trongScannerInfo
của trình quét. -
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(response: StartScanResponse) => void
-
phản hồi
-
Giá trị trả về
-
Promise<StartScanResponse>
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.