chrome.documentScan

refresh date: 2026-09-25 robots: noindex

ब्यौरा

अटैच किए गए दस्तावेज़ स्कैनर से इमेज ढूंढने और वापस पाने के लिए, chrome.documentScan एपीआई का इस्तेमाल करें.

अनुमतियां

documentScan

उपलब्धता

Chrome 44 या इसके बाद का वर्शन सिर्फ़ ChromeOS के लिए

Document Scan API

Document Scan API को इस तरह से डिज़ाइन किया गया है कि ऐप्लिकेशन और एक्सटेंशन, अटैच किए गए दस्तावेज़ स्कैनर पर मौजूद काग़ज़ के दस्तावेज़ों का कॉन्टेंट देख सकें.

टाइप

CancelScanResponse

Chrome 125 या इसके बाद का वर्शन

प्रॉपर्टी

  • नौकरी

    स्ट्रिंग

    यह वही जॉब हैंडल उपलब्ध कराता है जो cancelScan() को पास किया गया था.

  • नतीजा

    OperationResult

    बैकएंड से स्कैन करने की प्रोसेस रद्द करने का नतीजा. अगर नतीजा OperationResult.SUCCESS या OperationResult.CANCELLED है, तो इसका मतलब है कि स्कैन रद्द कर दिया गया है और स्कैनर, नया स्कैन शुरू करने के लिए तैयार है. अगर नतीजा OperationResult.DEVICE_BUSY है, तो इसका मतलब है कि स्कैनर, रद्द करने के अनुरोध को अब भी प्रोसेस कर रहा है. कॉल करने वाले व्यक्ति को कुछ समय इंतज़ार करना चाहिए और फिर से अनुरोध करना चाहिए. नतीजे की अन्य वैल्यू से पता चलता है कि कोई ऐसी गड़बड़ी हुई है जिसे ठीक नहीं किया जा सकता. इसलिए, इसे फिर से आज़माने की ज़रूरत नहीं है.

CloseScannerResponse

Chrome 125 या इसके बाद का वर्शन

प्रॉपर्टी

  • नतीजा

    OperationResult

    स्कैनर बंद करने का नतीजा. अगर यह वैल्यू SUCCESS नहीं है, तब भी हैंडल अमान्य होगा. साथ ही, इसका इस्तेमाल किसी भी अन्य कार्रवाई के लिए नहीं किया जाना चाहिए.

  • scannerHandle

    स्ट्रिंग

    वही स्कैनर हैंडल जिसे closeScanner को पास किया गया था.

Configurability

Chrome 125 या इसके बाद का वर्शन

किसी विकल्प को कैसे बदला जा सकता है.

Enum

"NOT_CONFIGURABLE"
यह विकल्प सिर्फ़ पढ़ने के लिए है.

"SOFTWARE_CONFIGURABLE"
इस विकल्प को सॉफ़्टवेयर में सेट किया जा सकता है.

"HARDWARE_CONFIGURABLE"
इस विकल्प को उपयोगकर्ता, स्कैनर पर मौजूद बटन को टॉगल करके या दबाकर सेट कर सकता है.

ConnectionType

Chrome 125 या इसके बाद का वर्शन

इससे पता चलता है कि स्कैनर, कंप्यूटर से कैसे कनेक्ट किया गया है.

Enum

"UNSPECIFIED"

"USB"

"NETWORK"

ConstraintType

Chrome 125 या इसके बाद का वर्शन

OptionConstraint से दिखाए गए कंस्ट्रेंट का डेटा टाइप.

Enum

"INT_RANGE"
यह OptionType.INT वैल्यू की रेंज पर लागू होने वाली शर्त है. OptionConstraint की min, max, और quant प्रॉपर्टी long होंगी. साथ ही, इसकी list प्रॉपर्टी सेट नहीं होगी.

"FIXED_RANGE"
OptionType.FIXED वैल्यू की रेंज पर पाबंदी. OptionConstraint की min, max, और quant प्रॉपर्टी 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 या इसके बाद का वर्शन

