chrome.documentScan

חשוב: ה-API הזה פועל רק ב-ChromeOS.

תיאור

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

הרשאות

documentScan

זמינות

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

Document Scan API

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

הערה: ה-API הזה תלוי בתכונות של מערכת ההפעלה, שייתכן שלא יהיו זמינות, בהתאם למערכת ההפעלה הבסיסית. נכון לעכשיו, ידוע שרק ChromeOS למכשירים מסוימים עם חיבור USB פועלים בצורה תקינה.

סוגים

CancelScanResponse

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

תכונות

• משימה

  string

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

• תוצאה אחת

  OperationResult

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

CloseScannerResponse

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

תכונות

• תוצאה אחת

  OperationResult

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

• scannerHandle

  string

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

Configurability

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

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

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

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

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

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

ConnectionType

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

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

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

"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

  string

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

GetScannerListResponse

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

תכונות

• תוצאה אחת

  OperationResult

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

• סורקים

  ScannerInfo[]

  רשימה של סורקים אפשריים שתואמים ל-DeviceFilter שצוינה.

OpenScannerResponse

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

תכונות

• אפשרויות

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

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

• תוצאה אחת

  OperationResult

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

• scannerHandle

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

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

• scannerId

  string

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

OperationResult

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

טיפוסים בני מנייה (enum) שמציין את התוצאה של כל פעולה.

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

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

'הצלחה'
הפעולה הצליחה.

"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[] optional

• מקסימלי

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

• דקה

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

• כמות

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

• סוג

  ConstraintType

OptionGroup

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

תכונות

• חברים

  מחרוזת[]

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

• title

  string

  מספקת כותרת להדפסה, לדוגמה "אפשרויות גיאומטריות".

OptionSetting

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

תכונות

• name

  string

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

• סוג

  OptionType

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

• value

  string|number|boolean|number[] optional

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

OptionType

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

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

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

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

"BOOL"
הנכס value יהיה אחד מהערכים truefalse.

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

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

"STRING"
רצף של בייטים כלשהם מלבד NUL ('\0'). הנכס value יהיה DOMString.

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

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

OptionUnit

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

מציין את סוג הנתונים עבור ScannerOption.unit.

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

"UNITLless"
הערך הוא מספר ללא יחידה. לדוגמה, הוא יכול להיות ערך סף.

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

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

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

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

"PERCENT"
הערך הוא אחוז, לדוגמה: בהירות.

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

ReadScanDataResponse

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

תכונות

• נתונים

  ArrayBuffer אופציונלי

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

• estimatedCompletion

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

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

• משימה

  string

  מזהה המשימה שהועברה אל readScanData().

• תוצאה אחת

  OperationResult

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

ScannerInfo

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

תכונות

• connectionType

  ConnectionType

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

• deviceUuid

  string

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

• imageFormats

  מחרוזת[]

  מערך של סוגי MIME שניתן לבקש עבור סריקות שהוחזרו.

• יצרן

  string

  יצרן הסורק.

• model

  string

  דגם הסורק, אם הוא זמין, או תיאור גנרי.

• name

  string

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

• protocolType

  string

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

• scannerId

  string

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

• מאובטח

  boolean

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

ScannerOption

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

תכונות

• יכולת הגדרה

  הגדרת תצורה

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

• מגבלה

  OptionConstraint אופציונלי

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

• תיאור

  string

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

• isActive

  boolean

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

• isAdvanced

  boolean

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

• isAutoSettable

  boolean

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

• isDetectable

  boolean

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

• isEmulated

  boolean

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

• name

  string

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

• title

  string

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

• סוג

  OptionType

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

• יחידה

  OptionUnit

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

• value

  string|number|boolean|number[] optional

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

ScanOptions

תכונות

• maxImages

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

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

• mimeTypes

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

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

ScanResults

תכונות

• dataUrls

  מחרוזת[]

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

• mimeType

  string

  סוג MIME של dataUrls.

SetOptionResult

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

תכונות

• name

  string

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

• תוצאה אחת

  OperationResult

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

SetOptionsResponse

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

תכונות

• אפשרויות

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

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

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

• תוצאות

  SetOptionResult[]

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

• scannerHandle

  string

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

