chrome.extension

ब्यौरा

chrome.extension एपीआई में ऐसी सुविधाएं हैं जिनका इस्तेमाल किसी भी एक्सटेंशन पेज से किया जा सकता है. इसमें, किसी एक्सटेंशन और उसकी कॉन्टेंट स्क्रिप्ट या एक्सटेंशन के बीच मैसेज एक्सचेंज करने की सुविधा शामिल है. इस बारे में ज़्यादा जानकारी मैसेज पासिंग में दी गई है.

टाइप

ViewType

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

एक्सटेंशन व्यू का टाइप.

Enum

"tab"

"popup"

प्रॉपर्टी

inIncognitoContext

गुप्त टैब में चल रही कॉन्टेंट स्क्रिप्ट और गुप्त प्रोसेस में चल रहे एक्सटेंशन पेजों के लिए True. यह सिर्फ़ उन एक्सटेंशन पर लागू होता है जिनमें incognito_behavior की वैल्यू 'split' है.

टाइप

बूलियन

lastError

≤ MV2 Chrome 58 से अमान्य

कृपया runtime.lastError का इस्तेमाल करें.

अगर किसी असींक्रोनस एक्सटेंशन एपीआई की वजह से गड़बड़ी हुई है, तो कॉलबैक के लाइफ़टाइम के लिए सेट करें. अगर कोई गड़बड़ी नहीं हुई है, तो lastError की वैल्यू undefined होगी.

टाइप

ऑब्जेक्ट

प्रॉपर्टी

  • मैसेज

    स्ट्रिंग

    हुई गड़बड़ी के बारे में जानकारी.

तरीके

getBackgroundPage()

सिर्फ़ फ़ोरग्राउंड ऐप्लिकेशन के लिए 
chrome.extension.getBackgroundPage()

मौजूदा एक्सटेंशन में चल रहे बैकग्राउंड पेज के लिए, JavaScript 'window' ऑब्जेक्ट दिखाता है. अगर एक्सटेंशन में कोई बैकग्राउंड पेज नहीं है, तो यह फ़ंक्शन null दिखाता है.

रिटर्न

  • विंडो | undefined

getExtensionTabs()

≤ MV2 सिर्फ़ फ़ोरग्राउंड अब काम नहीं करता
chrome.extension.getExtensionTabs(
  windowId?: number,
)

कृपया extension.getViews {type: "tab"} का इस्तेमाल करें.

यह मौजूदा एक्सटेंशन में चल रहे हर टैब के लिए, JavaScript 'window' ऑब्जेक्ट का ऐरे दिखाता है. अगर windowId तय किया गया है, तो यह फ़ंक्शन सिर्फ़ उस विंडो से जुड़े टैब के 'window' ऑब्जेक्ट दिखाता है.

पैरामीटर

  • windowId

    number ज़रूरी नहीं

रिटर्न

  • Window[]

    ग्लोबल विंडो ऑब्जेक्ट का कलेक्शन

getURL()

≤ MV2 Chrome 58 से अमान्य
chrome.extension.getURL(
  path: string,
)

कृपया runtime.getURL का इस्तेमाल करें.

एक्सटेंशन इंस्टॉल डायरेक्ट्री में मौजूद रिलेटिव पाथ को पूरी तरह सही यूआरएल में बदलता है.

पैरामीटर

  • पाथ

    स्ट्रिंग

    किसी एक्सटेंशन में मौजूद रिसॉर्स का पाथ, जो उसकी इंस्टॉल डायरेक्ट्री के हिसाब से दिया जाता है.

रिटर्न

  • स्ट्रिंग

    रिसॉर्स का पूरा यूआरएल.

getViews()

सिर्फ़ फ़ोरग्राउंड ऐप्लिकेशन के लिए 
chrome.extension.getViews(
  fetchProperties?: object,
)

यह मौजूदा एक्सटेंशन में चल रहे हर पेज के लिए, JavaScript 'window' ऑब्जेक्ट का ऐरे दिखाता है.

पैरामीटर

  • fetchProperties

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

    • tabId

      number ज़रूरी नहीं

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

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

    • टाइप

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

      आपको किस तरह का व्यू चाहिए. अगर इस विकल्प को शामिल नहीं किया जाता है, तो सभी व्यू दिखते हैं. इनमें बैकग्राउंड पेज और टैब भी शामिल हैं.

    • windowId

      number ज़रूरी नहीं

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

रिटर्न

  • Window[]

    ग्लोबल ऑब्जेक्ट का कलेक्शन

isAllowedFileSchemeAccess()

वादा करना 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)

