chrome.documentScan

شرح

از chrome.documentScan API برای کشف و بازیابی تصاویر از اسکنرهای اسناد پیوست شده استفاده کنید.

مجوزها

documentScan

دسترسی

فقط Chrome 44+ ChromeOS

Document Scan API

Document Scan API طوری طراحی شده است که به برنامه‌ها و برنامه‌های افزودنی اجازه می‌دهد محتوای اسناد کاغذی را روی یک اسکنر اسناد پیوست شده مشاهده کنند.

انواع

CancelScanResponse

Chrome 125+

خواص

  • کار

    رشته

    همان دسته کار را ارائه می کند که به cancelScan() منتقل شد.

  • نتیجه اسکن لغو باطن. اگر نتیجه OperationResult.SUCCESS یا OperationResult.CANCELLED باشد، اسکن لغو شده است و اسکنر آماده شروع یک اسکن جدید است. اگر نتیجه OperationResult.DEVICE_BUSY باشد، اسکنر همچنان در حال پردازش لغو درخواستی است. تماس گیرنده باید مدت کوتاهی صبر کند و دوباره درخواست را امتحان کند. سایر مقادیر نتیجه نشان دهنده یک خطای دائمی است که نباید دوباره امتحان شود.

CloseScannerResponse

Chrome 125+

خواص

  • نتیجه بسته شدن اسکنر. حتی اگر این مقدار SUCCESS نباشد، دسته نامعتبر خواهد بود و نباید برای عملیات بعدی استفاده شود.

  • دسته اسکنر

    رشته

    همان دسته اسکنر که به closeScanner منتقل شد.

Configurability

Chrome 125+

چگونه یک گزینه را می توان تغییر داد

Enum

"NOT_CONFIGURABLE"
گزینه فقط خواندنی است.

"SOFTWARE_CONFIGURABLE"
این گزینه را می توان در نرم افزار تنظیم کرد.

"HARDWARE_CONFIGURABLE"
این گزینه را می توان با تغییر دادن یا فشار دادن دکمه ای روی اسکنر توسط کاربر تنظیم کرد.

ConnectionType

Chrome 125+

نحوه اتصال اسکنر به رایانه را نشان می دهد.

Enum

"نامشخص"

"یو اس بی"

"شبکه"

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+

خواص

  • محلی

    بولی اختیاری

    فقط اسکنرهایی را برگردانید که مستقیماً به رایانه متصل هستند.

  • امن است

    بولی اختیاری

    فقط اسکنرهایی را برگردانید که از حمل و نقل ایمن مانند USB یا TLS استفاده می کنند.

GetOptionGroupsResponse

Chrome 125+

خواص

  • گروه ها

    OptionGroup [] اختیاری است

    اگر result SUCCESS باشد، فهرستی از گروه های گزینه را به ترتیب ارائه شده توسط درایور اسکنر ارائه می دهد.

  • نتیجه گرفتن گروه های گزینه. اگر مقدار این SUCCESS باشد، ویژگی groups پر می شود.

  • دسته اسکنر

    رشته

    همان دسته اسکنر که به getOptionGroups منتقل شد.

GetScannerListResponse

Chrome 125+

خواص

  • نتیجه شمارش توجه داشته باشید که نتایج جزئی ممکن است برگردانده شوند حتی اگر این نشان دهنده یک خطا باشد.

  • اسکنرها

    ScannerInfo []

    فهرستی احتمالاً خالی از اسکنرهایی که با DeviceFilter ارائه شده مطابقت دارند.

OpenScannerResponse

Chrome 125+

خواص

  • گزینه ها

    شی اختیاری

    اگر result SUCCESS باشد، یک نگاشت کلید-مقدار ارائه می دهد که در آن کلید یک گزینه خاص دستگاه است و مقدار نمونه ای از ScannerOption است.

  • نتیجه باز کردن اسکنر. اگر مقدار این SUCCESS باشد، ویژگی scannerHandle و options پر می شود.

  • دسته اسکنر

    رشته اختیاری

    اگر result SUCCESS باشد، دستگیره ای برای اسکنر است که می تواند برای عملیات بعدی استفاده شود.

  • شناسه اسکنر

    رشته

    شناسه اسکنر به openScanner() منتقل شد.

OperationResult

Chrome 125+

یک عدد که نتیجه هر عملیات را نشان می دهد.

Enum

"ناشناخته"
یک شکست ناشناخته یا عمومی رخ داد.

"موفقیت"
عملیات موفق شد.

