chrome.gcm

refresh date: 2026-09-25 robots: noindex

ब्यौरा

chrome.gcm का इस्तेमाल करके, ऐप्लिकेशन और एक्सटेंशन को Firebase Cloud Messaging (FCM) के ज़रिए मैसेज भेजने और पाने की अनुमति दें.

अनुमतियां

gcm

प्रॉपर्टी

MAX_MESSAGE_SIZE

किसी मैसेज में मौजूद सभी की/वैल्यू पेयर का ज़्यादा से ज़्यादा साइज़ (बाइट में).

वैल्यू

4096

तरीके

register()

Promise 
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
): Promise<string>

यह कुकी, ऐप्लिकेशन को FCM के साथ रजिस्टर करती है. रजिस्ट्रेशन आईडी, callback से मिलेगा. अगर senderIds की उसी सूची के साथ register को फिर से कॉल किया जाता है, तो वही रजिस्ट्रेशन आईडी वापस मिलेगा.

पैरामीटर

  • senderIds

    string[]

    उन सर्वर आईडी की सूची जिन्हें ऐप्लिकेशन को मैसेज भेजने की अनुमति है. इसमें कम से कम एक और ज़्यादा से ज़्यादा 100 भेजने वाले के आईडी होने चाहिए.

  • कॉलबैक

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

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

    (registrationId: string) => void

    • registrationId

      स्ट्रिंग

      यह एक रजिस्ट्रेशन आईडी है, जिसे FCM ने ऐप्लिकेशन को असाइन किया है.

रिटर्न

  • Promise<string>

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

    रजिस्ट्रेशन पूरा होने पर यह रिज़ॉल्व हो जाता है.

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

send()

Promise 
chrome.gcm.send(
  message: object,
  callback?: function,
): Promise<string>

इससे मैसेज को उसके कॉन्टेंट के हिसाब से भेजा जाता है.

पैरामीटर

  • मैसेज

    ऑब्जेक्ट

    FCM के ज़रिए, दूसरी पार्टी को भेजा जाने वाला मैसेज.

    • डेटा

      ऑब्जेक्ट

      सर्वर को भेजने के लिए मैसेज डेटा. केस-इनसेंसिटिव goog. और google के साथ-साथ केस-सेंसिटिव collapse_key को मुख्य प्रीफ़िक्स के तौर पर इस्तेमाल करने की अनुमति नहीं है. सभी की/वैल्यू पेयर का योग gcm.MAX_MESSAGE_SIZE से ज़्यादा नहीं होना चाहिए.

    • destinationId

      स्ट्रिंग

      यह उस सर्वर का आईडी होता है जिस पर मैसेज भेजना है. इसे Google API Console असाइन करता है.

    • messageId

      स्ट्रिंग

      ईमेल का आईडी. यह ऐप्लिकेशन के दायरे में आने वाले हर मैसेज के लिए यूनीक होना चाहिए. आईडी चुनने और उसे मैनेज करने के बारे में सलाह पाने के लिए, Cloud Messaging का दस्तावेज़ देखें.

    • timeToLive

      number optional

      मैसेज का टाइम-टू-लीव (सेकंड में). अगर उस समय में मैसेज नहीं भेजा जा सकता, तो onSendError इवेंट ट्रिगर होगा. टाइम-टू-लाइव की वैल्यू 0 होने का मतलब है कि मैसेज को तुरंत भेजा जाना चाहिए. अगर ऐसा नहीं हो पाता है, तो मैसेज नहीं भेजा जाना चाहिए. टाइम-टू-लिव की डिफ़ॉल्ट वैल्यू 86,400 सेकंड (एक दिन) होती है. इसकी ज़्यादा से ज़्यादा वैल्यू 24,19,200 सेकंड (28 दिन) होती है.

  • कॉलबैक

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

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

    (messageId: string) => void

    • messageId

      स्ट्रिंग

      उस मैसेज का आईडी जिसके लिए कॉलबैक जारी किया गया था.

रिटर्न

  • Promise<string>

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

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

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

unregister()

Promise 
chrome.gcm.unregister(
  callback?: function,
): Promise<void>

यह ऐप्लिकेशन को FCM से अनरजिस्टर करता है.

पैरामीटर

  • कॉलबैक

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

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

    () => void

रिटर्न

  • Promise<void>

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

    यह अनरजिस्टर करने की प्रोसेस पूरी होने के बाद ठीक हो जाता है. अगर प्रॉमिस अस्वीकार नहीं होता है, तो रजिस्ट्रेशन रद्द कर दिया जाता है.

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

इवेंट

onMessage

chrome.gcm.onMessage.addListener(
  callback: function,
)

यह इवेंट तब ट्रिगर होता है, जब FCM के ज़रिए कोई मैसेज मिलता है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (message: object) => void

    • मैसेज

      ऑब्जेक्ट

      • collapseKey

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

        मैसेज को छोटा करने की कुंजी. ज़्यादा जानकारी के लिए, छोटे और बड़े किए जा सकने वाले मैसेज देखें.

      • डेटा

        ऑब्जेक्ट

        मैसेज का डेटा.

      • से

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

        मैसेज भेजने वाला व्यक्ति.

onMessagesDeleted

chrome.gcm.onMessagesDeleted.addListener(
  callback: function,
)

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

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    () => void

onSendError

chrome.gcm.onSendError.addListener(
  callback: function,
)

यह इवेंट तब ट्रिगर होता है, जब FCM सर्वर को मैसेज नहीं भेजा जा सकता.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (error: object) => void

    • गड़बड़ी

      ऑब्जेक्ट

      • ब्यौरा

        ऑब्जेक्ट

        गड़बड़ी से जुड़ी अतिरिक्त जानकारी, अगर उपलब्ध हो.

      • errorMessage

        स्ट्रिंग

        समस्या के बारे में बताने वाला गड़बड़ी का मैसेज.

      • messageId

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

        अगर गड़बड़ी किसी मैसेज से जुड़ी है, तो इस गड़बड़ी वाले मैसेज का आईडी.