chrome.documentScan

توضیحات

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

مجوزها

documentScan

در دسترس بودن

فقط کروم او اس ۴۴+

API اسکن اسناد

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

انواع

CancelScanResponse

کروم ۱۲۵+

خواص

  • شغل

    رشته

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

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

CloseScannerResponse

کروم ۱۲۵+

خواص

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

  • دسته اسکنر

    رشته

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

Configurability

کروم ۱۲۵+

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

شمارشی

"غیرقابل_تنظیم"
گزینه فقط خواندنی است.

«قابل پیکربندی نرم‌افزار»
این گزینه را می‌توان به صورت نرم‌افزاری تنظیم کرد.

"سخت‌افزار_قابل_پیکربندی"
این گزینه را می‌توان با تغییر وضعیت یا فشار دادن دکمه‌ای روی اسکنر توسط کاربر تنظیم کرد.

ConnectionType

کروم ۱۲۵+

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

شمارشی

«نامشخص»

"یو اس بی"

«شبکه»

ConstraintType

کروم ۱۲۵+

نوع داده‌ی محدودیتی که توسط OptionConstraint نمایش داده می‌شود.

شمارشی

"دامنه_عددی"
محدودیت روی طیفی از مقادیر OptionType.INT . ویژگی‌های min ، max و quant از OptionConstraint long خواهند بود و ویژگی list آن تنظیم نشده است.

"محدوده ثابت"
محدودیت روی طیفی از مقادیر OptionType.FIXED . ویژگی‌های min ، max و quant از OptionConstraint برابر double خواهد بود و ویژگی list آن تنظیم نشده است.

"لیست_INT"
محدودیت روی یک لیست خاص از مقادیر OptionType.INT . ویژگی OptionConstraint.list شامل مقادیر long خواهد بود و سایر ویژگی‌ها تنظیم نشده‌اند.

"لیست_ثابت"
محدودیت روی یک لیست خاص از مقادیر OptionType.FIXED . ویژگی OptionConstraint.list شامل مقادیر double خواهد بود و سایر ویژگی‌ها تنظیم نشده‌اند.

"لیست_رشته‌ای"
محدودیت روی یک لیست خاص از مقادیر OptionType.STRING . ویژگی OptionConstraint.list شامل مقادیر DOMString خواهد بود و سایر ویژگی‌ها تنظیم نشده‌اند.

DeviceFilter

کروم ۱۲۵+

خواص

  • محلی

    بولی اختیاری

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

  • امن

    بولی اختیاری

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

GetOptionGroupsResponse

کروم ۱۲۵+

خواص

  • گروه‌ها

    گروه گزینه [] اختیاری

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

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

  • دسته اسکنر

    رشته

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

GetScannerListResponse

کروم ۱۲۵+

خواص

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

  • اسکنرها

    اطلاعات اسکنر []

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

OpenScannerResponse

کروم ۱۲۵+

خواص

  • گزینه‌ها

    شیء اختیاری

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

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

  • دسته اسکنر

    رشته اختیاری

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

  • اسکنر آی دی

    رشته

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

OperationResult

کروم ۱۲۵+

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

شمارشی

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

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

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

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

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

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

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

"ای او اف"
داده بیشتری در دسترس نیست.

"ADF_متوقف شد"
تغذیه کننده سند گیر کرده است.

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

«پوشش_باز»
پوشش تخت باز است.

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

«دسترسی_ممنوع»
دستگاه نیاز به احراز هویت دارد.

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

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

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

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

OptionConstraint

کروم ۱۲۵+

خواص

  • فهرست

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

  • حداکثر

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

  • دقیقه

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

  • کمیت

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

OptionGroup

کروم ۱۲۵+

خواص

  • اعضا

    رشته[]

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

  • عنوان

    رشته

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

OptionSetting

کروم ۱۲۵+

خواص

  • نام

    رشته

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

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

  • ارزش

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

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

OptionType

کروم ۱۲۵+

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

شمارشی

«ناشناس»
نوع داده‌ی این گزینه ناشناخته است. ویژگی value غیرفعال خواهد شد.

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

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

«ثابت»
یک عدد دو رقمی در محدوده ‎-32768-32767.9999‎ با وضوح ‎1/65535‎. ویژگی value ‎double‎ یا ‎double[]‎ خواهد بود، بسته به اینکه آیا گزینه بیش از یک مقدار می‌گیرد یا خیر. مقادیر دو رقمی که نمی‌توانند دقیقاً نمایش داده شوند، به محدوده و دقت موجود گرد می‌شوند.

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

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

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

OptionUnit

کروم ۱۲۵+

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

شمارشی

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

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

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

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

"دی پی آی"
مقدار آن بر حسب نقطه در هر اینچ اندازه‌گیری می‌شود، برای مثال، وضوح تصویر.

«درصد»
مقدار آن درصد است، مثلاً روشنایی.

