chrome.extension

ब्यौरा

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

टाइप

ViewType

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

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

Enum

"tab"

"popup"

प्रॉपर्टी

inIncognitoContext

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

टाइप

बूलियन

lastError

≤ MV2 Chrome 58 से बंद कर दिया गया है

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

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

टाइप

ऑब्जेक्ट

प्रॉपर्टी

  • मैसेज

    स्ट्रिंग

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

तरीके

getBackgroundPage()

सिर्फ़ फ़ोरग्राउंड 
chrome.extension.getBackgroundPage(): Window | undefined

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

रिटर्न

  • विंडो | इसके बारे में जानकारी नहीं है

getExtensionTabs()

≤ MV2 सिर्फ़ फ़ोरग्राउंड अब सेवा में नहीं है
chrome.extension.getExtensionTabs(
  windowId?: number,
): Window[]

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

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

पैरामीटर

  • windowId

    number ज़रूरी नहीं

रिटर्न

  • Window[]

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

getURL()

≤ MV2 Chrome 58 से बंद कर दिया गया है
chrome.extension.getURL(
  path: string,
): string

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

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

पैरामीटर

  • पाथ

    स्ट्रिंग

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

रिटर्न

  • स्ट्रिंग

    संसाधन का पूरी तरह से मान्य यूआरएल.

getViews()

सिर्फ़ फ़ोरग्राउंड 
chrome.extension.getViews(
  fetchProperties?: object,
): Window[]

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

पैरामीटर

  • fetchProperties

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

    • tabId

      number ज़रूरी नहीं

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

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

    • टाइप

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

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

    • windowId

      number ज़रूरी नहीं

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

रिटर्न

  • Window[]

    ग्लोबल ऑब्जेक्ट की कैटगरी

isAllowedFileSchemeAccess()

प्रॉमिस 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
): Promise<boolean>

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

पैरामीटर

  • कॉलबैक

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

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

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      बूलियन

      अगर एक्सटेंशन 'file://' स्कीम को ऐक्सेस कर सकता है, तो वैल्यू 'सही' के तौर पर सेट होगी. ऐसा न होने पर, वैल्यू 'गलत' के तौर पर सेट होगी.

रिटर्न

  • Promise<boolean>

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

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

isAllowedIncognitoAccess()

प्रॉमिस 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
): Promise<boolean>

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

पैरामीटर

  • कॉलबैक

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

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

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      बूलियन

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

रिटर्न

  • Promise<boolean>

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

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

sendRequest()

Promise &leq; MV2 Deprecated
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
): Promise<any>

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

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

पैरामीटर

  • extensionId

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

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

  • CANNOT TRANSLATE

    कोई

  • कॉलबैक

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

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

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

    (response: any) => void

    • जवाब

      कोई

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

रिटर्न

  • Promise<any>

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

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

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
): void

यह कुकी, एक्सटेंशन के अपडेट यूआरएल में इस्तेमाल किए गए 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