प्रॉपर्टी

  • स्थानीय

    boolean ज़रूरी नहीं है

    सिर्फ़ उन स्कैनर को वापस करें जो सीधे तौर पर कंप्यूटर से जुड़े हैं.

  • सुरक्षित

    boolean ज़रूरी नहीं है

    सिर्फ़ ऐसे स्कैनर का इस्तेमाल करें जो सुरक्षित ट्रांसपोर्ट का इस्तेमाल करते हैं. जैसे, यूएसबी या टीएलएस.

GetOptionGroupsResponse

Chrome 125 या इसके बाद का वर्शन

प्रॉपर्टी

  • समूह

    OptionGroup[] optional

    अगर result, SUCCESS है, तो स्कैनर ड्राइवर की ओर से दिए गए क्रम में विकल्प ग्रुप की सूची दिखाता है.

  • नतीजा

    OperationResult

    विकल्प ग्रुप पाने का नतीजा. अगर इसकी वैल्यू SUCCESS है, तो groups प्रॉपर्टी की वैल्यू अपने-आप भर जाएगी.

  • scannerHandle

    स्ट्रिंग

    वही स्कैनर हैंडल जिसे getOptionGroups को पास किया गया था.

GetScannerListResponse

Chrome 125 या इसके बाद का वर्शन

प्रॉपर्टी

  • नतीजा

    OperationResult

    गिनती का नतीजा. ध्यान दें कि गड़बड़ी का यह मैसेज मिलने पर भी, कुछ नतीजे दिखाए जा सकते हैं.

  • स्कैनर

    ScannerInfo[]

    यह स्कैनर की ऐसी सूची होती है जिसमें कोई स्कैनर मौजूद नहीं भी हो सकता है. इस सूची में, दिए गए DeviceFilter से मेल खाने वाले स्कैनर शामिल होते हैं.

OpenScannerResponse

Chrome 125 या इसके बाद का वर्शन

प्रॉपर्टी

  • विकल्प

    ऑब्जेक्ट ज़रूरी नहीं

    अगर result SUCCESS है, तो यह एक की-वैल्यू मैपिंग उपलब्ध कराता है. इसमें कुंजी, डिवाइस के हिसाब से तय किया गया विकल्प होती है और वैल्यू, ScannerOption का इंस्टेंस होती है.

  • नतीजा

    OperationResult

    स्कैनर खोलने का नतीजा. अगर इसकी वैल्यू SUCCESS है, तो scannerHandle और options प्रॉपर्टी की वैल्यू अपने-आप भर जाएगी.

  • scannerHandle

    string ज़रूरी नहीं है

    अगर result, SUCCESS है, तो स्कैनर का हैंडल, जिसका इस्तेमाल आगे की कार्रवाइयों के लिए किया जा सकता है.

  • scannerId

    स्ट्रिंग

    स्कैनर आईडी को openScanner() पर पास किया गया है.

OperationResult

Chrome 125 या इसके बाद का वर्शन

यह एक इनम है, जो हर कार्रवाई के नतीजे के बारे में बताता है.

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

Chrome 125 या इसके बाद का वर्शन

प्रॉपर्टी

  • सूची

    string[] | number[] optional

  • अधिकतम

    number optional

  • कम से कम

    number optional

  • क्वांट

    number optional

  • टाइप

    ConstraintType

OptionGroup

Chrome 125 या इसके बाद का वर्शन

प्रॉपर्टी

  • सदस्य

    string[]

    ड्राइवर के दिए गए क्रम में विकल्पों के नामों की एक सूची.

  • title

    स्ट्रिंग

    इससे प्रिंट किया जा सकने वाला टाइटल मिलता है. उदाहरण के लिए, "ज्यामिति के विकल्प".

OptionSetting

Chrome 125 या इसके बाद का वर्शन

