chrome.documentScan

תאריך הרענון: 2026-09-25 robots: noindex

תיאור

אפשר להשתמש ב-chrome.documentScan API כדי לגלות ולאחזר תמונות מסורקי מסמכים שמחוברים למכשיר.

הרשאות

documentScan

זמינות

‫Chrome 44 ואילך ChromeOS בלבד

Document Scan API

ממשק Document Scan API נועד לאפשר לאפליקציות ולתוספים להציג את התוכן של מסמכים מודפסים בסורק מסמכים שמחובר למכשיר.

סוגים

CancelScanResponse

‫Chrome 125 ואילך

מאפיינים

  • משימה

    מחרוזת

    השירות הזה מספק את אותו מזהה משימה שהועבר אל cancelScan().

  • תוצאה

    OperationResult

    התוצאה של ביטול הסריקה ב-backend. אם התוצאה היא OperationResult.SUCCESS או OperationResult.CANCELLED, הסריקה בוטלה והסורק מוכן להתחיל סריקה חדשה. אם התוצאה היא OperationResult.DEVICE_BUSY , הסורק עדיין מעבד את הביטול המבוקש. המתקשר צריך להמתין זמן קצר ולנסות שוב לשלוח את הבקשה. ערכי תוצאה אחרים מציינים שגיאה קבועה שלא כדאי לנסות שוב.

CloseScannerResponse

‫Chrome 125 ואילך

מאפיינים

  • תוצאה

    OperationResult

    התוצאה של סגירת הסורק. גם אם הערך הזה לא SUCCESS, ה-handle יהיה לא תקין ולא יהיה אפשר להשתמש בו לפעולות נוספות.

  • scannerHandle

    מחרוזת

    אותו הנדל של הסורק שהועבר אל closeScanner.

Configurability

‫Chrome 125 ואילך

איך אפשר לשנות אפשרות.

ספירה

‫NOT_CONFIGURABLE
האפשרות היא לקריאה בלבד.

‫SOFTWARE_CONFIGURABLE
אפשר להגדיר את האפשרות בתוכנה.

‫HARDWARE_CONFIGURABLE
המשתמש יכול להגדיר את האפשרות באמצעות החלפה או לחיצה על לחצן בסורק.

ConnectionType

‫Chrome 125 ואילך

מציין איך הסורק מחובר למחשב.

ספירה

‫UNSPECIFIED

‫"USB"

‎"NETWORK"

ConstraintType

‫Chrome 125 ואילך

סוג הנתונים של האילוץ שמיוצג על ידי OptionConstraint.

ספירה

‫INT_RANGE
ההגבלה על טווח של ערכי OptionType.INT. המאפיינים min,‏ max ו-quant של OptionConstraint יהיו long, והמאפיין list שלו לא יוגדר.

‫FIXED_RANGE
ההגבלה על טווח של ערכי OptionType.FIXED. המאפיינים min,‏ max ו-quant של OptionConstraint יהיו double, והמאפיין list שלו לא יוגדר.

‫INT_LIST
ההגבלה על רשימה ספציפית של ערכי OptionType.INT. המאפיין OptionConstraint.list יכיל ערכים של long, ושאר המאפיינים לא יוגדרו.

‫FIXED_LIST
ההגבלה על רשימה ספציפית של ערכי OptionType.FIXED. המאפיין OptionConstraint.list יכיל ערכים של double, ושאר המאפיינים לא יוגדרו.

‫STRING_LIST
ההגבלה על רשימה ספציפית של ערכי OptionType.STRING. המאפיין OptionConstraint.list יכיל ערכים של DOMString, ושאר המאפיינים לא יוגדרו.

DeviceFilter

‫Chrome 125 ואילך

מאפיינים

  • local

    ‫boolean אופציונלי

    יוחזרו רק סורקים שמחוברים ישירות למחשב.

  • מאובטח

    ‫boolean אופציונלי

    אפשר להחזיר רק סורקים שמשתמשים בהעברה מאובטחת, כמו USB או TLS.

GetOptionGroupsResponse

‫Chrome 125 ואילך

מאפיינים

  • קבוצות

    ‫OptionGroup[] אופציונלי

    אם result הוא SUCCESS, מספק רשימה של קבוצות אפשרויות לפי הסדר שסופק על ידי מנהל ההתקן של הסורק.

  • תוצאה

    OperationResult

    התוצאה של קבלת קבוצות האפשרויות. אם הערך של המאפיין הזה הוא SUCCESS, המאפיין groups יאוכלס.

  • scannerHandle

    מחרוזת

    אותו הנדל של הסורק שהועבר אל getOptionGroups.