"بدون حمایت"
عملیات پشتیبانی نمی شود.

"لغو شد"
عملیات لغو شد.

"DEVICE_BUSY"
دستگاه مشغول است.

"بی اعتبار"
داده یا آرگومان ارسال شده به متد معتبر نیست.

"WRONG_TYPE"
مقدار ارائه شده نوع داده اشتباهی برای گزینه زیربنایی است.

"EOF"
داده دیگری در دسترس نیست.

"ADF_JAMMED"
تغذیه کننده سند گیر کرده است.

"ADF_EMPTY"
تغذیه کننده سند خالی است.

"پوشش باز"
روکش تخت باز است.

"IO_ERROR"
هنگام برقراری ارتباط با دستگاه خطایی روی داد.

"ACCESS_DENIED"
دستگاه نیاز به احراز هویت دارد.

"NO_MEMORY"
حافظه کافی برای تکمیل عملیات در Chromebook موجود نیست.

"غیر قابل دسترسی"
دستگاه قابل دسترسی نیست.

"گمشده"
دستگاه قطع شده است.

"خطای داخلی"
در جایی غیر از برنامه فراخوانی خطایی رخ داده است.

OptionConstraint

Chrome 125+

خواص

  • فهرست

    رشته[]|شماره[] اختیاری است

  • حداکثر

    شماره اختیاری

  • دقیقه

    شماره اختیاری

  • مقدار

    شماره اختیاری

OptionGroup

Chrome 125+

خواص

  • اعضا

    رشته[]

    آرایه ای از نام گزینه ها به ترتیب ارائه شده توسط راننده.

  • عنوان

    رشته

    یک عنوان قابل چاپ ارائه می دهد، به عنوان مثال "گزینه های هندسه".

OptionSetting

Chrome 125+

خواص

  • نام

    رشته

    نام گزینه تنظیم را نشان می دهد.

  • نوع

    OptionType

    نوع داده گزینه را نشان می دهد. نوع داده درخواستی باید با نوع داده واقعی گزینه اصلی مطابقت داشته باشد.

  • ارزش

    رشته|شماره|بولی|شماره[] اختیاری است

    مقدار مورد نظر را نشان می دهد. برای درخواست تنظیمات خودکار برای گزینه‌هایی که autoSettable فعال کرده‌اند، تنظیم نشده را رها کنید. نوع داده ارائه شده برای value باید با type مطابقت داشته باشد.

OptionType

Chrome 125+

نوع داده یک گزینه

Enum

"ناشناخته"
نوع داده این گزینه ناشناخته است. ویژگی value تنظیم نخواهد شد.

"بول"
ویژگی value یکی از true false خواهد بود.

"INT"
یک عدد صحیح 32 بیتی امضا شده. بسته به اینکه این گزینه بیش از یک مقدار را بگیرد، ویژگی value طولانی یا طولانی خواهد بود.

"درست شد"
یک دوبل در محدوده -32768-32767.9999 با وضوح 1/65535. بسته به اینکه گزینه بیش از یک مقدار بگیرد، ویژگی value دو یا دو برابر خواهد بود. مقادیر دوگانه ای که نمی توانند دقیقاً نمایش داده شوند به محدوده و دقت موجود گرد می شوند.

"STRING"
دنباله ای از هر بایت به جز NUL ('\0'). ویژگی value یک DOMString خواهد بود.

"دکمه"
گزینه ای از این نوع ارزش ندارد. در عوض، تنظیم گزینه ای از این نوع باعث ایجاد یک اثر جانبی خاص در درایور اسکنر می شود. به عنوان مثال، یک گزینه با دکمه تایپ می تواند توسط یک درایور اسکنر استفاده شود تا وسیله ای برای انتخاب مقادیر پیش فرض فراهم کند یا به یک تغذیه کننده خودکار اسناد بگوید که به صفحه کاغذ بعدی پیش رود.

"گروه"
گزینه گروه بندی بدون ارزش این برای سازگاری گنجانده شده است، اما معمولاً در مقادیر ScannerOption بازگردانده نمی شود. از getOptionGroups() برای بازیابی لیست گروه ها با گزینه های عضوشان استفاده کنید.

OptionUnit

Chrome 125+

نوع داده ScannerOption.unit را نشان می دهد.

Enum

"بی واحد"
مقدار یک عدد بدون واحد است. به عنوان مثال، می تواند یک آستانه باشد.

"PIXEL"
مقدار تعدادی پیکسل است، به عنوان مثال، ابعاد اسکن.