प्रॉपर्टी

  • नाम

    स्ट्रिंग

    इससे सेट किए जाने वाले विकल्प का नाम पता चलता है.

  • टाइप

    OptionType

    इससे विकल्प के डेटा टाइप के बारे में पता चलता है. अनुरोध किया गया डेटा टाइप, विकल्प के असली डेटा टाइप से मेल खाना चाहिए.

  • मान

    string | number | boolean | number[] optional

    इससे सेट की जाने वाली वैल्यू का पता चलता है. autoSettable चालू किए गए विकल्पों के लिए, अपने-आप सेटिंग का अनुरोध करने के लिए, इसे सेट न करें. value एट्रिब्यूट के लिए सबमिट किया गया डेटा टाइप, type एट्रिब्यूट के लिए सबमिट किए गए डेटा टाइप से मेल खाना चाहिए.

OptionType

Chrome 125 या इसके बाद का वर्शन

किसी विकल्प का डेटा टाइप.

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

Chrome 125 या इसके बाद का वर्शन

इससे ScannerOption.unit के लिए डेटा टाइप का पता चलता है.

Enum

"UNITLESS"
वैल्यू, बिना यूनिट वाली संख्या है. उदाहरण के लिए, यह थ्रेशोल्ड हो सकता है.

"PIXEL"
वैल्यू, पिक्सल की संख्या होती है. उदाहरण के लिए, स्कैन डाइमेंशन.

"BIT"
वैल्यू, बिट की संख्या होती है. उदाहरण के लिए, कलर डेप्थ.

"MM"
वैल्यू को मिलीमीटर में मापा जाता है. उदाहरण के लिए, स्कैन डाइमेंशन.

"DPI"
इस वैल्यू को डॉट्स पर इंच में मापा जाता है. उदाहरण के लिए, रिज़ॉल्यूशन.

"PERCENT"
वैल्यू प्रतिशत में है. उदाहरण के लिए, चमक.

"MICROSECOND"
इसकी वैल्यू को माइक्रोसेकंड में मापा जाता है. उदाहरण के लिए, एक्सपोज़र का समय.

ReadScanDataResponse

Chrome 125 या इसके बाद का वर्शन

प्रॉपर्टी

  • डेटा

    ArrayBuffer ज़रूरी नहीं है

    अगर result की वैल्यू SUCCESS है, तो इसमें स्कैन की गई इमेज के डेटा का अगला हिस्सा शामिल होता है. अगर result EOF है, तो इसमें स्कैन की गई इमेज के डेटा का आखिरी हिस्सा शामिल होता है.

  • estimatedCompletion

    number optional

    अगर result SUCCESS है, तो यह अनुमान लगाया जाता है कि अब तक कुल स्कैन किए गए डेटा का कितना हिस्सा डिलीवर किया गया है. यह वैल्यू 0 से 100 के बीच होती है.

  • नौकरी

    स्ट्रिंग

    यह readScanData() को पास किया गया जॉब हैंडल उपलब्ध कराता है.

  • नतीजा

    OperationResult

    डेटा पढ़ने का नतीजा. अगर इसकी वैल्यू SUCCESS है, तो data में इमेज डेटा का next (शायद शून्य लंबाई वाला) हिस्सा होता है, जिसे पढ़ा जा सकता है. अगर इसकी वैल्यू EOF है, तो data में इमेज डेटा का आखिरी हिस्सा होता है.

ScannerInfo

Chrome 125 या इसके बाद का वर्शन

