chrome.documentScan

refresh date: 2026-09-25 robots: noindex

الوصف

استخدِم واجهة برمجة التطبيقات chrome.documentScan للعثور على الصور واستردادها من الماسحات الضوئية للمستندات المرفقة.

الأذونات

documentScan

مدى التوفّر

الإصدار 44 من Chrome أو الإصدارات الأحدث نظام التشغيل ChromeOS فقط

Document Scan API

تم تصميم واجهة برمجة التطبيقات Document Scan للسماح للتطبيقات والإضافات بعرض محتوى المستندات الورقية على ماسح ضوئي للمستندات متصل بالجهاز.

الأنواع

CancelScanResponse

الإصدار 125 من Chrome والإصدارات الأحدث

الخصائص

  • وظيفة

    سلسلة

    تعرض هذه السمة معرّف الوظيفة نفسه الذي تم تمريره إلى cancelScan().

  • نتيجة

    OperationResult

    نتيجة إلغاء الفحص من الخلفية إذا كانت النتيجة OperationResult.SUCCESS أو OperationResult.CANCELLED، تم إلغاء عملية الفحص والماسح الضوئي جاهز لبدء عملية فحص جديدة. إذا كانت النتيجة OperationResult.DEVICE_BUSY ، يعني ذلك أنّ الماسح الضوئي لا يزال يعالج طلب الإلغاء، وعلى المتصل الانتظار لفترة قصيرة وإعادة إرسال الطلب. تشير قيم النتائج الأخرى إلى حدوث خطأ دائم لا يجب إعادة محاولة تنفيذه.

CloseScannerResponse

الإصدار 125 من Chrome والإصدارات الأحدث

الخصائص

  • نتيجة

    OperationResult

    نتيجة إغلاق الماسح الضوئي حتى إذا لم تكن هذه القيمة SUCCESS، سيكون المعرّف غير صالح ويجب عدم استخدامه في أي عمليات أخرى.

  • scannerHandle

    سلسلة

    معرّف الماسح الضوئي نفسه الذي تم تمريره إلى closeScanner

Configurability

الإصدار 125 من Chrome والإصدارات الأحدث

كيفية تغيير أحد الخيارات

تعداد

NOT_CONFIGURABLE
الخيار للقراءة فقط.

"SOFTWARE_CONFIGURABLE"
يمكن ضبط الخيار في البرنامج.

HARDWARE_CONFIGURABLE
يمكن للمستخدم ضبط الخيار من خلال تبديل زر أو الضغط عليه في الماسح الضوئي.

ConnectionType

الإصدار 125 من Chrome والإصدارات الأحدث

يشير إلى طريقة توصيل الماسح الضوئي بالكمبيوتر.

تعداد

"UNSPECIFIED"

"USB"

"NETWORK"

ConstraintType

الإصدار 125 من 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

الإصدار 125 من Chrome والإصدارات الأحدث

الخصائص

  • محلي

    boolean اختياري

    لا تعرض سوى الماسحات الضوئية المتصلة مباشرةً بالكمبيوتر.

  • آمن

    boolean اختياري

    لا تستخدم سوى الماسحات الضوئية التي تستخدم وسيلة نقل آمنة، مثل USB أو TLS.

GetOptionGroupsResponse

الإصدار 125 من Chrome والإصدارات الأحدث

الخصائص

  • مجموعات

    OptionGroup[] اختياري

    إذا كانت قيمة result هي SUCCESS، تعرض قائمة بمجموعات الخيارات بالترتيب الذي يوفّره برنامج تشغيل الماسح الضوئي.

  • نتيجة

    OperationResult

    نتيجة الحصول على مجموعات الخيارات إذا كانت قيمة هذا الحقل هي SUCCESS، سيتم ملء السمة groups.

  • scannerHandle

    سلسلة

    معرّف الماسح الضوئي نفسه الذي تم تمريره إلى getOptionGroups

GetScannerListResponse

الإصدار 125 من Chrome والإصدارات الأحدث

الخصائص

  • نتيجة

    OperationResult

    نتيجة التعداد يُرجى العِلم أنّه يمكن عرض نتائج جزئية حتى إذا كان ذلك يشير إلى حدوث خطأ.

  • الماسحات الضوئية

    ScannerInfo[]

    قائمة قد تكون فارغة بالماسحات الضوئية التي تتطابق مع DeviceFilter المقدَّم.

OpenScannerResponse

الإصدار 125 من Chrome والإصدارات الأحدث