"بیت"
مقدار تعداد بیت ها است، به عنوان مثال، عمق رنگ.

"MM"
مقدار در میلی متر اندازه گیری می شود، به عنوان مثال، ابعاد اسکن.

"DPI"
مقدار در نقطه در اینچ اندازه گیری می شود، به عنوان مثال، وضوح.

"PERCENT"
مقدار یک درصد است، به عنوان مثال، روشنایی.

"میکروس ثانیه"
مقدار در میکروثانیه اندازه گیری می شود، به عنوان مثال، زمان قرار گرفتن در معرض.

ReadScanDataResponse

Chrome 125+

خواص

  • داده ها

    ArrayBuffer اختیاری است

    اگر result SUCCESS باشد، حاوی تکه بعدی داده های تصویر اسکن شده است. اگر result EOF باشد، حاوی آخرین تکه داده تصویر اسکن شده است.

  • تکمیل برآورد شده

    شماره اختیاری

    اگر result SUCCESS باشد، تخمینی از میزان کل داده‌های اسکن تا کنون ارائه شده است، در محدوده 0 تا 100.

  • کار

    رشته

    دسته کار ارسال شده به readScanData() را ارائه می دهد.

  • نتیجه خواندن داده ها اگر مقدار آن SUCCESS باشد، data شامل قطعه بعدی (احتمالاً با طول صفر) از داده های تصویر است که برای خواندن آماده است. اگر مقدار آن EOF باشد، data حاوی آخرین تکه داده تصویر است.

ScannerInfo

Chrome 125+

خواص

  • نوع اتصال

    نوع اتصال

    نحوه اتصال اسکنر به رایانه را نشان می دهد.

  • deviceUuid

    رشته

    برای تطبیق با سایر ورودی‌های ScannerInfo که به یک دستگاه فیزیکی اشاره می‌کنند.

  • فرمت های تصویر

    رشته[]

    آرایه ای از انواع MIME که می توان برای اسکن های برگشتی درخواست کرد.

  • سازنده

    رشته

    سازنده اسکنر

  • مدل

    رشته

    مدل اسکنر در صورت موجود بودن، یا توضیحات عمومی.

  • نام

    رشته

    یک نام قابل خواندن برای اسکنر برای نمایش در رابط کاربری.

  • نوع پروتکل

    رشته

    شرح قابل خواندن توسط انسان از پروتکل یا درایور مورد استفاده برای دسترسی به اسکنر، مانند Mopria، WSD، یا epsonds. این در درجه اول برای اجازه دادن به کاربر برای انتخاب بین پروتکل ها مفید است اگر دستگاهی از چندین پروتکل پشتیبانی می کند.

  • شناسه اسکنر

    رشته

    شناسه یک اسکنر خاص

  • امن است

    بولی

    اگر درست باشد، انتقال اتصال اسکنر توسط یک شنونده غیرفعال مانند TLS یا USB قابل رهگیری نیست.

ScannerOption

Chrome 125+

خواص

  • قابلیت پیکربندی

    قابلیت پیکربندی

    نشان می دهد که آیا و چگونه می توان گزینه را تغییر داد.

  • محدودیت

    OptionConstraint اختیاری است

    OptionConstraint را روی گزینه اسکنر فعلی تعریف می کند.

  • شرح

    رشته

    توضیحات طولانی تر از گزینه

  • فعال است

    بولی

    نشان می دهد که گزینه فعال است و می توان آن را تنظیم یا بازیابی کرد. اگر false باشد، خاصیت value تنظیم نخواهد شد.

  • پیشرفته است

    بولی

    نشان می دهد که UI نباید این گزینه را به طور پیش فرض نمایش دهد.

  • isAutoSettable

    بولی

    می تواند به طور خودکار توسط درایور اسکنر تنظیم شود.

  • قابل تشخیص است

    بولی

    نشان می دهد که این گزینه از طریق نرم افزار قابل شناسایی است.

  • شبیه سازی شده است

    بولی

    اگر درست باشد توسط درایور اسکنر شبیه سازی شده است.

  • نام

    رشته

    نام گزینه با استفاده از حروف کوچک اسکی، اعداد و خط تیره. دیاکریتیک مجاز نیست.

  • عنوان

    رشته

    عنوان تک خطی قابل چاپ

  • نوع

    OptionType

    نوع داده موجود در ویژگی value که برای تنظیم این گزینه مورد نیاز است.

  • واحد

    Option Unit

    واحد اندازه گیری این گزینه

  • ارزش

    رشته|شماره|بولی|شماره[] اختیاری است

    مقدار فعلی گزینه، در صورت مرتبط بودن. توجه داشته باشید که نوع داده این ویژگی باید با نوع داده مشخص شده در type مطابقت داشته باشد.