प्रॉपर्टी

  • connectionType

    ConnectionType

    इससे पता चलता है कि स्कैनर, कंप्यूटर से कैसे कनेक्ट किया गया है.

  • deviceUuid

    स्ट्रिंग

    इसका इस्तेमाल, एक ही फ़िज़िकल डिवाइस की ओर इशारा करने वाली अन्य ScannerInfo एंट्री से मिलान करने के लिए किया जाता है.

  • imageFormats

    string[]

    MIME टाइप का एक ऐसा कलेक्शन जिसके लिए स्कैन किए गए डेटा को वापस पाने का अनुरोध किया जा सकता है.

  • निर्माता

    स्ट्रिंग

    स्कैनर बनाने वाली कंपनी.

  • मॉडल

    स्ट्रिंग

    अगर स्कैनर मॉडल उपलब्ध है, तो उसकी जानकारी या सामान्य जानकारी.

  • नाम

    स्ट्रिंग

    स्कैनर का ऐसा नाम जिसे कोई व्यक्ति आसानी से पढ़ सके और यूज़र इंटरफ़ेस में दिखाया जा सके.

  • protocolType

    स्ट्रिंग

    स्कैनर को ऐक्सेस करने के लिए इस्तेमाल किए गए प्रोटोकॉल या ड्राइवर के बारे में ऐसी जानकारी जिसे कोई भी व्यक्ति आसानी से पढ़ सकता है. जैसे, Mopria, WSD या epsonds. यह सुविधा मुख्य रूप से तब काम आती है, जब किसी डिवाइस पर एक से ज़्यादा प्रोटोकॉल काम करते हों और उपयोगकर्ता को प्रोटोकॉल चुनने की अनुमति देनी हो.

  • scannerId

    स्ट्रिंग

    किसी स्कैनर का आईडी.

  • सुरक्षित

    बूलियन

    अगर यह वैल्यू सही है, तो स्कैनर कनेक्शन के ट्रांसपोर्ट को पैसिव लिसनर इंटरसेप्ट नहीं कर सकता. जैसे, टीएलएस या यूएसबी.

ScannerOption

Chrome 125 या इसके बाद का वर्शन

प्रॉपर्टी

  • कॉन्फ़िगर करने की सुविधा

    कॉन्फ़िगर करने की सुविधा

    इससे पता चलता है कि विकल्प को बदला जा सकता है या नहीं. साथ ही, यह भी पता चलता है कि इसे कैसे बदला जा सकता है.

  • सीमा

    OptionConstraint optional

    यह कुकी, स्कैनर के मौजूदा विकल्प पर OptionConstraint को सेट करती है.

  • ब्यौरा

    स्ट्रिंग

    विकल्प के बारे में ज़्यादा जानकारी.

  • isActive

    बूलियन

    इससे पता चलता है कि विकल्प चालू है और इसे सेट या वापस पाया जा सकता है. अगर इस नीति को 'गलत है' पर सेट किया जाता है, तो value प्रॉपर्टी सेट नहीं होगी.

  • isAdvanced

    बूलियन

    इससे पता चलता है कि यूज़र इंटरफ़ेस (यूआई) में, इस विकल्प को डिफ़ॉल्ट रूप से नहीं दिखाना चाहिए.

  • isAutoSettable

    बूलियन

    इसे स्कैनर ड्राइवर अपने-आप सेट कर सकता है.

  • isDetectable

    बूलियन

    इससे पता चलता है कि इस विकल्प का पता सॉफ़्टवेयर से लगाया जा सकता है.

  • isEmulated

    बूलियन

    अगर यह वैल्यू सही है, तो स्कैनर ड्राइवर इसे सिम्युलेट करता है.

  • नाम

    स्ट्रिंग

    विकल्प का नाम, अंग्रेज़ी के छोटे अक्षरों, संख्याओं, और डैश का इस्तेमाल करके लिखा जाता है. डायक्रिटिक का इस्तेमाल करने की अनुमति नहीं है.

  • title

    स्ट्रिंग

    एक लाइन वाला ऐसा टाइटल जिसे प्रिंट किया जा सके.

  • टाइप

    OptionType

    value प्रॉपर्टी में मौजूद डेटा टाइप, जो इस विकल्प को सेट करने के लिए ज़रूरी है.

  • यूनिट

    OptionUnit

    इस विकल्प के लिए मेज़रमेंट की यूनिट.

  • मान

    string | number | boolean | number[] optional

    अगर ज़रूरी हो, तो विकल्प की मौजूदा वैल्यू. ध्यान दें कि इस प्रॉपर्टी का डेटा टाइप, type में बताए गए डेटा टाइप से मेल खाना चाहिए.

ScanOptions