الخصائص

  • الخيارات

    كائن اختياري

    إذا كانت قيمة result هي SUCCESS، يتم توفير ربط بين مفتاح وقيمة، حيث يكون المفتاح خيارًا خاصًا بالجهاز والقيمة هي مثيل من ScannerOption.

  • نتيجة

    OperationResult

    نتيجة فتح الماسح الضوئي إذا كانت قيمة هذا الحقل هي SUCCESS، ستتم تعبئة السمتَين scannerHandle وoptions.

  • scannerHandle

    سلسلة اختيارية

    إذا كانت قيمة result هي SUCCESS، يكون هذا المتغير عبارة عن معرّف للماسح الضوئي يمكن استخدامه في عمليات أخرى.

  • scannerId

    سلسلة

    تم تمرير رقم تعريف الماسح الضوئي إلى openScanner().

OperationResult

الإصدار 125 من Chrome والإصدارات الأحدث

تعداد يوضّح نتيجة كل عملية.

تعداد

UNKNOWN"
حدث خطأ غير معروف أو عام.

"SUCCESS"
نجحت العملية.

"UNSUPPORTED"
العملية غير متاحة.

"تم الإلغاء"
تم إلغاء العملية.

‫"DEVICE_BUSY"
الجهاز مشغول.

‫"INVALID"
إما أنّ البيانات أو وسيطة تم تمريرها إلى الطريقة غير صالحة.

"WRONG_TYPE"
القيمة المقدَّمة هي نوع بيانات غير صحيح للخيار الأساسي.

"نهاية الملف"
لا تتوفّر أي بيانات أخرى.

‫"ADF_JAMMED"
وحدة تغذية المستندات مليئة بالأوراق.

‫"ADF_EMPTY"
وحدة تغذية المستندات فارغة.

‫"COVER_OPEN"
غطاء الماسحة الضوئية المسطحة مفتوح.

"IO_ERROR"
حدث خطأ أثناء الاتصال بالجهاز.

"ACCESS_DENIED"
يتطلّب الجهاز المصادقة.

‫"NO_MEMORY"
لا تتوفّر مساحة كافية من الذاكرة على جهاز Chromebook لإكمال العملية.

"يتعذّر الوصول إلى الجهاز"
يتعذّر الوصول إلى الجهاز.

"MISSING"
الجهاز غير متصل.

"INTERNAL_ERROR"
حدث خطأ في مكان آخر غير التطبيق الذي يتم استدعاؤه.

OptionConstraint

الإصدار 125 من Chrome والإصدارات الأحدث

الخصائص

  • قائمة

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

  • الحد الأقصى

    number اختياري

  • دقيقة

    number اختياري

  • quant

    number اختياري

  • النوع

    ConstraintType

OptionGroup

الإصدار 125 من Chrome والإصدارات الأحدث

الخصائص

  • الأعضاء

    string[]

    مجموعة من أسماء الخيارات بالترتيب الذي يحدّده السائق

  • title

    سلسلة

    توفّر عنوانًا قابلاً للطباعة، مثل "خيارات الأشكال الهندسية".

OptionSetting

الإصدار 125 من Chrome والإصدارات الأحدث

الخصائص

  • الاسم

    سلسلة

    يشير إلى اسم الخيار الذي سيتم ضبطه.

  • النوع

    OptionType

    تشير إلى نوع بيانات الخيار. يجب أن يتطابق نوع البيانات المطلوب مع نوع البيانات الفعلي للخيار الأساسي.

  • القيمة

    string | number | boolean | number[] اختياري

    تشير إلى القيمة المطلوب ضبطها. اترك هذا الحقل بدون تحديد لطلب ضبط تلقائي للخيارات التي تم تفعيل autoSettable فيها. يجب أن يتطابق نوع البيانات المقدَّم لـ value مع type.

OptionType

الإصدار 125 من Chrome والإصدارات الأحدث

نوع بيانات أحد الخيارات

تعداد

"UNKNOWN"
نوع بيانات الخيار غير معروف. سيتم إلغاء ضبط السمة value.

‫"BOOL"
ستكون قيمة السمة value إحدى القيمتين truefalse.

"INT"
عدد صحيح مكوّن من 32 بت وموقّع. ستكون السمة value طويلة أو طويلة[]، وذلك حسب ما إذا كان الخيار يقبل أكثر من قيمة واحدة.