GetScannerListResponse

‫Chrome 125 ואילך

מאפיינים

  • תוצאה

    OperationResult

    תוצאת הספירה. שימו לב: יכול להיות שיוחזרו תוצאות חלקיות גם אם השגיאה הזו מצוינת.

  • סורקים

    ScannerInfo[]

    רשימה של סורקים שתואמים לDeviceFilter שצוין, יכול להיות שהרשימה תהיה ריקה.

OpenScannerResponse

‫Chrome 125 ואילך

מאפיינים

  • options

    אובייקט אופציונלי

    אם result הוא SUCCESS, הפונקציה מספקת מיפוי של מפתח/ערך, כאשר המפתח הוא אפשרות ספציפית למכשיר והערך הוא מופע של ScannerOption.

  • תוצאה

    OperationResult

    התוצאה של פתיחת הסורק. אם הערך של המאפיין הזה הוא SUCCESS, המאפיינים scannerHandle ו-options יאוכלסו.

  • scannerHandle

    מחרוזת אופציונלי

    אם הערך של result הוא SUCCESS, מחזירה את ה-handle של הסורק שאפשר להשתמש בו לפעולות נוספות.

  • scannerId

    מחרוזת

    מזהה הסורק שמועבר אל openScanner().

OperationResult

‫Chrome 125 ואילך

סוג enum שמציין את התוצאה של כל פעולה.

ספירה

UNKNOWN
אירעה שגיאה לא ידועה או כללית.

‫SUCCESS
הפעולה בוצעה בהצלחה.

‫UNSUPPORTED
הפעולה לא נתמכת.

'בוטלה'
הפעולה בוטלה.

‫DEVICE_BUSY
המכשיר עסוק.

‫INVALID
הנתונים או הארגומנט שהועבר לשיטה לא תקינים.

‫WRONG_TYPE
הערך שצוין הוא מסוג הנתונים הלא נכון לאפשרות הבסיסית.

‫"EOF"
אין יותר נתונים זמינים.

‫"ADF_JAMMED"
מזין המסמכים תקוע.

‫ADF_EMPTY
מזין המסמכים ריק.

‫"COVER_OPEN"
המכסה של משטח הסריקה פתוח.

‫IO_ERROR
אירעה שגיאה במהלך התקשורת עם המכשיר.

‫ACCESS_DENIED
המכשיר מחייב אימות.

‫NO_MEMORY
אין מספיק זיכרון ב-Chromebook כדי להשלים את הפעולה.

‫UNREACHABLE
לא ניתן לגשת למכשיר.

‫MISSING
המכשיר מנותק.

‫INTERNAL_ERROR
אירעה שגיאה במקום אחר ולא באפליקציה שמבצעת את השיחה.

OptionConstraint

‫Chrome 125 ואילך

מאפיינים

  • list

    string[] | number[] אופציונלי

  • מקסימלי

    מספר אופציונלי

  • דק'

    מספר אופציונלי

  • quant

    מספר אופציונלי

OptionGroup

‫Chrome 125 ואילך

מאפיינים

  • חברים

    string[]

    מערך של שמות אפשרויות בסדר שסופק על ידי הדרייבר.

  • title

    מחרוזת

    הכותרת שמופיעה כאן ניתנת להדפסה, למשל 'אפשרויות גיאומטריה'.

OptionSetting

‫Chrome 125 ואילך

מאפיינים

  • שם

    מחרוזת

    מציין את שם האפשרות שצריך להגדיר.

  • סוג

    OptionType

    מציין את סוג הנתונים של האפשרות. סוג הנתונים שמופיע בבקשה צריך להיות זהה לסוג הנתונים האמיתי של האפשרות הבסיסית.

  • ערך

    מחרוזת | מספר | בוליאני | מספר[] אופציונלי

    מציין את הערך שצריך להגדיר. אם לא מגדירים את האפשרות הזו, המערכת מבקשת הגדרה אוטומטית לאפשרויות שמופעלות בהן autoSettable. סוג הנתונים שצוין עבור value חייב להיות זהה ל-type.

OptionType

‫Chrome 125 ואילך