प्रॉपर्टी

  • maxImages

    number optional

    स्कैन की गई इमेज की तय सीमा. डिफ़ॉल्ट वैल्यू 1 होती है.

  • mimeTypes

    string[] ज़रूरी नहीं है

    ये ऐसे MIME टाइप होते हैं जिन्हें कॉल करने वाला व्यक्ति स्वीकार करता है.

ScanResults

प्रॉपर्टी

  • dataUrls

    string[]

    डेटा इमेज के यूआरएल की एक ऐसी कैटगरी जिसे इमेज टैग में "src" वैल्यू के तौर पर पास किया जा सकता है.

  • mimeType

    स्ट्रिंग

    dataUrls का एमआईएमई टाइप.

SetOptionResult

Chrome 125 या इसके बाद का वर्शन

प्रॉपर्टी

  • नाम

    स्ट्रिंग

    इससे सेट किए गए विकल्प का नाम पता चलता है.

  • नतीजा

    OperationResult

    इससे पता चलता है कि विकल्प सेट करने का क्या नतीजा है.

SetOptionsResponse

Chrome 125 या इसके बाद का वर्शन

प्रॉपर्टी

  • विकल्प

    ऑब्जेक्ट ज़रूरी नहीं

    विकल्प के नामों से ScannerOption वैल्यू तक अपडेट की गई कुंजी-वैल्यू मैपिंग. इसमें दिए गए सभी विकल्पों को सेट करने के बाद, नया कॉन्फ़िगरेशन शामिल होता है. इसका स्ट्रक्चर, OpenScannerResponse में मौजूद options प्रॉपर्टी के जैसा ही होता है.

    अगर कुछ विकल्प सेट नहीं किए जा सके, तब भी यह प्रॉपर्टी सेट हो जाएगी. हालांकि, अपडेट किए गए कॉन्फ़िगरेशन को वापस पाने में गड़बड़ी होने पर, यह प्रॉपर्टी अनसेट हो जाएगी. उदाहरण के लिए, अगर स्कैनिंग के बीच में स्कैनर डिसकनेक्ट हो जाता है.

  • नतीजे

    SetOptionResult[]

    नतीजों का कलेक्शन. इसमें पास किए गए हर OptionSetting के लिए एक नतीजा होता है.

  • scannerHandle

    स्ट्रिंग

    यह setOptions() को पास किया गया स्कैनर हैंडल उपलब्ध कराता है.

StartScanOptions

Chrome 125 या इसके बाद का वर्शन

प्रॉपर्टी

  • फ़ॉर्मैट

    स्ट्रिंग

    यह विकल्प, स्कैन किए गए डेटा को किस एमआईएमई टाइप में वापस लाना है, यह तय करता है.

  • maxReadSize

    number optional

    अगर शून्य से अलग कोई वैल्यू तय की जाती है, तो readScanData के एक जवाब में स्कैन किए गए ज़्यादा से ज़्यादा बाइट की संख्या को उस वैल्यू तक सीमित कर दिया जाता है. कम से कम 32768 (32 केबी) वैल्यू इस्तेमाल की जा सकती है. अगर इस प्रॉपर्टी की वैल्यू नहीं दी जाती है, तो लौटाए गए चंक का साइज़, स्कैन की गई पूरी इमेज के बराबर हो सकता है.

StartScanResponse

Chrome 125 या इसके बाद का वर्शन

प्रॉपर्टी

  • नौकरी

    string ज़रूरी नहीं है

    अगर result SUCCESS है, तो एक हैंडल उपलब्ध कराता है. इसका इस्तेमाल स्कैन किए गए डेटा को पढ़ने या स्कैनिंग की प्रोसेस को रद्द करने के लिए किया जा सकता है.

  • नतीजा

    OperationResult

    स्कैन शुरू करने का नतीजा. अगर इसकी वैल्यू SUCCESS है, तो job प्रॉपर्टी की वैल्यू अपने-आप भर जाएगी.

  • scannerHandle

    स्ट्रिंग

    यह उसी स्कैनर हैंडल को उपलब्ध कराता है जिसे startScan() को पास किया गया था.

तरीके

cancelScan()