"FIXED"
عدد مزدوج في النطاق ‎-32768-32767.9999 بدقة 1/65535 سيكون نوع السمة value double أو double[] ‎، وذلك حسب ما إذا كان الخيار يقبل أكثر من قيمة واحدة. سيتم تقريب القيم المضاعفة التي لا يمكن تمثيلها بدقة إلى النطاق والدقة المتاحَين.

"STRING"
تسلسل من أي وحدات بايت باستثناء NUL (‎\0). ستكون السمة value عبارة عن DOMString.

"BUTTON"
لا يتضمّن الخيار من هذا النوع أي قيمة. بدلاً من ذلك، يؤدي ضبط خيار من هذا النوع إلى حدوث تأثير جانبي خاص بالخيار في برنامج تشغيل الماسح الضوئي. على سبيل المثال، يمكن أن يستخدم برنامج تشغيل الماسح الضوئي خيارًا من نوع الزر لتوفير وسيلة لاختيار القيم التلقائية أو لإخبار وحدة تغذية المستندات التلقائية بالانتقال إلى ورقة الورق التالية.

"GROUP"
خيار التجميع لا قيمة. يتم تضمين ذلك لأغراض التوافق، ولكن لن يتم عرضه عادةً في قيم ScannerOption. استخدِم getOptionGroups() لاسترداد قائمة المجموعات مع خيارات الأعضاء.

OptionUnit

الإصدار 125 من Chrome والإصدارات الأحدث

يشير هذا الحقل إلى نوع البيانات لـ ScannerOption.unit.

تعداد

"بدون وحدة"
القيمة هي رقم بدون وحدة. على سبيل المثال، يمكن أن يكون حدًا أدنى.

"PIXEL"
القيمة هي عدد وحدات البكسل، مثل أبعاد المسح الضوئي.

"BIT"
القيمة هي عدد البتات، على سبيل المثال، عمق اللون.

"MM"
يتم قياس القيمة بالملليمتر، على سبيل المثال، أبعاد عملية المسح الضوئي.

استبدِل "DPI"
بالقيمة التي يتم قياسها بالنقاط لكل بوصة، مثل الدقة.

‫"PERCENT"
القيمة هي نسبة مئوية، مثل السطوع.

"MICROSECOND"
يتم قياس القيمة بالميكرو ثانية، مثل وقت التعرض.

ReadScanDataResponse

الإصدار 125 من Chrome والإصدارات الأحدث

الخصائص

  • البيانات

    ‫ArrayBuffer اختياري

    إذا كانت قيمة result هي SUCCESS، يحتوي على الجزء التالي من بيانات الصورة الممسوحة ضوئيًا. إذا كانت قيمة result هي EOF، يحتوي على الجزء الأخير من بيانات الصورة الممسوحة ضوئيًا.

  • estimatedCompletion

    number اختياري

    إذا كانت قيمة result هي SUCCESS، يتم عرض تقدير لمقدار بيانات الفحص الإجمالية التي تم تسليمها حتى الآن، وذلك في النطاق من 0 إلى 100.

  • وظيفة

    سلسلة

    توفّر هذه السمة معرّف المهمة الذي تم تمريره إلى readScanData().

  • نتيجة

    OperationResult

    نتيجة قراءة البيانات إذا كانت قيمتها SUCCESS، سيحتوي data على الجزء التالي (ربما يكون بطول صفر) من بيانات الصورة الجاهزة للقراءة. إذا كانت قيمتها EOF، يحتوي data على الجزء الأخير من بيانات الصورة.

ScannerInfo

الإصدار 125 من Chrome والإصدارات الأحدث

الخصائص

  • connectionType

    ConnectionType

    يشير إلى طريقة توصيل الماسح الضوئي بالكمبيوتر.

  • deviceUuid

    سلسلة

    للمطابقة مع إدخالات ScannerInfo الأخرى التي تشير إلى الجهاز الفعلي نفسه

  • imageFormats

    string[]

    مصفوفة من أنواع MIME التي يمكن طلبها لعمليات الفحص التي يتم إرجاعها.

  • الشركة المصنّعة

    سلسلة

    الشركة المصنّعة للماسح الضوئي

  • نموذج

    سلسلة

    تمثّل هذه السمة طراز الماسح الضوئي إذا كان متاحًا، أو وصفًا عامًا.

  • الاسم

    سلسلة

    اسم يمكن للمستخدم قراءته ويظهر في واجهة المستخدم.

  • protocolType

    سلسلة

    وصف يمكن لشخص عادي قراءته للبروتوكول أو برنامج التشغيل المستخدَم للوصول إلى الماسحة الضوئية، مثل Mopria أو WSD أو epsonds ويفيد ذلك بشكل أساسي في السماح للمستخدم بالاختيار بين البروتوكولات إذا كان الجهاز يتيح استخدام بروتوكولات متعددة.

  • scannerId

    سلسلة

    معرّف ماسح ضوئي معيّن

  • آمن

    قيمة منطقية

    إذا كانت القيمة صحيحة، لا يمكن لبرنامج استماع غير نشط، مثل بروتوكول أمان طبقة النقل (TLS) أو USB، اعتراض نقل اتصال الماسح الضوئي.

