chrome.documentScan

refresh date: 2026-09-25 robots: noindex

شرح

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

اجازه‌ها

documentScan

دردسترس بودن

Chrome نسخه ۴۴ و بالاتر فقط ChromeOS

Document Scan API

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

انواع

CancelScanResponse

Chrome نسخه ۱۲۵ و بالاتر

مشخصات

  • شغل

    رشته

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

  • نتیجه

    OperationResult

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

CloseScannerResponse

Chrome نسخه ۱۲۵ و بالاتر

مشخصات

  • نتیجه

    OperationResult

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

  • scannerHandle

    رشته

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

Configurability

Chrome نسخه ۱۲۵ و بالاتر

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

شمارشی

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

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

«HARDWARE_CONFIGURABLE»
این گزینه را کاربر می‌تواند با تغییر وضعیت یا فشار دادن دکمه‌ای در اسکنر تنظیم کند.

ConnectionType

Chrome نسخه ۱۲۵ و بالاتر

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

شمارشی

"UNSPECIFIED"

"USB"

«NETWORK»

ConstraintType

Chrome نسخه ۱۲۵ و بالاتر

نوع داده محدودیت که با 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 نسخه ۱۲۵ و بالاتر

مشخصات

  • محلی

    بولی اختیاری

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

  • ایمن کردن

    بولی اختیاری

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

GetOptionGroupsResponse

Chrome نسخه ۱۲۵ و بالاتر

مشخصات

  • گروه‌ها

    OptionGroup[] اختیاری

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

  • نتیجه

    OperationResult

    نتیجه دریافت گروه‌های گزینه. اگر مقدار این SUCCESS باشد، خصوصیت groups درج خواهد شد.

  • scannerHandle

    رشته

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

GetScannerListResponse

Chrome نسخه ۱۲۵ و بالاتر

مشخصات

  • نتیجه

    OperationResult

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

  • اسکنرها

    ScannerInfo[]

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

OpenScannerResponse

Chrome نسخه ۱۲۵ و بالاتر

مشخصات

  • گزینه‌ها

    شیء اختیاری

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

  • نتیجه

    OperationResult

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

  • scannerHandle

    رشته اختیاری

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

  • scannerId

    رشته

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

OperationResult

Chrome نسخه ۱۲۵ و بالاتر

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

شمارشی

«نامشخص»
خطای نامشخص یا عمومی رخ داده است.

«SUCCESS»
عملیات با موفقیت انجام شد.

«پشتیبانی‌نشده»
این عملیات پشتیبانی نمی‌شود.

«لغوشده»
عملیات لغو شد.

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

«نامعتبر»
داده یا متغیر مستقل ارسال‌شده به روش معتبر نیست.

«WRONG_TYPE»
مقدار ارائه‌شده نوع داده اشتباهی برای گزینه اصلی است.

«EOF»
داده دیگری دردسترس نیست.

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

«ADF_EMPTY»
تغذیه سند خالی است.

"COVER_OPEN"
درب اسکنر تخت باز است.

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

«ACCESS_DENIED»
دستگاه به اصالت‌سنجی نیاز دارد.

«NO_MEMORY»
حافظه کافی در Chromebook برای تکمیل عملیات دردسترس نیست.

«غیرقابل‌دسترس»
دستگاه قابل‌دسترس نیست.

«ناموجود»
اتصال دستگاه قطع است.

«INTERNAL_ERROR»
خطایی در جایی غیراز برنامه فراخواننده روی داده است.

OptionConstraint

Chrome نسخه ۱۲۵ و بالاتر

مشخصات

  • فهرست

    string[] | number[] اختیاری

  • حداکثر

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

  • دقیقه

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

  • quant

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

OptionGroup

Chrome نسخه ۱۲۵ و بالاتر

مشخصات

  • اعضاء

    string[]

    آرایه‌ای از نام‌های گزینه‌ها به ترتیبی که راننده ارائه کرده است.

  • عنوان

    رشته

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

OptionSetting

Chrome نسخه ۱۲۵ و بالاتر

مشخصات

  • نام

    رشته

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

  • نوع

    OptionType

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

  • مقدار

    رشته | عدد | بولی | عدد[] اختیاری

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

OptionType

Chrome نسخه ۱۲۵ و بالاتر

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

شمارشی

«UNKNOWN»
نوع داده گزینه ناشناخته است. خصوصیت value لغو تنظیم خواهد شد.

«BOOL»
ویژگی value یکی از truefalse خواهد بود.

«INT»
عدد صحیح ۳۲ بیتی علامت‌دار. ویژگی value بسته به اینکه گزینه بیش‌از یک مقدار داشته باشد یا نه، long یا []long خواهد بود.

«ثابت»
یک عدد اعشاری با دقت مضاعف در محدوده ۳۲۷۶۸- تا ۳۲۷۶۷٫۹۹۹۹ با وضوح ۱/۶۵۵۳۵. ویژگی value بسته به اینکه گزینه بیش‌از یک مقدار داشته باشد، double یا double[] خواهد بود. مقادیر دوبرابری که نمی‌توانند دقیقاً نشان داده شوند، به محدوده و دقت دردسترس گرد خواهند شد.

«رشته»
دنباله‌ای از هر بایت به‌جز NUL ('\0'). خصوصیت value یک DOMString خواهد بود.

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

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

OptionUnit

Chrome نسخه ۱۲۵ و بالاتر

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

شمارشی

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

«PIXEL»
مقدار تعداد پیکسل‌ها است، برای مثال، ابعاد اسکن.

«BIT»
مقدار تعداد بیت‌ها است، برای مثال، عمق رنگ.

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

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