Promise Chrome 125 या इसके बाद के वर्शन 
chrome.documentScan.cancelScan(
  job: string,
  callback?: function,
): Promise<CancelScanResponse>

यह शुरू किए गए स्कैन को रद्द करता है और एक ऐसा प्रॉमिस दिखाता है जो CancelScanResponse ऑब्जेक्ट के साथ रिज़ॉल्व होता है. अगर किसी कॉलबैक का इस्तेमाल किया जाता है, तो ऑब्जेक्ट को इसके बजाय पास किया जाता है.

पैरामीटर

  • नौकरी

    स्ट्रिंग

    यह एक चालू स्कैन जॉब का हैंडल है. इसे पहले startScan को कॉल करके वापस लाया गया था.

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं है

    callback पैरामीटर ऐसा दिखता है: 

    (response: CancelScanResponse) => void

रिटर्न

  • यह एक प्रॉमिस दिखाता है, जो नतीजे के साथ रिज़ॉल्व होता है.

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म को कॉलबैक का इस्तेमाल करना होगा.

closeScanner()

Promise Chrome 125 या इसके बाद के वर्शन 
chrome.documentScan.closeScanner(
  scannerHandle: string,
  callback?: function,
): Promise<CloseScannerResponse>

यह फ़ंक्शन, पास किए गए हैंडल की मदद से स्कैनर को बंद करता है. साथ ही, एक ऐसा प्रॉमिस दिखाता है जो CloseScannerResponse ऑब्जेक्ट के साथ रिज़ॉल्व होता है. अगर किसी कॉलबैक का इस्तेमाल किया जाता है, तो ऑब्जेक्ट को इसके बजाय पास किया जाता है. अगर रिस्पॉन्स सही नहीं है, तो भी दिया गया हैंडल अमान्य हो जाता है. इसलिए, इसका इस्तेमाल आगे की कार्रवाइयों के लिए नहीं किया जाना चाहिए.

पैरामीटर

  • scannerHandle

    स्ट्रिंग

    यह पैरामीटर, खुले हुए स्कैनर के हैंडल के बारे में बताता है. यह हैंडल, openScanner को कॉल करने पर पहले ही मिल चुका होता है.

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं है

    callback पैरामीटर ऐसा दिखता है: 

    (response: CloseScannerResponse) => void

रिटर्न

  • यह एक प्रॉमिस दिखाता है, जो नतीजे के साथ रिज़ॉल्व होता है.

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म को कॉलबैक का इस्तेमाल करना होगा.

getOptionGroups()

Promise Chrome 125 या इसके बाद के वर्शन 
chrome.documentScan.getOptionGroups(
  scannerHandle: string,
  callback?: function,
): Promise<GetOptionGroupsResponse>

यह फ़ंक्शन, openScanner से पहले खोले गए स्कैनर से ग्रुप के नाम और सदस्य के विकल्प पाता है. यह तरीका, एक प्रॉमिस दिखाता है. यह प्रॉमिस, GetOptionGroupsResponse ऑब्जेक्ट के साथ रिज़ॉल्व होता है. अगर इस फ़ंक्शन को कोई कॉलबैक पास किया जाता है, तो लौटाया गया डेटा उसे पास कर दिया जाता है.

पैरामीटर

  • scannerHandle

    स्ट्रिंग

    यह openScanner को कॉल करने पर, खुले हुए स्कैनर का हैंडल दिखाता है.

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं है

    callback पैरामीटर ऐसा दिखता है: 

    (response: GetOptionGroupsResponse) => void

रिटर्न

  • यह एक प्रॉमिस दिखाता है, जो नतीजे के साथ रिज़ॉल्व होता है.

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म को कॉलबैक का इस्तेमाल करना होगा.

getScannerList()

Promise Chrome 125 या इसके बाद के वर्शन 
chrome.documentScan.getScannerList(
  filter: DeviceFilter,
  callback?: function,
): Promise<GetScannerListResponse>