ScannerOption

الإصدار 125 من Chrome والإصدارات الأحدث

الخصائص

  • إمكانية الضبط

    إمكانية الضبط

    يشير إلى ما إذا كان يمكن تغيير الخيار وكيفية تغييره.

  • قيد

    OptionConstraint اختياري

    تحدّد هذه السمة OptionConstraint في خيار الماسح الضوئي الحالي.

  • الوصف

    سلسلة

    وصف أطول للخيار

  • isActive

    قيمة منطقية

    يشير إلى أنّ الخيار نشط ويمكن ضبطه أو استرداده. إذا كانت القيمة "خطأ"، لن يتم ضبط السمة value.

  • isAdvanced

    قيمة منطقية

    يشير إلى أنّه يجب ألا تعرض واجهة المستخدِم هذا الخيار تلقائيًا.

  • isAutoSettable

    قيمة منطقية

    يمكن ضبطه تلقائيًا بواسطة برنامج تشغيل الماسح الضوئي.

  • isDetectable

    قيمة منطقية

    يشير إلى أنّه يمكن رصد هذا الخيار من خلال البرامج.

  • isEmulated

    قيمة منطقية

    يتم محاكاتها من خلال برنامج تشغيل الماسح الضوئي إذا كانت القيمة صحيحة.

  • الاسم

    سلسلة

    اسم الخيار باستخدام أحرف ASCII الصغيرة والأرقام والشرطات لا يُسمح باستخدام علامات التشكيل.

  • title

    سلسلة

    عنوان قابل للطباعة مؤلّف من سطر واحد

  • النوع

    OptionType

    تمثّل هذه السمة نوع البيانات الواردة في السمة value، وهي مطلوبة لضبط هذا الخيار.

  • الوحدة

    OptionUnit

    تمثّل هذه السمة وحدة قياس هذا الخيار.

  • القيمة

    string | number | boolean | number[] اختياري

    تمثّل هذه السمة القيمة الحالية للخيار، إذا كان ذلك منطبقًا. يُرجى العِلم أنّ نوع بيانات هذه السمة يجب أن يتطابق مع نوع البيانات المحدّد في type.

ScanOptions

الخصائص

  • maxImages

    number اختياري

    عدد الصور المسموح بفحصها القيمة التلقائية هي 1.

  • mimeTypes

    string[] اختياري

    أنواع MIME التي يقبلها المتصل.

ScanResults

الخصائص

  • dataUrls

    string[]

    مصفوفة من عناوين URL لصور البيانات بتنسيق يمكن تمريره كقيمة "src" إلى علامة صورة

  • mimeType

    سلسلة

    نوع MIME الخاص بـ dataUrls.

SetOptionResult

الإصدار 125 من Chrome والإصدارات الأحدث

الخصائص

  • الاسم

    سلسلة

    تشير إلى اسم الخيار الذي تم ضبطه.

  • نتيجة

    OperationResult

    تشير هذه السمة إلى نتيجة ضبط الخيار.

SetOptionsResponse

الإصدار 125 من Chrome والإصدارات الأحدث

الخصائص

  • الخيارات

    كائن اختياري

    عملية ربط معدَّلة بين المفتاح والقيمة من أسماء الخيارات إلى قيم ScannerOption التي تحتوي على الإعداد الجديد بعد محاولة ضبط جميع الخيارات المقدَّمة. تتضمّن هذه السمة البنية نفسها التي تتضمّنها السمة options في OpenScannerResponse.

    سيتم ضبط هذه السمة حتى إذا لم يتم ضبط بعض الخيارات بنجاح، ولكن سيتم إلغاء ضبطها في حال تعذّر استرداد الإعدادات المعدَّلة (على سبيل المثال، إذا تم فصل الماسح الضوئي أثناء عملية المسح).

  • النتائج

    SetOptionResult[]

    مصفوفة من النتائج، واحدة لكل OptionSetting تم تمريرها.

  • scannerHandle

    سلسلة

    تعرض هذه السمة معرّف الماسح الضوئي الذي تم تمريره إلى setOptions().