סוג הנתונים של האפשרות.

ספירה

‫UNKNOWN
סוג הנתונים של האפשרות לא ידוע. המאפיין value לא יוגדר.

‫BOOL
המאפיין value יהיה אחד מהערכים truefalse.

‫INT
מספר שלם חתום בן 32 ביט. המאפיין value יהיה long או long[], בהתאם למספר הערכים שהאפשרות מקבלת.

‫FIXED
מספר כפול בטווח ‎-32768-32767.9999 עם רזולוציה של ‎1/65535. המאפיין value יהיה double או double[], בהתאם לשאלה אם האפשרות מקבלת יותר מערך אחד. ערכי Double שלא ניתן לייצג בדיוק יעוגלו לטווח ולדיוק הזמינים.

‫"STRING"
רצף של בייטים כלשהם, חוץ מ-NUL (‎'\0'). המאפיין value יהיה DOMString.

‫"BUTTON"
לאפשרות מסוג זה אין ערך. במקום זאת, הגדרת אפשרות מהסוג הזה גורמת לתופעת לוואי ספציפית לאפשרות במנהל ההתקן של הסורק. לדוגמה, מנהל התקן של סורק יכול להשתמש באפשרות מסוג לחצן כדי לספק אמצעי לבחירת ערכי ברירת מחדל או כדי להורות למזין מסמכים אוטומטי לעבור לדף הנייר הבא.

‫GROUP
אפשרות קיבוץ. אין ערך. הוא נכלל לצורך תאימות, אבל בדרך כלל לא יוחזר בערכים של ScannerOption. משתמשים ב-getOptionGroups() כדי לאחזר את רשימת הקבוצות עם אפשרויות החברים שלהן.

OptionUnit

‫Chrome 125 ואילך

מציין את סוג הנתונים של ScannerOption.unit.

ספירה

‫UNITLESS
הערך הוא מספר ללא יחידה. לדוגמה, יכול להיות שזה ערך סף.

‫"PIXEL"
הערך הוא מספר פיקסלים, למשל מידות סריקה.

‫"BIT"
הערך הוא מספר הביטים, למשל עומק הצבע.

‫MM
הערך נמדד במילימטרים, למשל מידות של סריקה.

‫DPI
הערך נמדד בנקודות לאינץ', למשל, רזולוציה.

‫PERCENT
הערך הוא אחוז, למשל בהירות.

‫"MICROSECOND"
הערך נמדד במיקרו-שניות, למשל זמן החשיפה.

ReadScanDataResponse

‫Chrome 125 ואילך

מאפיינים

  • נתונים

    ‫ArrayBuffer אופציונלי

    אם הערך של result הוא SUCCESS, העמודה מכילה את המקטע הבא של נתוני תמונת הסריקה. אם הערך של result הוא EOF, השדה מכיל את הנתונים של החלק האחרון של התמונה שנסרקה.

  • estimatedCompletion

    מספר אופציונלי

    אם הערך של result הוא SUCCESS, מוצגת הערכה של כמות נתוני הסריקה הכוללת שנמסרו עד עכשיו, בטווח 0 עד 100.

  • משימה

    מחרוזת

    השירות הזה מספק את ה-handle של העבודה שהועבר אל readScanData().

  • תוצאה

    OperationResult

    התוצאה של קריאת הנתונים. אם הערך שלו הוא SUCCESS, אז data מכיל את נתוני התמונה הבאים (יכול להיות שאין נתונים) שמוכנים לקריאה. אם הערך שלו הוא EOF, רכיב data מכיל את נתוני התמונה האחרונים.

ScannerInfo

‫Chrome 125 ואילך

מאפיינים

  • connectionType

    ConnectionType

    מציין איך הסורק מחובר למחשב.

  • deviceUuid

    מחרוזת

    לצורך התאמה לערכים אחרים של ScannerInfo שמפנים לאותו מכשיר פיזי.

  • imageFormats

    string[]

    מערך של סוגי MIME שאפשר לבקש עבור סריקות שמוחזרות.

  • יצרן

    מחרוזת

    יצרן הסורק.

  • מודל

    מחרוזת

    מודל הסורק אם הוא זמין, או תיאור כללי.

  • שם

    מחרוזת

    שם קריא לאנשים של הסורק, שיוצג בממשק המשתמש.

  • protocolType

    מחרוזת

    תיאור קריא לאנשים של הפרוטוקול או מנהל ההתקן שמשמשים לגישה לסורק, כמו Mopria,‏ WSD או epsonds. האפשרות הזו שימושית בעיקר כדי לאפשר למשתמש לבחור בין פרוטוקולים אם מכשיר תומך בכמה פרוטוקולים.

  • scannerId

    מחרוזת

    המזהה של סורק ספציפי.

  • מאובטח

    בוליאני

    אם הערך הוא True, אי אפשר ליירט את התעבורה של חיבור הסורק על ידי מאזין פסיבי, כמו TLS או USB.