यह उपलब्ध स्कैनर की सूची दिखाता है. साथ ही, एक ऐसा प्रॉमिस दिखाता है जो GetScannerListResponse ऑब्जेक्ट के साथ रिज़ॉल्व होता है. अगर इस फ़ंक्शन को कोई कॉलबैक पास किया जाता है, तो लौटाया गया डेटा उसे पास कर दिया जाता है.

पैरामीटर

  • फ़िल्टर

    DeviceFilter

    DeviceFilter से पता चलता है कि किस तरह के स्कैनर को वापस भेजना चाहिए.

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं है

    callback पैरामीटर ऐसा दिखता है: 

    (response: GetScannerListResponse) => void

रिटर्न

  • यह एक प्रॉमिस दिखाता है, जो नतीजे और स्कैनर की सूची के साथ हल होता है.

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म को कॉलबैक का इस्तेमाल करना होगा.

openScanner()

Promise Chrome 125 या इसके बाद के वर्शन 
chrome.documentScan.openScanner(
  scannerId: string,
  callback?: function,
): Promise<OpenScannerResponse>

यह खास ऐक्सेस के लिए स्कैनर खोलता है. साथ ही, एक ऐसा Promise दिखाता है जो OpenScannerResponse ऑब्जेक्ट के साथ रिज़ॉल्व होता है. अगर इस फ़ंक्शन को कोई कॉलबैक पास किया जाता है, तो लौटाया गया डेटा उसे पास कर दिया जाता है.

पैरामीटर

  • scannerId

    स्ट्रिंग

    उस स्कैनर का आईडी जिसे खोलना है. यह वैल्यू, getScannerList को किए गए पिछले कॉल से मिली है.

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं है

    callback पैरामीटर ऐसा दिखता है: 

    (response: OpenScannerResponse) => void

रिटर्न

  • यह एक प्रॉमिस दिखाता है, जो नतीजे के साथ रिज़ॉल्व होता है.

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म को कॉलबैक का इस्तेमाल करना होगा.

readScanData()

Promise Chrome 125 या इसके बाद के वर्शन 
chrome.documentScan.readScanData(
  job: string,
  callback?: function,
): Promise<ReadScanDataResponse>

यह फ़ंक्शन, चालू जॉब हैंडल से उपलब्ध इमेज डेटा का अगला हिस्सा पढ़ता है. साथ ही, यह एक प्रॉमिस दिखाता है, जो ReadScanDataResponse ऑब्जेक्ट के साथ रिज़ॉल्व होता है. अगर किसी कॉलबैक का इस्तेमाल किया जाता है, तो ऑब्जेक्ट को इसके बजाय पास किया जाता है.

**ध्यान दें:**जवाब के तौर पर मिले नतीजे में SUCCESS, शून्य लंबाई वाला data सदस्य मौजूद हो सकता है. इसका मतलब है कि स्कैनर अब भी काम कर रहा है, लेकिन उसके पास अब तक अतिरिक्त डेटा तैयार नहीं है. कॉल करने वाले व्यक्ति को कुछ देर इंतज़ार करना चाहिए और फिर से कोशिश करनी चाहिए.

स्कैनिंग की प्रोसेस पूरी होने के बाद, जवाब में EOF की वैल्यू दिखेगी. इस रिस्पॉन्स में, आखिर में data सदस्य के तौर पर कोई नॉन-ज़ीरो वैल्यू हो सकती है.

पैरामीटर

  • नौकरी

    स्ट्रिंग

    startScan से पहले मिला हुआ ऐक्टिव जॉब हैंडल.

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं है

    callback पैरामीटर ऐसा दिखता है: 

    (response: ReadScanDataResponse) => void

रिटर्न

  • यह एक प्रॉमिस दिखाता है, जो नतीजे के साथ रिज़ॉल्व होता है.

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म को कॉलबैक का इस्तेमाल करना होगा.

scan()

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

यह दस्तावेज़ को स्कैन करता है और एक प्रॉमिस दिखाता है. यह प्रॉमिस, ScanResults ऑब्जेक्ट के साथ रिज़ॉल्व होता है. अगर इस फ़ंक्शन को कोई कॉलबैक पास किया जाता है, तो लौटाया गया डेटा उसे पास कर दिया जाता है.