«PERCENT»
مقدار به‌صورت درصد است، مثلاً روشنایی.

«میکروثانیه»
مقدار برحسب میکروثانیه اندازه‌گیری می‌شود، برای مثال، زمان نوردهی.

ReadScanDataResponse

Chrome نسخه ۱۲۵ و بالاتر

مشخصات

  • داده

    ArrayBuffer اختیاری

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

  • estimatedCompletion

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

    اگر result برابر با SUCCESS باشد، تخمینی از مقدار کل داده‌های اسکن که تاکنون تحویل داده شده است، در محدوده ۰ تا ۱۰۰.

  • شغل

    رشته

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

  • نتیجه

    OperationResult

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

ScannerInfo

Chrome نسخه ۱۲۵ و بالاتر

مشخصات

  • connectionType

    ConnectionType

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

  • deviceUuid

    رشته

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

  • imageFormats

    string[]

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

  • سازنده

    رشته

    سازنده اسکنر.

  • مدل

    رشته

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

  • نام

    رشته

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

  • protocolType

    رشته

    شرحی قابل‌خواندن برای انسان از پروتکل یا درایور مورداستفاده برای دسترسی به اسکنر، مانند Mopria،‏ WSD، یا epsonds. این ویژگی عمدتاً برای این مفید است که اگر دستگاهی از چند پروتکل پشتیبانی می‌کند، کاربر بتواند بین پروتکل‌ها انتخاب کند.

  • scannerId

    رشته

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

  • ایمن کردن

    بولی

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

ScannerOption

Chrome نسخه ۱۲۵ و بالاتر

مشخصات

  • پیکربندی‌پذیری

    پیکربندی‌پذیری

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

  • محدودیت

    OptionConstraint اختیاری

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

  • description

    رشته

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

  • isActive

    بولی

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

  • isAdvanced

    بولی

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

  • isAutoSettable

    بولی

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

  • isDetectable

    بولی

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

  • isEmulated

    بولی

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

  • نام

    رشته

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

  • عنوان

    رشته

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

  • نوع

    OptionType

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

  • واحد

    OptionUnit

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

  • مقدار

    رشته | عدد | بولی | عدد[] اختیاری

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

ScanOptions

مشخصات

  • maxImages

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

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

  • mimeTypes

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

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

ScanResults

مشخصات

  • dataUrls

    string[]

    آرایه‌ای از نشانی‌های وب تصویر داده در فرمی که می‌تواند به‌عنوان مقدار «src» به برچسب تصویر ارسال شود.

  • mimeType

    رشته

    نوع MIME dataUrls.

SetOptionResult

Chrome نسخه ۱۲۵ و بالاتر

مشخصات

  • نام

    رشته

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

  • نتیجه

    OperationResult

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

SetOptionsResponse

Chrome نسخه ۱۲۵ و بالاتر

مشخصات

  • گزینه‌ها

    شیء اختیاری

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

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

  • نتایج

    SetOptionResult[]

    آرایه‌ای از نتایج، هرکدام برای هر OptionSetting ارسال‌شده.

  • scannerHandle

    رشته

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

StartScanOptions

Chrome نسخه ۱۲۵ و بالاتر

مشخصات

  • قالب

    رشته

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

  • maxReadSize

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

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

StartScanResponse

Chrome نسخه ۱۲۵ و بالاتر

مشخصات

  • شغل

    رشته اختیاری

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

  • نتیجه

    OperationResult

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

  • scannerHandle

    رشته

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

روش‌ها

cancelScan()

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

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

پارامترها

  • شغل

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (response: CancelScanResponse) => void

بازگشتی‌ها

  • یک Promise برمی‌گرداند که با نتیجه حل می‌شود.

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

closeScanner()

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

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

پارامترها

  • scannerHandle

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (response: CloseScannerResponse) => void

بازگشتی‌ها

  • یک Promise برمی‌گرداند که با نتیجه حل می‌شود.

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getOptionGroups()

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

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

پارامترها

  • scannerHandle

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (response: GetOptionGroupsResponse) => void

بازگشتی‌ها

  • یک Promise برمی‌گرداند که با نتیجه حل می‌شود.

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getScannerList()

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

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

پارامترها

بازگشتی‌ها

  • یک Promise برمی‌گرداند که با نتیجه و فهرست اسکنرها حل می‌شود.

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

openScanner()

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

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

پارامترها

  • scannerId

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (response: OpenScannerResponse) => void

بازگشتی‌ها

  • یک Promise برمی‌گرداند که با نتیجه حل می‌شود.

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

readScanData()

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

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

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

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

پارامترها

  • شغل

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (response: ReadScanDataResponse) => void

بازگشتی‌ها

  • یک Promise برمی‌گرداند که با نتیجه حل می‌شود.

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

scan()

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

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

پارامترها

  • گزینه‌ها

    ScanOptions

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (result: ScanResults) => void

بازگشتی‌ها

  • Promise<ScanResults>

    Chrome نسخه ۹۶ به بالا

    یک Promise برمی‌گرداند که با نتایج اسکن حل می‌شود.

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

setOptions()

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

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

پارامترها

  • scannerHandle

    رشته

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

  • گزینه‌ها

    OptionSetting[]

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (response: SetOptionsResponse) => void

بازگشتی‌ها

  • یک Promise برمی‌گرداند که با نتیجه حل می‌شود.

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

startScan()

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

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

پارامترها

  • scannerHandle

    رشته

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

  • گزینه‌ها

    StartScanOptions

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (response: StartScanResponse) => void

بازگشتی‌ها

  • یک Promise برمی‌گرداند که با نتیجه حل می‌شود.

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.