StartScanOptions

الإصدار 125 من Chrome والإصدارات الأحدث

الخصائص

  • التنسيق

    سلسلة

    تحدّد هذه السمة نوع MIME الذي سيتم عرض البيانات التي تم فحصها به.

  • maxReadSize

    number اختياري

    إذا تم تحديد قيمة غير صفرية، سيتم حصر الحد الأقصى للبايتات التي تم فحصها والتي يتم عرضها في ردّ واحد من readScanData على تلك القيمة. أصغر قيمة مسموح بها هي 32768 (32 كيلوبايت). في حال عدم تحديد هذه السمة، قد يكون حجم الجزء الذي يتم عرضه كبيرًا مثل الصورة الممسوحة ضوئيًا بالكامل.

StartScanResponse

الإصدار 125 من 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

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (response: CancelScanResponse) => void

المرتجعات

  • تعرض هذه الطريقة Promise يتم تنفيذه مع النتيجة.

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، بينما تحتاج المنصات الأخرى إلى استخدام عمليات معاودة الاتصال.

closeScanner()

Promise Chrome 125 والإصدارات الأحدث 
chrome.documentScan.closeScanner(
  scannerHandle: string,
  callback?: function,
): Promise<CloseScannerResponse>

تُغلِق هذه الطريقة الماسح الضوئي باستخدام المعرّف الذي تم تمريره وتعرض Promise يتم تنفيذه باستخدام العنصر CloseScannerResponse. في حال استخدام دالة ردّ الاتصال، يتم تمرير العنصر إليها بدلاً من ذلك. حتى إذا لم تنجح الاستجابة، يصبح المعرّف المقدَّم غير صالح ويجب عدم استخدامه في عمليات أخرى.

المعلمات

  • scannerHandle

    سلسلة

    تحدّد هذه السمة معرّفًا لمسح ضوئي مفتوح تم إرجاعه سابقًا من طلب إلى openScanner.

  • callback

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (response: CloseScannerResponse) => void

المرتجعات

  • تعرض هذه الطريقة Promise يتم تنفيذه مع النتيجة.

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، بينما تحتاج المنصات الأخرى إلى استخدام عمليات معاودة الاتصال.

getOptionGroups()

Promise Chrome 125 والإصدارات الأحدث 
chrome.documentScan.getOptionGroups(
  scannerHandle: string,
  callback?: function,
): Promise<GetOptionGroupsResponse>

تعرض هذه الدالة أسماء المجموعات وخيارات الأعضاء من أداة فحص تم فتحها سابقًا باستخدام openScanner. يعرض هذا الإجراء Promise يتم تنفيذه باستخدام عنصر GetOptionGroupsResponse. إذا تم تمرير دالة ردّ اتصال إلى هذه الدالة، سيتم تمرير البيانات التي تم إرجاعها إليها بدلاً من ذلك.

المعلمات

  • scannerHandle

    سلسلة

    معرّف الماسح الضوئي المفتوح الذي تم إرجاعه من طلب إلى openScanner

  • callback

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (response: GetOptionGroupsResponse) => void

المرتجعات

  • تعرض هذه الطريقة Promise يتم تنفيذه مع النتيجة.

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، بينما تحتاج المنصات الأخرى إلى استخدام عمليات معاودة الاتصال.

getScannerList()

Promise Chrome 125 والإصدارات الأحدث 
chrome.documentScan.getScannerList(
  filter: DeviceFilter,
  callback?: function,
): Promise<GetScannerListResponse>

تعرض هذه الطريقة قائمة بالماسحات الضوئية المتاحة وتعرض Promise يتم تنفيذه باستخدام كائن GetScannerListResponse. إذا تم تمرير دالة ردّ اتصال إلى هذه الدالة، سيتم تمرير البيانات التي تم إرجاعها إليها بدلاً من ذلك.

المعلمات

المرتجعات

  • تعرض هذه الطريقة Promise يتم تنفيذه مع النتيجة وقائمة الماسحات الضوئية.

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، بينما تحتاج المنصات الأخرى إلى استخدام عمليات معاودة الاتصال.

openScanner()

Promise Chrome 125 والإصدارات الأحدث 
chrome.documentScan.openScanner(
  scannerId: string,
  callback?: function,
): Promise<OpenScannerResponse>

