chrome.fileSystem

ब्यौरा

उपयोगकर्ता के लोकल फ़ाइल सिस्टम को बनाने, पढ़ने, नेविगेट करने, और उसमें लिखने के लिए, chrome.fileSystem एपीआई का इस्तेमाल करें. इस एपीआई की मदद से, Chrome ऐप्लिकेशन उपयोगकर्ता की चुनी गई जगह पर मौजूद कॉन्टेंट को पढ़ सकता है और उसमें बदलाव कर सकता है. उदाहरण के लिए, टेक्स्ट एडिटर ऐप्लिकेशन, लोकल दस्तावेज़ों को पढ़ने और उनमें बदलाव करने के लिए एपीआई का इस्तेमाल कर सकता है. सभी गड़बड़ियों की सूचना chrome.runtime.lastError की मदद से दी जाती है.

अनुमतियां

fileSystem

उपलब्धता

सिर्फ़ फ़ोरग्राउंड

टाइप

AcceptOption

प्रॉपर्टी

  • ब्यौरा

    स्ट्रिंग ज़रूरी नहीं

    यह इस विकल्प के लिए वैकल्पिक टेक्स्ट ब्यौरा है. अगर यह मौजूद नहीं है, तो ब्यौरा अपने-आप जनरेट हो जाएगा; आम तौर पर, इसमें मान्य एक्सटेंशन की बड़ी सूची होती है (जैसे कि "text/html", "*.html, *.htm" तक बड़ा हो सकता है).

  • एक्सटेंशन

    स्ट्रिंग[] ज़रूरी नहीं

    स्वीकार किए जाने वाले एक्सटेंशन, जैसे कि "jpg", "gif", "crx" शामिल होना चाहिए.

  • mimeTypes

    स्ट्रिंग[] ज़रूरी नहीं

    स्वीकार किए जाने वाले Mime-टाइप, जैसे कि "image/jpeg" या "ऑडियो/*". mimeTypes या एक्सटेंशन में से एक में कम से कम एक मान्य एलीमेंट होना चाहिए.

ChooseEntryOptions

प्रॉपर्टी

  • स्वीकार करता है

    AcceptOption[] वैकल्पिक

    इस फ़ाइल ओपनर के लिए, स्वीकार करने के विकल्पों की वैकल्पिक सूची. हर विकल्प, असली उपयोगकर्ता को एक यूनीक ग्रुप के तौर पर दिखाया जाएगा.

  • acceptsAllTypes

    बूलियन ज़रूरी नहीं

    स्वीकार करने के तर्क में दिए गए विकल्पों के अलावा, सभी फ़ाइल टाइप को स्वीकार करना है या नहीं. डिफ़ॉल्ट रूप से, 'सही' होता है. अगर स्वीकार किया जाने वाला फ़ील्ड सेट नहीं है या उसमें कोई मान्य एंट्री नहीं है, तो इसे हमेशा 'सही' पर रीसेट कर दिया जाएगा.

  • acceptsMultiple

    बूलियन ज़रूरी नहीं

    क्या एक से ज़्यादा फ़ाइलों को स्वीकार करना है. यह सिर्फ़ OpenFile और OpenWritableFile पर काम करता है. अगर इसे 'सही' पर सेट किया जाता है, तो SelectEntry के लिए कॉलबैक को एंट्री की सूची के साथ कॉल किया जाएगा. अगर ऐसा नहीं है, तो इसे एक ही एंट्री से कॉल किया जाएगा.

  • suggestedName

    स्ट्रिंग ज़रूरी नहीं

    सुझाया गया फ़ाइल नाम, जो उपयोगकर्ता को पढ़ने या लिखने के लिए डिफ़ॉल्ट नाम के रूप में दिखाया जाएगा. हालांकि, ऐसा करना ज़रूरी नहीं है.

  • टाइप

    ChooseEntryType ज़रूरी नहीं

    दिखाने के लिए प्रॉम्प्ट का टाइप. डिफ़ॉल्ट 'openFile' होती है.

ChooseEntryType

Enum

"openFile"
उपयोगकर्ता को कोई मौजूदा फ़ाइल खोलने का निर्देश देता है और सही फ़ाइल होने पर FileEntry दिखाता है. Chrome 31 और उसके बाद के वर्शन में, अगर ऐप्लिकेशन में 'लिखें' फ़ाइल मौजूद है, तो FileEntry में लिखा जा सकता है 'fileSystem' के तहत अनुमति; ऐसा न होने पर, FileEntry को सिर्फ़ पढ़ा जा सकता है.

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

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