ScannerOption

‫Chrome 125 ואילך

מאפיינים

  • יכולת הגדרה

    אפשרויות ההגדרה

    מציין אם אפשר לשנות את האפשרות ואיך.

  • מגבלה

    ‫OptionConstraint optional

    הגדרת OptionConstraint באפשרות הסורק הנוכחית.

  • תיאור

    מחרוזת

    תיאור ארוך יותר של האפשרות.

  • isActive

    בוליאני

    מציין שהאפשרות פעילה וניתן להגדיר או לאחזר אותה. אם הערך הוא False, המאפיין value לא יוגדר.

  • isAdvanced

    בוליאני

    מציין שהאפשרות הזו לא תוצג בממשק המשתמש כברירת מחדל.

  • isAutoSettable

    בוליאני

    יכול להיות שיוגדר אוטומטית על ידי מנהל ההתקן של הסורק.

  • isDetectable

    בוליאני

    מציין שאפשר לזהות את האפשרות הזו מתוכנה.

  • isEmulated

    בוליאני

    אם הערך הוא true, מנהל ההתקן של הסורק מבצע אמולציה.

  • שם

    מחרוזת

    שם האפשרות באותיות קטנות של ASCII, מספרים ומקפים. אסור להשתמש בסימני ניקוד.

  • title

    מחרוזת

    כותרת בת שורה אחת שאפשר להדפיס.

  • סוג

    OptionType

    סוג הנתונים שכלול במאפיין value, שנדרש להגדרת האפשרות הזו.

  • יחידה

    OptionUnit

    יחידת המידה של האפשרות הזו.

  • ערך

    מחרוזת | מספר | בוליאני | מספר[] אופציונלי

    הערך הנוכחי של האפשרות, אם רלוונטי. שימו לב שסוג הנתונים של המאפיין הזה צריך להיות זהה לסוג הנתונים שצוין ב-type.

ScanOptions

מאפיינים

  • maxImages

    מספר אופציונלי

    מספר התמונות הסרוקות המותר. ערך ברירת המחדל הוא 1.

  • mimeTypes

    string[] אופציונלי

    סוגי ה-MIME שהמתקשר מקבל.

ScanResults

מאפיינים

  • dataUrls

    string[]

    מערך של כתובות URL של תמונות נתונים בפורמט שאפשר להעביר כערך 'src' לתג תמונה.

  • mimeType

    מחרוזת

    סוג ה-MIME של dataUrls.

SetOptionResult

‫Chrome 125 ואילך

מאפיינים

  • שם

    מחרוזת

    מציין את שם האפשרות שהוגדרה.

  • תוצאה

    OperationResult

    מציין את התוצאה של הגדרת האפשרות.

SetOptionsResponse

‫Chrome 125 ואילך

מאפיינים

  • options

    אובייקט אופציונלי

    מיפוי מעודכן של זוגות מפתח/ערך משמות האפשרויות לערכים של ScannerOption, שמכיל את ההגדרה החדשה אחרי ניסיון להגדיר את כל האפשרויות שסופקו. המבנה של המאפיין הזה זהה למבנה של המאפיין options ב-OpenScannerResponse.

    המאפיין הזה יוגדר גם אם חלק מהאפשרויות לא הוגדרו בהצלחה, אבל הוא יבוטל אם אחזור ההגדרות המעודכנות ייכשל (לדוגמה, אם הסורק ינותק באמצע הסריקה).

  • תוצאות

    SetOptionResult[]

    מערך של תוצאות, אחת לכל OptionSetting שהועבר.

  • scannerHandle

    מחרוזת

    השירות הזה מספק את ה-handle של הסורק שמועבר אל setOptions().

StartScanOptions

‫Chrome 125 ואילך

