chrome.documentScan

refresh date: 2026-09-25 robots: noindex

ملاحظة مهمة: تعمل واجهة برمجة التطبيقات هذه على نظام التشغيل ChromeOS فقط.

الوصف

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

الأذونات

documentScan

مدى التوفّر

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

Document Scan API

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

ملاحظة: تعتمد واجهة برمجة التطبيقات هذه على ميزات نظام التشغيل التي قد لا تكون متاحة حسب نظام التشغيل الأساسي. حتى وقت كتابة هذه السطور، لا يعمل سوى نظام التشغيل ChromeOS لبعض الأجهزة المتصلة عبر USB بنجاح.

الأنواع

CancelScanResponse

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

الخصائص

• وظيفة

  سلسلة

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

• نتيجة

  OperationResult

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

CloseScannerResponse

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

الخصائص

• نتيجة

  OperationResult

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

• scannerHandle

  سلسلة

  مؤشر الماسح الضوئي نفسه الذي تم تمريره إلى closeScanner.

Configurability

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

كيفية تغيير خيار معيّن

Enum

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

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

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

ConnectionType

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

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

Enum

"UNSPECIFIED"

"USB"

"NETWORK"

ConstraintType

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

نوع بيانات القيد الذي يمثّله 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

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

الخصائص

• محلي

  قيمة منطقية اختيارية

  عرض الماسحات الضوئية المتصلة مباشرةً بالكمبيوتر فقط

• آمن

  قيمة منطقية اختيارية

  يجب عرض الماسحات الضوئية التي تستخدم وسيلة نقل آمنة فقط، مثل USB أو بروتوكول أمان طبقة النقل (TLS).

GetOptionGroupsResponse

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

الخصائص

• مجموعات

  OptionGroup[] اختيارية

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

• نتيجة

  OperationResult

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

• scannerHandle

  سلسلة

  مؤشر الماسح الضوئي نفسه الذي تم تمريره إلى getOptionGroups.

GetScannerListResponse

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

الخصائص

• نتيجة

  OperationResult

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

• أجهزة المسح الضوئي

  ScannerInfo[]

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

OpenScannerResponse

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

الخصائص

• الخيارات

  object اختياري

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

• نتيجة

  OperationResult

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

• scannerHandle

  string اختياري

  إذا كانت قيمة result هي SUCCESS، يتم عرض مؤشر للماسح الضوئي يمكن استخدامه لإجراء عمليات أخرى.

• scannerId

  سلسلة

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

OperationResult

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

قائمة تعداد تشير إلى نتيجة كل عملية.

Enum

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

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

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

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

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

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

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

"EOF"
لا تتوفّر بيانات أخرى.

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

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

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

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

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

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

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

"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 والإصدارات الأحدث

نوع بيانات الخيار

Enum

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

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

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

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

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

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

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

OptionUnit

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

يشير إلى نوع البيانات في ScannerOption.unit.

Enum

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

"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 والإصدارات الأحدث

الخصائص

• الخيارات

  object اختياري

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

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

• النتائج

  SetOptionResult[]

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

• scannerHandle

  سلسلة

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

StartScanOptions

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

الخصائص

• التنسيق

  سلسلة

  يحدّد نوع MIME لعرض البيانات الممسوحة ضوئيًا.

• maxReadSize

  number اختيارية

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

StartScanResponse

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

الخصائص

• وظيفة

  string اختياري

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

• نتيجة

  OperationResult

  نتيجة بدء عملية فحص إذا كانت قيمة هذه السمة هي SUCCESS، ستتم تعبئة السمة job.

• scannerHandle

  سلسلة

  يوفّر هذا الحقل الاسم المعرِّف نفسه للماسح الضوئي الذي تم تمريره إلى startScan().

الطُرق

cancelScan()

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

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

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

المعلمات

• وظيفة

  سلسلة

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

• callback

  function اختياري

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

  (response: CancelScanResponse) => void

  • رد

    CancelScanResponse

المرتجعات

• Promise<CancelScanResponse>

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

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

closeScanner()

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

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

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

المعلمات

• scannerHandle

  سلسلة

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

• callback

  function اختياري

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

  (response: CloseScannerResponse) => void

  • رد

    CloseScannerResponse

المرتجعات

• Promise<CloseScannerResponse>

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

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

getOptionGroups()

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

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

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

المعلمات

• scannerHandle

  سلسلة

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

• callback

  function اختياري

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

  (response: GetOptionGroupsResponse) => void

  • رد

    GetOptionGroupsResponse

المرتجعات

• Promise<GetOptionGroupsResponse>

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

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

getScannerList()

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

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

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

المعلمات

• تصفية

  DeviceFilter

  ‫DeviceFilter تشير إلى أنواع الماسحات الضوئية التي يجب عرضها

• callback

  function اختياري

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

  (response: GetScannerListResponse) => void

  • رد

    GetScannerListResponse

المرتجعات

• Promise<GetScannerListResponse>

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

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

openScanner()

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

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

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

المعلمات

• scannerId

  سلسلة

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

• callback

  function اختياري

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

  (response: OpenScannerResponse) => void

  • رد

    OpenScannerResponse

المرتجعات

• Promise<OpenScannerResponse>

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

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

readScanData()

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

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

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

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

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

المعلمات

• وظيفة

  سلسلة

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

• callback

  function اختياري

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

  (response: ReadScanDataResponse) => void

  • رد

    ReadScanDataResponse

المرتجعات

• Promise<ReadScanDataResponse>

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

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

scan()

Promise

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

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

المعلمات

• الخيارات

  ScanOptions

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

• callback

  function اختياري

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

  (result: ScanResults) => void

  • نتيجة

    ScanResults

المرتجعات

• Promise<ScanResults>

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

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

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

setOptions()

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

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

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

المعلمات

• scannerHandle

  سلسلة

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

• الخيارات

  OptionSetting[]

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

• callback

  function اختياري

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

  (response: SetOptionsResponse) => void

  • رد

    SetOptionsResponse

المرتجعات

• Promise<SetOptionsResponse>

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

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

startScan()

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

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

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

المعلمات

• scannerHandle

  سلسلة

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

• الخيارات

  StartScanOptions

  عنصر StartScanOptions يشير إلى الخيارات التي سيتم استخدامها في عملية المسح الضوئي يجب أن تتطابق السمة StartScanOptions.format مع أحد الإدخالات التي تم عرضها في ScannerInfo الماسح الضوئي.

• callback

  function اختياري

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

  (response: StartScanResponse) => void

  • رد

    StartScanResponse

المرتجعات

• Promise<StartScanResponse>

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

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