"openDirectory"
उपयोगकर्ता को कोई डायरेक्ट्री खोलने का निर्देश देता है और सही डायरेक्ट्री एंट्री मिलने पर डायरेक्ट्री एंट्री दिखाता है. अगर ऐप्लिकेशन में 'डायरेक्ट्री' नहीं है, तो इस तरह का इस्तेमाल करने वाले कॉल, रनटाइम की गड़बड़ी के साथ विफल हो जाएंगे 'fileSystem' के तहत अनुमति दें. यदि ऐप्लिकेशन में 'लिखें' है 'fileSystem' के तहत अनुमति का इस्तेमाल न किया हो, तो लौटाए गए DirectoryEntry में लिखा जा सकता है; अगर ऐसा नहीं है, तो इसे सिर्फ़ पढ़ा जा सकता है. Chrome 31 में नया.

RequestFileSystemOptions

Chrome 44 और उसके बाद वाले वर्शन के लिए

प्रॉपर्टी

  • volumeId

    स्ट्रिंग

    अनुरोध किए गए वॉल्यूम का आईडी.

  • लिखा जा सकता है

    बूलियन ज़रूरी नहीं

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

Volume

Chrome 44 और उसके बाद वाले वर्शन के लिए

प्रॉपर्टी

  • volumeId

    स्ट्रिंग

  • लिखा जा सकता है

    बूलियन

VolumeListChangedEvent

Chrome 44 और उसके बाद वाले वर्शन के लिए

प्रॉपर्टी

तरीके

chooseEntry()

chrome.fileSystem.chooseEntry(
  options?: ChooseEntryOptions,
  callback: function,
)

उपयोगकर्ता को कोई फ़ाइल या डायरेक्ट्री चुनने के लिए कहें.

पैरामीटर

  • विकल्प

    ChooseEntryOptions ज़रूरी नहीं

  • कॉलबैक

    फ़ंक्शन

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

    (entry?: Entry, fileEntries?: FileEntry[]) => void

    • एंट्री

      एंट्री ज़रूरी नहीं

    • fileEntries

      FileEntry[] ज़रूरी नहीं

getDisplayPath()

प्रॉमिस 
chrome.fileSystem.getDisplayPath(
  entry: Entry,
  callback?: function,
)

किसी एंट्री ऑब्जेक्ट का डिसप्ले पाथ पाएं. डिसप्ले पाथ, लोकल फ़ाइल सिस्टम के फ़ाइल या डायरेक्ट्री के पूरे पाथ पर आधारित होता है. हालांकि, इसे दिखाने के मकसद से इसे पढ़ने लायक बनाया जा सकता है.

पैरामीटर

  • एंट्री

    प्रवेश

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

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

    (displayPath: string) => void

    • displayPath

      स्ट्रिंग

रिटर्न

  • प्रॉमिस<string>

    Chrome 117 और उसके बाद वाले वर्शन

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

getVolumeList()

प्रॉमिस Chrome 44 और उसके बाद वाले वर्शन के लिए 
chrome.fileSystem.getVolumeList(
  callback?: function,
)

यह फ़ंक्शन requestFileSystem() के लिए उपलब्ध वॉल्यूम की सूची दिखाता है. "fileSystem": {"requestFileSystem"} मेनिफ़ेस्ट की अनुमति ज़रूरी है. यह सुविधा सिर्फ़ कीऑस्क सेशन में चल रहे कीऑस्क ऐप्लिकेशन के लिए उपलब्ध है. किसी गड़बड़ी की स्थिति में, volumes को तय नहीं किया जाएगा और chrome.runtime.lastError को सेट किया जाएगा.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

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

    (volumes?: Volume[]) => void

रिटर्न

  • Promise&lt;Volume[] | तय नहीं है>

    Chrome 117 और उसके बाद वाले वर्शन

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

getWritableEntry()

chrome.fileSystem.getWritableEntry(
  entry: Entry,
  callback: function,
)

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

पैरामीटर

  • एंट्री

    प्रवेश

  • कॉलबैक

    फ़ंक्शन

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

    (entry: Entry) => void

    • एंट्री

      प्रवेश

isRestorable()

प्रॉमिस 
chrome.fileSystem.isRestorable(
  id: string,
  callback?: function,
)