पैरामीटर

  • विकल्प

    ScanOptions

    यह स्कैन पैरामीटर वाला ऑब्जेक्ट होता है.

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं है

    callback पैरामीटर ऐसा दिखता है: 

    (result: ScanResults) => void

रिटर्न

  • Promise<ScanResults>

    Chrome 96 और इसके बाद के वर्शन

    यह एक प्रॉमिस दिखाता है, जो स्कैन के नतीजों के साथ रिज़ॉल्व होता है.

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म को कॉलबैक का इस्तेमाल करना होगा.

setOptions()

Promise Chrome 125 या इसके बाद के वर्शन 
chrome.documentScan.setOptions(
  scannerHandle: string,
  options: OptionSetting[],
  callback?: function,
): Promise<SetOptionsResponse>

यह फ़ंक्शन, तय किए गए स्कैनर पर विकल्प सेट करता है. साथ ही, एक प्रॉमिस दिखाता है. यह प्रॉमिस, SetOptionsResponse ऑब्जेक्ट के साथ रिज़ॉल्व होता है. इस ऑब्जेक्ट में, पास किए गए OptionSetting ऑब्जेक्ट के क्रम में हर वैल्यू को सेट करने की कोशिश का नतीजा होता है. अगर किसी कॉलबैक का इस्तेमाल किया जाता है, तो ऑब्जेक्ट को इसके बजाय पास किया जाता है.

पैरामीटर

  • scannerHandle

    स्ट्रिंग

    स्कैनर का हैंडल, जिस पर विकल्प सेट किए जाते हैं. यह ऐसी वैल्यू होनी चाहिए जो पहले openScanner को कॉल करने पर मिली हो.

  • विकल्प

    OptionSetting[]

    OptionSetting ऑब्जेक्ट की सूची, जिसे स्कैनर पर लागू किया जाना है.

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं है

    callback पैरामीटर ऐसा दिखता है: 

    (response: SetOptionsResponse) => void

रिटर्न

  • यह एक प्रॉमिस दिखाता है, जो नतीजे के साथ रिज़ॉल्व होता है.

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म को कॉलबैक का इस्तेमाल करना होगा.

startScan()

Promise Chrome 125 या इसके बाद के वर्शन 
chrome.documentScan.startScan(
  scannerHandle: string,
  options: StartScanOptions,
  callback?: function,
): Promise<StartScanResponse>

यह फ़ंक्शन, तय किए गए स्कैनर पर स्कैन शुरू करता है. साथ ही, यह एक प्रॉमिस दिखाता है, जो StartScanResponse के साथ रिज़ॉल्व होता है. अगर किसी कॉलबैक का इस्तेमाल किया जाता है, तो ऑब्जेक्ट को इसके बजाय पास किया जाता है. अगर कॉल पूरा हो जाता है, तो जवाब में एक जॉब हैंडल शामिल होता है. इसका इस्तेमाल, स्कैन किए गए डेटा को पढ़ने या स्कैन को रद्द करने के लिए किया जा सकता है.

पैरामीटर

  • scannerHandle

    स्ट्रिंग

    खुले हुए स्कैनर का हैंडल. यह ऐसी वैल्यू होनी चाहिए जो पहले openScanner को कॉल करने पर मिली हो.

  • विकल्प

    StartScanOptions

    StartScanOptions ऑब्जेक्ट, स्कैन के लिए इस्तेमाल किए जाने वाले विकल्पों के बारे में बताता है. StartScanOptions.format प्रॉपर्टी की वैल्यू, स्कैनर के ScannerInfo में दिखाई गई किसी एक वैल्यू से मेल खानी चाहिए.

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं है

    callback पैरामीटर ऐसा दिखता है: 

    (response: StartScanResponse) => void

रिटर्न

  • यह एक प्रॉमिस दिखाता है, जो नतीजे के साथ रिज़ॉल्व होता है.

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म को कॉलबैक का इस्तेमाल करना होगा.