מאפיינים

  • פורמט

    מחרוזת

    מציין את סוג ה-MIME שבו יוחזרו הנתונים שנסרקו.

  • maxReadSize

    מספר אופציונלי

    אם מציינים ערך שאינו אפס, הערך הזה מגביל את מספר הבייטים המקסימלי שנסרקו ומוחזרים בתגובה יחידה של readScanData. הערך הקטן ביותר שמותר הוא 32768 (32KB). אם לא מציינים את המאפיין הזה, גודל החלק שמוחזר יכול להיות גדול כמו התמונה הסרוקה כולה.

StartScanResponse

‫Chrome 125 ואילך

מאפיינים

  • משימה

    מחרוזת אופציונלי

    אם הערך של result הוא SUCCESS, הפונקציה מחזירה נקודת אחיזה שאפשר להשתמש בה כדי לקרוא את נתוני הסריקה או לבטל את המשימה.

  • תוצאה

    OperationResult

    התוצאה של התחלת סריקה. אם הערך של המאפיין הזה הוא SUCCESS, המאפיין job יאוכלס.

  • scannerHandle

    מחרוזת

    מחזירה את אותו ה-handle של הסורק שהועבר אל startScan().

Methods

cancelScan()

Promise Chrome 125 ואילך 
chrome.documentScan.cancelScan(
  job: string,
  callback?: function,
): Promise<CancelScanResponse>

מבטל סריקה שהתחילה ומחזיר Promise שמוביל לאובייקט CancelScanResponse. אם נעשה שימוש בפונקציית קריאה חוזרת, האובייקט מועבר אליה במקום זאת.

פרמטרים

  • משימה

    מחרוזת

    הכינוי של משימת סריקה פעילה שהוחזר קודם מקריאה אל startScan.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (response: CancelScanResponse) => void

החזרות

  • מחזירה Promise שמושלם עם התוצאה.

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

closeScanner()

Promise Chrome 125 ואילך 
chrome.documentScan.closeScanner(
  scannerHandle: string,
  callback?: function,
): Promise<CloseScannerResponse>

סוגרת את הסורק עם ה-handle שהועבר ומחזירה Promise שמוחזר עם אובייקט CloseScannerResponse. אם נעשה שימוש בפונקציית קריאה חוזרת, האובייקט מועבר אליה במקום זאת. גם אם התגובה לא מציינת הצלחה, ה-handle שסופק הופך ללא תקף ואין להשתמש בו לפעולות נוספות.

פרמטרים

  • scannerHandle

    מחרוזת

    מציין את ה-handle של סורק פתוח שהוחזר קודם מקריאה אל openScanner.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (response: CloseScannerResponse) => void

החזרות

  • מחזירה Promise שמושלם עם התוצאה.

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

getOptionGroups()

Promise Chrome 125 ואילך 
chrome.documentScan.getOptionGroups(
  scannerHandle: string,
  callback?: function,
): Promise<GetOptionGroupsResponse>

מקבל את שמות הקבוצות ואת אפשרויות החברים מסורק שנפתח קודם על ידי openScanner. השיטה הזו מחזירה Promise שמוביל לאובייקט GetOptionGroupsResponse. אם מעבירים פונקציית קריאה חוזרת לפונקציה הזו, הנתונים שמוחזרים מועברים אליה במקום זאת.

פרמטרים

החזרות

  • מחזירה Promise שמושלם עם התוצאה.

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

getScannerList()

Promise Chrome 125 ואילך 
chrome.documentScan.getScannerList(
  filter: DeviceFilter,
  callback?: function,
): Promise<GetScannerListResponse>

מקבלת את רשימת הסורקים הזמינים ומחזירה Promise שמוביל לאובייקט GetScannerListResponse. אם מעבירים פונקציית קריאה חוזרת לפונקציה הזו, הנתונים שמוחזרים מועברים אליה במקום זאת.

פרמטרים

החזרות

  • מחזירה Promise שמוביל לתוצאה ולרשימת הסורקים.

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

openScanner()

Promise Chrome 125 ואילך 
chrome.documentScan.openScanner(
  scannerId: string,
  callback?: function,
): Promise<OpenScannerResponse>

פותחת סורק לגישה בלעדית ומחזירה Promise שמוחזר עם אובייקט OpenScannerResponse. אם מעבירים פונקציית קריאה חוזרת לפונקציה הזו, הנתונים שמוחזרים מועברים אליה במקום זאת.