ScanOptions

خواص

  • حداکثر تصاویر

    شماره اختیاری

    تعداد تصاویر اسکن شده مجاز پیش فرض 1 است.

  • mimeTypes

    رشته[] اختیاری است

    انواع MIME که توسط تماس گیرنده پذیرفته می شود.

ScanResults

خواص

  • dataUrls

    رشته[]

    آرایه ای از URL های تصویر داده به شکلی که می تواند به عنوان مقدار "src" به یک تگ تصویر ارسال شود.

  • mimeType

    رشته

    نوع MIME dataUrls .

SetOptionResult

Chrome 125+

خواص

  • نام

    رشته

    نام گزینه ای که تنظیم شده را نشان می دهد.

  • نتیجه تنظیم گزینه را نشان می دهد.

SetOptionsResponse

Chrome 125+

خواص

  • گزینه ها

    شی اختیاری

    یک نگاشت کلید-مقدار به روز شده از نام گزینه ها تا مقادیر ScannerOption حاوی پیکربندی جدید پس از تلاش برای تنظیم همه گزینه های ارائه شده. این ساختار مشابه ویژگی options در OpenScannerResponse است.

    حتی اگر برخی از گزینه‌ها با موفقیت تنظیم نشده باشند، این ویژگی تنظیم می‌شود، اما اگر بازیابی پیکربندی به‌روز نشد (به عنوان مثال، اگر اسکنر در وسط اسکن قطع شود) تنظیم نمی‌شود.

  • نتایج

    SetOption Result []

    آرایه ای از نتایج، هر کدام برای هر OptionSetting تصویب شده.

  • اسکنر هندل

    رشته

    دسته اسکنر را به setOptions() ارائه می دهد.

StartScanOptions

Chrome 125+

خواص

  • قالب

    رشته

    نوع MIME را برای برگرداندن داده های اسکن شده مشخص می کند.

  • maxReadSize

    شماره اختیاری

    اگر مقدار غیر صفر مشخص شده باشد، حداکثر بایت های اسکن شده بازگردانده شده در یک پاسخ readScanData را به آن مقدار محدود می کند. کوچکترین مقدار مجاز 32768 (32 کیلوبایت) است. اگر این ویژگی مشخص نشده باشد، اندازه یک تکه برگشتی ممکن است به بزرگی کل تصویر اسکن شده باشد.

StartScanResponse

Chrome 125+

خواص

  • کار

    رشته اختیاری

    اگر result SUCCESS باشد، دسته ای را ارائه می دهد که می تواند برای خواندن داده های اسکن یا لغو کار استفاده شود.

  • نتیجه شروع اسکن. اگر مقدار این SUCCESS باشد، ویژگی job پر می شود.

  • دسته اسکنر

    رشته

    همان دسته اسکنر را ارائه می دهد که به startScan() منتقل شد.

مواد و روش ها

cancelScan()

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

یک اسکن شروع شده را لغو می کند و یک Promise را برمی گرداند که با یک شی CancelScanResponse حل می شود. در صورت استفاده از callback، شی به جای آن به آن ارسال می شود.

مولفه های

  • کار

    رشته

    دسته یک کار اسکن فعال که قبلاً از تماس با startScan برگردانده شده است.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (response: CancelScanResponse)=>void

برمی گرداند

  • Promise< CancelScanResponse >

    Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

closeScanner()

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

اسکنر را با دسته عبور می‌بندد و یک Promise را برمی‌گرداند که با یک شی CloseScannerResponse حل می‌شود. در صورت استفاده از callback، شی به جای آن به آن ارسال می شود. حتی اگر پاسخ موفقیت آمیز نباشد، دسته ارائه شده نامعتبر می شود و نباید برای عملیات بعدی استفاده شود.

مولفه های

  • اسکنر هندل

    رشته

    دسته یک اسکنر باز را که قبلاً از یک تماس به openScanner برگردانده شده بود را مشخص می کند.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (response: CloseScannerResponse)=>void

برمی گرداند

  • Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

getOptionGroups()

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

نام گروه و گزینه های اعضا را از اسکنر که قبلاً توسط openScanner باز شده است دریافت می کند. این متد یک Promise برمی گرداند که با یک شی GetOptionGroupsResponse حل می شود. اگر یک تماس برگشتی به این تابع ارسال شود، داده های برگشتی به آن ارسال می شود.

