chrome.documentScan

refresh date: 2026-09-25 robots: noindex

תיאור

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

הרשאות

documentScan

זמינות

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

Document Scan API

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

סוגים

CancelScanResponse

‫Chrome מגרסה 125 ואילך

מאפיינים

  • משימה

    מחרוזת

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

  • תוצאה

    OperationResult

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

CloseScannerResponse

‫Chrome מגרסה 125 ואילך

מאפיינים

  • תוצאה

    OperationResult

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

  • scannerHandle

    מחרוזת

    אותו מזהה סורק שהועבר אל closeScanner.

Configurability

‫Chrome מגרסה 125 ואילך

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

טיפוסים בני מנייה (enum)

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

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

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

ConnectionType

‫Chrome מגרסה 125 ואילך

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

טיפוסים בני מנייה (enum)

"UNSPECIFIED"

"USB"

"NETWORK"

ConstraintType

‫Chrome מגרסה 125 ואילך

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

טיפוסים בני מנייה (enum)

‫"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

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

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

  • מאובטח

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

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

GetOptionGroupsResponse

‫Chrome מגרסה 125 ואילך

מאפיינים

  • קבוצות

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

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

  • תוצאה

    OperationResult

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

  • scannerHandle

    מחרוזת

    אותו מזהה סורק שהועבר אל getOptionGroups.

GetScannerListResponse

‫Chrome מגרסה 125 ואילך

מאפיינים

  • תוצאה

    OperationResult

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

  • סורקים

    ScannerInfo[]

    רשימה (אולי ריקה) של סורקים שתואמים ל-DeviceFilter שצוין.

OpenScannerResponse

‫Chrome מגרסה 125 ואילך

מאפיינים

  • אפשרויות

    object optional

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

  • תוצאה

    OperationResult

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

  • scannerHandle

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

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

  • scannerId

    מחרוזת

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

OperationResult

‫Chrome מגרסה 125 ואילך

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

טיפוסים בני מנייה (enum)

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

"SUCCESS"
הפעולה הצליחה.

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

‫"CANCELLED"
הפעולה בוטלה.

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

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

‫"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

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

  • ערך

    string | number | boolean | number[] optional

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

OptionType

‫Chrome מגרסה 125 ואילך

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

טיפוסים בני מנייה (enum)

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

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

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

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

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

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

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

OptionUnit

‫Chrome מגרסה 125 ואילך

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

טיפוסים בני מנייה (enum)

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

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

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

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

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

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

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

ReadScanDataResponse

‫Chrome מגרסה 125 ואילך

מאפיינים

  • נתונים

    ‫ArrayBuffer אופציונלי

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

  • estimatedCompletion

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

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

  • משימה

    מחרוזת

    מספק את נקודת האחיזה של המשימה שמועברת אל 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 אופציונלי

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

  • תיאור

    מחרוזת

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

  • isActive

    בוליאני

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

  • isAdvanced

    בוליאני

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

  • isAutoSettable

    בוליאני

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

  • isDetectable

    בוליאני

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

  • isEmulated

    בוליאני

    אם הערך הוא True, מנהל ההתקן של הסורק מדמה את התכונה.

  • שם

    מחרוזת

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

  • title

    מחרוזת

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

  • סוג

    OptionType

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

  • יחידה

    OptionUnit

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

  • ערך

    string | number | boolean | number[] optional

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

ScanOptions

מאפיינים

  • maxImages

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

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

  • mimeTypes

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

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

ScanResults

מאפיינים

  • dataUrls

    string[]‎

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

  • mimeType

    מחרוזת

    סוג ה-MIME של dataUrls.

SetOptionResult

‫Chrome מגרסה 125 ואילך

מאפיינים

  • שם

    מחרוזת

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

  • תוצאה

    OperationResult

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

SetOptionsResponse

‫Chrome מגרסה 125 ואילך

מאפיינים

  • אפשרויות

    object optional

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

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

  • תוצאות

    SetOptionResult[]

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

  • scannerHandle

    מחרוזת

    מספק את נקודת האחיזה של הסורק שהועברה אל setOptions().

StartScanOptions

‫Chrome מגרסה 125 ואילך

מאפיינים

  • פורמט

    מחרוזת

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

  • maxReadSize

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

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

StartScanResponse

‫Chrome מגרסה 125 ואילך

מאפיינים

  • משימה

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

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

  • תוצאה

    OperationResult

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

  • scannerHandle

    מחרוזת

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

Methods

cancelScan()

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

מבטלת סריקה שהתחילה ומחזירה Promise שמתקבל עם אובייקט CancelScanResponse. אם משתמשים בקריאה חוזרת (callback), האובייקט מועבר אליה במקום זאת.

פרמטרים

  • משימה

    מחרוזת

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

  • callback

    function optional

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

    (response: CancelScanResponse) => void

החזרות

  • ‫Promise<CancelScanResponse>

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

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

closeScanner()

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

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

פרמטרים

  • scannerHandle

    מחרוזת

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

  • callback

    function optional

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

    (response: CloseScannerResponse) => void

החזרות

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

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

getOptionGroups()

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

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

פרמטרים

החזרות

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

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

getScannerList()

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

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

פרמטרים

החזרות

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

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

openScanner()

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

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

פרמטרים

  • scannerId

    מחרוזת

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

  • callback

    function optional

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

    (response: OpenScannerResponse) => void

החזרות

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

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

readScanData()

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

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

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

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

פרמטרים

החזרות

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

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

scan()

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

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

פרמטרים

  • אפשרויות

    ScanOptions

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

  • callback

    function optional

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

    (result: ScanResults) => void

החזרות

  • Promise<ScanResults>

    ‫Chrome מגרסה 96 ואילך

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

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

setOptions()

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

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

פרמטרים

  • scannerHandle

    מחרוזת

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

  • אפשרויות

    OptionSetting[]

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

  • callback

    function optional

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

    (response: SetOptionsResponse) => void

החזרות

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

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

startScan()

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

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

פרמטרים

  • scannerHandle

    מחרוזת

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

  • אפשרויות

    StartScanOptions

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

  • callback

    function optional

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

    (response: StartScanResponse) => void

החזרות

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

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).