פרמטרים

  • scannerId

    מחרוזת

    המזהה של הסורק שרוצים לפתוח. הערך הזה הוא אחד מהערכים שמוחזרים מקריאה קודמת אל getScannerList.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (response: OpenScannerResponse) => void

החזרות

  • מחזירה Promise שמושלם עם התוצאה.

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

readScanData()

Promise Chrome 125 ואילך 
chrome.documentScan.readScanData(
  job: string,
  callback?: function,
): Promise<ReadScanDataResponse>

קוראת את הנתונים הבאים של התמונה הזמינה מתוך נקודת אחיזה של משימה פעילה, ומחזירה הבטחה (Promise) שמושלמת עם אובייקט ReadScanDataResponse. אם נעשה שימוש בפונקציית קריאה חוזרת, האובייקט מועבר אליה במקום זאת.

**הערה:**אפשר להחזיר תשובה SUCCESS עם חבר data באורך אפס. זה אומר שהסורק עדיין פועל, אבל אין עדיין נתונים נוספים שמוכנים לשימוש. המתקשר צריך להמתין זמן קצר ולנסות שוב.

כשמשימת הסריקה תסתיים, ערך התוצאה בתגובה יהיה EOF. יכול להיות שהתשובה הזו תכלול חבר data סופי שאינו אפס.

פרמטרים

  • משימה

    מחרוזת

    הכינוי הפעיל של המשימה הוחזר קודם מ-startScan.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (response: ReadScanDataResponse) => void

החזרות

  • מחזירה Promise שמושלם עם התוצאה.

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

scan()

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

מבצעת סריקה של מסמך ומחזירה Promise שמוביל לאובייקט ScanResults. אם מעבירים פונקציית קריאה חוזרת לפונקציה הזו, הנתונים שמוחזרים מועברים אליה במקום זאת.

פרמטרים

  • options

    ScanOptions

    אובייקט שמכיל פרמטרים של סריקה.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (result: ScanResults) => void

החזרות

  • Promise<ScanResults>

    ‫Chrome 96 ואילך

    הפונקציה מחזירה Promise שמושלם עם תוצאות הסריקה.

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

setOptions()

Promise Chrome 125 ואילך 
chrome.documentScan.setOptions(
  scannerHandle: string,
  options: OptionSetting[],
  callback?: function,
): Promise<SetOptionsResponse>

מגדירה אפשרויות בסורק שצוין ומחזירה הבטחה (Promise) שנפתרת עם אובייקט SetOptionsResponse שמכיל את התוצאה של הניסיון להגדיר כל ערך בסדר של אובייקט OptionSetting שהועבר. אם נעשה שימוש בפונקציית קריאה חוזרת, האובייקט מועבר אליה במקום זאת.

פרמטרים

  • scannerHandle

    מחרוזת

    נקודת האחיזה של הסורק שרוצים להגדיר עבורה אפשרויות. הערך הזה צריך להיות ערך שהוחזר קודם מקריאה ל-openScanner.

  • options

    OptionSetting[]

    רשימה של OptionSetting אובייקטים להחלה על הסורק.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (response: SetOptionsResponse) => void

החזרות

  • מחזירה Promise שמושלם עם התוצאה.

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

startScan()

Promise Chrome 125 ואילך 
chrome.documentScan.startScan(
  scannerHandle: string,
  options: StartScanOptions,
  callback?: function,
): Promise<StartScanResponse>

הפונקציה מתחילה סריקה בסורק שצוין ומחזירה Promise שמוביל ל-StartScanResponse. אם נעשה שימוש בפונקציית קריאה חוזרת, האובייקט מועבר אליה במקום זאת. אם הקריאה מצליחה, התשובה כוללת את ה-handle של העבודה, שאפשר להשתמש בו בקריאות הבאות כדי לקרוא את נתוני הסריקה או לבטל את הסריקה.

פרמטרים

  • scannerHandle

    מחרוזת

    ידית של סורק פתוח. הערך הזה צריך להיות ערך שהוחזר קודם מקריאה ל-openScanner.

  • אובייקט StartScanOptions שמציין את האפשרויות שבהן יש להשתמש בסריקה. הערך של המאפיין StartScanOptions.format צריך להיות זהה לאחד מהערכים שמוחזרים ב-ScannerInfo של הסורק.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (response: StartScanResponse) => void

החזרות

  • מחזירה Promise שמוביל לתוצאה.

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.