مولفه های

  • اسکنر هندل

    رشته

    دسته یک اسکنر باز از یک تماس به openScanner بازگشت.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (response: GetOptionGroupsResponse)=>void

برمی گرداند

  • Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

getScannerList()

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

لیستی از اسکنرهای موجود را دریافت می کند و یک Promise برمی گرداند که با یک شی GetScannerListResponse حل می شود. اگر یک تماس برگشتی به این تابع ارسال شود، داده های برگشتی به آن ارسال می شود.

مولفه های

برمی گرداند

  • Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

openScanner()

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

یک اسکنر را برای دسترسی انحصاری باز می کند و یک Promise را برمی گرداند که با یک شی OpenScannerResponse حل می شود. اگر یک تماس برگشتی به این تابع ارسال شود، داده های برگشتی به آن ارسال می شود.

مولفه های

  • شناسه اسکنر

    رشته

    شناسه یک اسکنر که باید باز شود. این مقدار یک مقدار است که از تماس قبلی با getScannerList برگردانده شده است.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (response: OpenScannerResponse)=>void

برمی گرداند

  • Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

readScanData()

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

تکه بعدی داده های تصویر موجود را از یک دسته کار فعال می خواند و یک Promise برمی گرداند که با یک شی ReadScanDataResponse حل می شود. در صورت استفاده از callback، شی به جای آن به آن ارسال می شود.

**توجه:**برای نتیجه پاسخ SUCCESS با عضو data با طول صفر معتبر است. این بدان معنی است که اسکنر هنوز کار می کند اما هنوز داده های اضافی آماده نیست. تماس گیرنده باید مدت کوتاهی صبر کند و دوباره تلاش کند.

هنگامی که کار اسکن کامل شد، پاسخ مقدار نتیجه EOF را خواهد داشت. این پاسخ ممکن است حاوی یک عضو data نهایی غیر صفر باشد.

مولفه های

  • کار

    رشته

    دسته کار فعال که قبلاً از startScan برگردانده شده است.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (response: ReadScanDataResponse)=>void

برمی گرداند

  • Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

scan()

وعده
chrome.documentScan.scan(
  options: ScanOptions,
  callback?: function,
)

یک اسکن سند را انجام می دهد و یک Promise را برمی گرداند که با یک شی ScanResults حل می شود. اگر یک تماس برگشتی به این تابع ارسال شود، داده های برگشتی به آن ارسال می شود.

مولفه های

  • گزینه ها

    ScanOptions

    یک شی حاوی پارامترهای اسکن.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (result: ScanResults)=>void

برمی گرداند

  • Chrome 96+

    Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

setOptions()

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

گزینه‌ها را روی اسکنر مشخص شده تنظیم می‌کند و یک Promise برمی‌گرداند که با یک شی SetOptionsResponse حل می‌شود که حاوی نتیجه تلاش برای تنظیم هر مقدار به ترتیب شی OptionSetting . در صورت استفاده از callback، شی به جای آن به آن ارسال می شود.

مولفه های

  • اسکنر هندل

    رشته

    دسته اسکنر برای تنظیم گزینه ها. این باید مقداری باشد که قبلاً از تماس با openScanner بازگردانده شده است.

  • گزینه ها

    تنظیمات گزینه []

    فهرستی از اشیاء OptionSetting که باید روی اسکنر اعمال شوند.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (response: SetOptionsResponse)=>void

برمی گرداند

  • Promise< SetOptionsResponse >

    Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

startScan()

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

اسکن را روی اسکنر مشخص شده شروع می کند و یک Promise را برمی گرداند که با StartScanResponse حل می شود. در صورت استفاده از callback، شی به جای آن به آن ارسال می شود. اگر تماس موفقیت آمیز بود، پاسخ شامل یک دسته کار است که می تواند در تماس های بعدی برای خواندن داده های اسکن یا لغو اسکن استفاده شود.

مولفه های

  • دسته اسکنر

    رشته

    دسته یک اسکنر باز. این باید مقداری باشد که قبلاً از تماس با openScanner بازگردانده شده است.

  • گزینه ها

    StartScanOptions

    یک شی StartScanOptions که گزینه های مورد استفاده برای اسکن را نشان می دهد. ویژگی StartScanOptions.format باید با یکی از ورودی های بازگردانده شده در ScannerInfo اسکنر مطابقت داشته باشد.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (response: StartScanResponse)=>void

برمی گرداند

  • Promise< StartScanResponse >

    Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.