"میکرو ثانیه"
مقدار در میکروثانیه اندازه‌گیری می‌شود، برای مثال، زمان نوردهی.

ReadScanDataResponse

کروم ۱۲۵+

خواص

  • داده‌ها

    ArrayBuffer اختیاری

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

  • تکمیل تخمینی

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

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

  • شغل

    رشته

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

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

ScannerInfo

کروم ۱۲۵+

خواص

  • نوع اتصال

    نوع اتصال

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

  • یوآی‌دی دستگاه

    رشته

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

  • قالب‌های تصویر

    رشته[]

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

  • تولیدکننده

    رشته

    شرکت سازنده اسکنر

  • مدل

    رشته

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

  • نام

    رشته

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

  • پروتکلنوع

    رشته

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

  • اسکنر آی دی

    رشته

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

  • امن

    بولی

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

ScannerOption

کروم ۱۲۵+

خواص

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

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

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

  • محدودیت

    محدودیت گزینه اختیاری

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

  • توضیحات

    رشته

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

  • فعال است

    بولی

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

  • پیشرفته

    بولی

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

  • قابل تنظیم خودکار

    بولی

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

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

    بولی

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

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

    بولی

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

  • نام

    رشته

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

  • عنوان

    رشته

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

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

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

  • ارزش

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

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

ScanOptions

خواص

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

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

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

  • انواع mime

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

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

ScanResults

خواص

  • آدرس‌های داده

    رشته[]

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

  • نوع مایم

    رشته

    نوع MIME مربوط به dataUrls .

SetOptionResult

کروم ۱۲۵+

خواص

  • نام

    رشته

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

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

SetOptionsResponse

کروم ۱۲۵+

خواص

  • گزینه‌ها

    شیء اختیاری

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

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

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

  • دسته اسکنر

    رشته

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

StartScanOptions

کروم ۱۲۵+

خواص

  • قالب

    رشته

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

  • حداکثر اندازه خواندن

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

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

StartScanResponse

کروم ۱۲۵+

خواص

  • شغل

    رشته اختیاری

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

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

  • دسته اسکنر

    رشته

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

روش‌ها

cancelScan()

قول کروم ۱۲۵+
chrome.documentScan.cancelScan(
  job: string,
  callback?: function,
): Promise<CancelScanResponse>

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

پارامترها

  • شغل

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (response: CancelScanResponse) => void

بازگشت‌ها

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

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

closeScanner()

قول کروم ۱۲۵+
chrome.documentScan.closeScanner(
  scannerHandle: string,
  callback?: function,
): Promise<CloseScannerResponse>

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

پارامترها

  • دسته اسکنر

    رشته

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

  • تماس برگشتی

    function optional

    پارامتر callback به شکل زیر است: 

    (response: CloseScannerResponse) => void

بازگشت‌ها

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

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

getOptionGroups()

قول کروم ۱۲۵+
chrome.documentScan.getOptionGroups(
  scannerHandle: string,
  callback?: function,
): Promise<GetOptionGroupsResponse>

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

پارامترها

  • دسته اسکنر

    رشته

    شناسه‌ی یک اسکنر باز از فراخوانی تابع openScanner برگشت داده شده است.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (response: GetOptionGroupsResponse) => void

بازگشت‌ها

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

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

getScannerList()

قول کروم ۱۲۵+
chrome.documentScan.getScannerList(
  filter: DeviceFilter,
  callback?: function,
): Promise<GetScannerListResponse>

Gets the list of available scanners and returns a Promise that resolves with a GetScannerListResponse object. If a callback is passed to this function, returned data is passed to it instead.

پارامترها

بازگشت‌ها

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

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

openScanner()

قول کروم ۱۲۵+
chrome.documentScan.openScanner(
  scannerId: string,
  callback?: function,
): Promise<OpenScannerResponse>

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

پارامترها

  • اسکنر آی دی

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (response: OpenScannerResponse) => void

بازگشت‌ها

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

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

readScanData()

قول کروم ۱۲۵+
chrome.documentScan.readScanData(
  job: string,
  callback?: function,
): Promise<ReadScanDataResponse>

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

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

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

پارامترها

بازگشت‌ها

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

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

scan()

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

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

پارامترها

بازگشت‌ها

  • کروم ۹۶+

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

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

setOptions()

قول کروم ۱۲۵+
chrome.documentScan.setOptions(
  scannerHandle: string,
  options: OptionSetting[],
  callback?: function,
): Promise<SetOptionsResponse>

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

پارامترها

  • دسته اسکنر

    رشته

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

  • گزینه‌ها

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

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (response: SetOptionsResponse) => void

بازگشت‌ها

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

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

startScan()

قول کروم ۱۲۵+
chrome.documentScan.startScan(
  scannerHandle: string,
  options: StartScanOptions,
  callback?: function,
): Promise<StartScanResponse>

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

پارامترها

  • دسته اسکنر

    رشته

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

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (response: StartScanResponse) => void

بازگشت‌ها

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

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