यह जानकारी देता है कि ऐप्लिकेशन को दिए गए आईडी से, एंट्री को वापस लाने की अनुमति है या नहीं.

पैरामीटर

  • आईडी

    स्ट्रिंग

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

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

    (isRestorable: boolean) => void

    • isRestorable

      बूलियन

रिटर्न

  • Promise&lt;boolean&gt;

    Chrome 117 और उसके बाद वाले वर्शन

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

isWritableEntry()

प्रॉमिस 
chrome.fileSystem.isWritableEntry(
  entry: Entry,
  callback?: function,
)

यह पता लगाया जाता है कि इस एंट्री में लिखा जा सकता है या नहीं.

पैरामीटर

  • एंट्री

    प्रवेश

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

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

    (isWritable: boolean) => void

    • isWritable

      बूलियन

रिटर्न

  • Promise&lt;boolean&gt;

    Chrome 117 और उसके बाद वाले वर्शन

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

requestFileSystem()

प्रॉमिस Chrome 44 और उसके बाद वाले वर्शन के लिए 
chrome.fileSystem.requestFileSystem(
  options: RequestFileSystemOptions,
  callback?: function,
)

उस वॉल्यूम के लिए, फ़ाइल सिस्टम के ऐक्सेस का अनुरोध करता है जिसे options.volumeId दिखाता है. अगर options.writable को 'सही है' पर सेट किया गया है, तो फ़ाइल सिस्टम में लिखा जाएगा. अगर ऐसा नहीं है, तो इसे सिर्फ़ पढ़ा जा सकता है. writable विकल्प के लिए, मेनिफ़ेस्ट में "fileSystem": {"write"} अनुमति की ज़रूरत होती है. यह सुविधा सिर्फ़ कीऑस्क सेशन में चल रहे कीऑस्क ऐप्लिकेशन के लिए उपलब्ध है. मैन्युअल-लॉन्च कीऑस्क मोड के लिए, चालू ऐप्लिकेशन विंडो के ऊपर पुष्टि करने वाला डायलॉग दिखेगा. किसी गड़बड़ी की स्थिति में, fileSystem को तय नहीं किया जाएगा और chrome.runtime.lastError को सेट किया जाएगा.

पैरामीटर

  • विकल्प

    RequestFileSystemOptions

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

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

    (fileSystem?: FileSystem) => void

    • fileSystem

      FileSystem ज़रूरी नहीं

रिटर्न

  • Promise&lt;FileSystem | तय नहीं है>

    Chrome 117 और उसके बाद वाले वर्शन

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

restoreEntry()

chrome.fileSystem.restoreEntry(
  id: string,
  callback: function,
)

दिए गए आईडी से जुड़ी फ़ाइल की एंट्री, वापस पाने के लिए उसे दिखाता है. ऐसा न होने पर, रनटाइम की गड़बड़ी होने पर यह कॉल फ़ेल हो जाएगा.

पैरामीटर

  • आईडी

    स्ट्रिंग

  • कॉलबैक

    फ़ंक्शन

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

    (entry: Entry) => void

    • एंट्री

      प्रवेश

retainEntry()

chrome.fileSystem.retainEntry(
  entry: Entry,
)

वह आईडी देता है जिसे किसी दी गई फ़ाइल एंट्री का ऐक्सेस वापस पाने के लिए, reCAPTCHA को वापस भेजने के लिए पास किया जा सकता है. सबसे हाल ही में इस्तेमाल की गई सिर्फ़ 500 एंट्री को सेव रखा जाता है. इनमें से एंट्री को बनाए रखने और वापस लाने के लिए किए गए कॉल को इस्तेमाल के तौर पर गिना जाता है. अगर ऐप्लिकेशन में 'retainEntries' है अनुमति 'fileSystem' के तहत, एंट्री अनिश्चित समय तक रखी जाती हैं. ऐसा नहीं होने पर, एंट्री सिर्फ़ तब सेव रखी जाती हैं, जब ऐप्लिकेशन चालू हो और रीस्टार्ट हो.

पैरामीटर

  • एंट्री

    प्रवेश

रिटर्न

  • स्ट्रिंग

इवेंट

onVolumeListChanged

Chrome 44 और उसके बाद वाले वर्शन के लिए 
chrome.fileSystem.onVolumeListChanged.addListener(
  callback: function,
)

इसे तब कॉल किया जाता है, जब उपलब्ध वॉल्यूम की सूची में बदलाव किया जाता है.

पैरामीटर