'file://' स्कीम के लिए, एक्सटेंशन के ऐक्सेस की स्थिति दिखाता है. यह सेटिंग, हर एक्सटेंशन के लिए उपयोगकर्ता के कंट्रोल वाली 'फ़ाइल के यूआरएल को ऐक्सेस करने की अनुमति दें' सेटिंग से जुड़ी होती है. इस सेटिंग को chrome://extensions पेज से ऐक्सेस किया जा सकता है.

पैरामीटर

  • कॉलबैक

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

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

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      बूलियन

      अगर एक्सटेंशन 'file://' स्कीम को ऐक्सेस कर सकता है, तो True. अगर नहीं, तो False.

रिटर्न

  • Promise<boolean>

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

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और उसके बाद के वर्शन के साथ काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

isAllowedIncognitoAccess()

वादा करना 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
)

गुप्त मोड में एक्सटेंशन के ऐक्सेस की स्थिति दिखाता है. यह हर एक्सटेंशन के लिए, उपयोगकर्ता के कंट्रोल वाली 'गुप्त मोड में इस्तेमाल करने की अनुमति है' सेटिंग से जुड़ी होती है. इस सेटिंग को chrome://extensions पेज पर जाकर ऐक्सेस किया जा सकता है.

पैरामीटर

  • कॉलबैक

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

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

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      बूलियन

      अगर एक्सटेंशन के पास गुप्त मोड का ऐक्सेस है, तो 'सही'. अगर नहीं है, तो 'गलत'.

रिटर्न

  • Promise<boolean>

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

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और उसके बाद के वर्शन के साथ काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

sendRequest()

Promise &leq; MV2 अब सेवा में नहीं है
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
)

कृपया runtime.sendMessage का इस्तेमाल करें.

एक्सटेंशन में मौजूद दूसरे लिसनर को एक अनुरोध भेजता है. यह runtime.connect से मिलता-जुलता है, लेकिन इसमें सिर्फ़ एक अनुरोध भेजा जाता है. साथ ही, जवाब देना ज़रूरी नहीं है. extension.onRequest इवेंट, एक्सटेंशन के हर पेज पर ट्रिगर होता है.

पैरामीटर

  • extensionId

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

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

  • CANNOT TRANSLATE

    कोई

  • कॉलबैक

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

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

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

    (response: any) => void

    • जवाब

      कोई

      अनुरोध के हैंडलर से भेजा गया JSON रिस्पॉन्स ऑब्जेक्ट. अगर एक्सटेंशन से कनेक्ट करते समय कोई गड़बड़ी होती है, तो कॉलबैक को बिना किसी आर्ग्युमेंट के कॉल किया जाएगा और runtime.lastError को गड़बड़ी के मैसेज पर सेट कर दिया जाएगा.

रिटर्न

  • Promise<any>

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

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और उसके बाद के वर्शन के साथ काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

एक्सटेंशन के अपडेट यूआरएल में इस्तेमाल किए गए ap CGI पैरामीटर की वैल्यू सेट करता है. Chrome एक्सटेंशन गैलरी में होस्ट किए गए एक्सटेंशन के लिए, इस वैल्यू को अनदेखा कर दिया जाता है.

पैरामीटर

  • डेटा

    स्ट्रिंग

इवेंट

onRequest

&leq; MV2 अब काम नहीं करता
chrome.extension.onRequest.addListener(
  callback: function,
)

कृपया runtime.onMessage का इस्तेमाल करें.

यह ट्रिगर तब होता है, जब एक्सटेंशन प्रोसेस या कॉन्टेंट स्क्रिप्ट से कोई अनुरोध भेजा जाता है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (request: any, sender: runtime.MessageSender, sendResponse: function) => void

    • CANNOT TRANSLATE

      कोई

    • ईमेल भेजने वाला

      runtime.MessageSender

    • sendResponse

      फ़ंक्शन

      sendResponse पैरामीटर इस तरह दिखता है: 

      () => void

onRequestExternal

&leq; MV2 अब काम नहीं करता
chrome.extension.onRequestExternal.addListener(
  callback: function,
)

कृपया runtime.onMessageExternal का इस्तेमाल करें.

किसी दूसरे एक्सटेंशन से अनुरोध भेजे जाने पर ट्रिगर होता है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (request: any, sender: runtime.MessageSender, sendResponse: function) => void

    • CANNOT TRANSLATE

      कोई

    • ईमेल भेजने वाला

      runtime.MessageSender

    • sendResponse

      फ़ंक्शन

      sendResponse पैरामीटर इस तरह दिखता है: 

      () => void