StartScanOptions

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

תכונות

• פורמט

  string

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

• maxReadSize

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

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

StartScanResponse

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

תכונות

• משימה

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

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

• תוצאה אחת

  OperationResult

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

• scannerHandle

  string

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

שיטות

cancelScan()

Promise Chrome 125 ואילך

chrome.documentScan.cancelScan(
  job: string,
  callback?: function,
)

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

פרמטרים

• משימה

  string

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

• קריאה חוזרת (callback)

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

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

  (response: CancelScanResponse)=>void

  • תשובה

    CancelScanResponse

החזרות

• Promise<CancelScanResponse>

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

closeScanner()

Promise Chrome 125 ואילך

chrome.documentScan.closeScanner(
  scannerHandle: string,
  callback?: function,
)

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

פרמטרים

• scannerHandle

  string

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

• קריאה חוזרת (callback)

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

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

  (response: CloseScannerResponse)=>void

  • תשובה

    CloseScannerResponse

החזרות

• Promise<CloseScannerResponse>

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

getOptionGroups()

Promise Chrome 125 ואילך

chrome.documentScan.getOptionGroups(
  scannerHandle: string,
  callback?: function,
)

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

פרמטרים

• scannerHandle

  string

  נקודת האחיזה של סורק פתוח שהוחזר משיחה אל openScanner.

• קריאה חוזרת (callback)

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

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

  (response: GetOptionGroupsResponse)=>void

  • תשובה

    GetOptionGroupsResponse

החזרות

• Promise<GetOptionGroupsResponse>

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

getScannerList()

Promise Chrome 125 ואילך

chrome.documentScan.getScannerList(
  filter: DeviceFilter,
  callback?: function,
)

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

פרמטרים

• סינון

  DeviceFilter

  DeviceFilter שמציין את סוגי הסורקים שיש להחזיר.

• קריאה חוזרת (callback)

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

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

  (response: GetScannerListResponse)=>void

  • תשובה

    GetScannerListResponse

החזרות

• Promise<GetScannerListResponse>

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

openScanner()

Promise Chrome 125 ואילך

chrome.documentScan.openScanner(
  scannerId: string,
  callback?: function,
)

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

פרמטרים

• scannerId

  string

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

• קריאה חוזרת (callback)

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

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

  (response: OpenScannerResponse)=>void

  • תשובה

    OpenScannerResponse

החזרות

• Promise<OpenScannerResponse>

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

readScanData()

Promise Chrome 125 ואילך

chrome.documentScan.readScanData(
  job: string,
  callback?: function,
)

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

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

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

פרמטרים

• משימה

  string

  ידית העבודה הפעילה הוחזרה בעבר מ-startScan.

• קריאה חוזרת (callback)

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

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

  (response: ReadScanDataResponse)=>void

  • תשובה

    ReadScanDataResponse

החזרות

• Promise<ReadScanDataResponse>

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

scan()

הבטחה

chrome.documentScan.scan(
  options: ScanOptions,
  callback?: function,
)

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

פרמטרים

• אפשרויות

  ScanOptions

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

• קריאה חוזרת (callback)

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

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

  (result: ScanResults)=>void

  • תוצאה אחת

    ScanResults

החזרות

• Promise<ScanResults>

  Chrome 96 ומעלה

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

setOptions()

Promise Chrome 125 ואילך

chrome.documentScan.setOptions(
  scannerHandle: string,
  options: OptionSetting[],
  callback?: function,
)

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

פרמטרים

• scannerHandle

  string

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

• אפשרויות

  OptionSetting[]

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

• קריאה חוזרת (callback)

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

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

  (response: SetOptionsResponse)=>void

  • תשובה

    SetOptionsResponse

החזרות

• Promise<SetOptionsResponse>

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

startScan()

Promise Chrome 125 ואילך

chrome.documentScan.startScan(
  scannerHandle: string,
  options: StartScanOptions,
  callback?: function,
)

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

פרמטרים

• scannerHandle

  string

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

• אפשרויות

  StartScanOptions

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

• קריאה חוזרת (callback)

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

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

  (response: StartScanResponse)=>void

  • תשובה

    StartScanResponse

החזרות

• Promise<StartScanResponse>

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).