يفتح هذا الإجراء ماسحًا ضوئيًا للوصول الحصري ويعرض Promise يتم تنفيذه باستخدام العنصر OpenScannerResponse. إذا تم تمرير دالة ردّ اتصال إلى هذه الدالة، سيتم تمرير البيانات التي تم إرجاعها إليها بدلاً من ذلك.

المعلمات

  • scannerId

    سلسلة

    معرّف الماسح الضوئي المطلوب فتحه هذه القيمة هي قيمة تم عرضها من طلب سابق إلى getScannerList.

  • callback

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (response: OpenScannerResponse) => void

المرتجعات

  • تعرض هذه الطريقة Promise يتم تنفيذه مع النتيجة.

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، بينما تحتاج المنصات الأخرى إلى استخدام عمليات معاودة الاتصال.

readScanData()

Promise Chrome 125 والإصدارات الأحدث 
chrome.documentScan.readScanData(
  job: string,
  callback?: function,
): Promise<ReadScanDataResponse>

تقرأ هذه الطريقة الجزء التالي من بيانات الصورة المتاحة من معرّف مهمة نشطة، وتعرض Promise يتم تنفيذه باستخدام عنصر ReadScanDataResponse. في حال استخدام دالة ردّ الاتصال، يتم تمرير العنصر إليها بدلاً من ذلك.

**ملاحظة:**من الصالح أن تكون نتيجة الردّ SUCCESS مع عنصر data بطول صفر. وهذا يعني أنّ الماسح الضوئي لا يزال يعمل ولكنّه لم يحصل بعد على بيانات إضافية. على المتصل الانتظار لفترة قصيرة وإعادة المحاولة.

عند اكتمال مهمة البحث، سيتضمّن الرد قيمة النتيجة EOF. قد يحتوي هذا الردّ على عضو نهائي غير صفري data.

المعلمات

  • وظيفة

    سلسلة

    مقبض الوظيفة النشطة الذي تم عرضه سابقًا من startScan.

  • callback

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (response: ReadScanDataResponse) => void

المرتجعات

  • تعرض هذه الطريقة Promise يتم تنفيذه مع النتيجة.

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، بينما تحتاج المنصات الأخرى إلى استخدام عمليات معاودة الاتصال.

scan()

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

تنفّذ هذه الطريقة عملية مسح ضوئي للمستند وتعرض Promise يتم تنفيذه باستخدام عنصر ScanResults. إذا تم تمرير دالة ردّ اتصال إلى هذه الدالة، سيتم تمرير البيانات التي تم إرجاعها إليها بدلاً من ذلك.

المعلمات

  • الخيارات

    ScanOptions

    كائن يحتوي على مَعلمات المسح الضوئي

  • callback

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (result: ScanResults) => void

المرتجعات

  • Promise<ScanResults>

    ‫Chrome 96 والإصدارات الأحدث

    تعرض هذه الطريقة Promise يتم تنفيذه مع نتائج الفحص.

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، بينما تحتاج المنصات الأخرى إلى استخدام عمليات معاودة الاتصال.

setOptions()

Promise Chrome 125 والإصدارات الأحدث 
chrome.documentScan.setOptions(
  scannerHandle: string,
  options: OptionSetting[],
  callback?: function,
): Promise<SetOptionsResponse>

تضبط هذه الطريقة الخيارات على الماسح الضوئي المحدّد وتعرض Promise يتم تنفيذه باستخدام كائن SetOptionsResponse يحتوي على نتيجة محاولة ضبط كل قيمة بترتيب كائن OptionSetting الذي تم تمريره. في حال استخدام دالة ردّ الاتصال، يتم تمرير العنصر إليها بدلاً من ذلك.

المعلمات

  • scannerHandle

    سلسلة

    مقبض الماسح الضوئي الذي سيتم ضبط الخيارات عليه. يجب أن تكون هذه القيمة قد تم عرضها سابقًا من طلب إلى openScanner.

  • الخيارات

    OptionSetting[]

    قائمة تضم OptionSetting عنصر سيتم تطبيقها على الماسح الضوئي.

  • callback

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (response: SetOptionsResponse) => void

المرتجعات

  • تعرض هذه الطريقة Promise يتم تنفيذه مع النتيجة.

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، بينما تحتاج المنصات الأخرى إلى استخدام عمليات معاودة الاتصال.

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

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (response: StartScanResponse) => void

المرتجعات

  • تعرض هذه الطريقة Promise يتم تنفيذه مع النتيجة.

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، بينما تحتاج المنصات الأخرى إلى استخدام عمليات معاودة الاتصال.