chrome.gcm

ब्यौरा

chrome.gcm का इस्तेमाल करके, ऐप्लिकेशन और एक्सटेंशन को Firebase क्लाउड से मैसेज (FCM) के ज़रिए मैसेज भेजने और पाने की सुविधा चालू करें.

अनुमतियां

gcm

प्रॉपर्टी

MAX_MESSAGE_SIZE

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

मान

4096

तरीके

register()

प्रॉमिस 
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 और इसके बाद के वर्शन

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

send()

प्रॉमिस 
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 ज़रूरी नहीं

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

  • कॉलबैक

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

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

    (messageId: string) => void

    • messageId

      स्ट्रिंग

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

रिटर्न

  • Promise<string>

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

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

unregister()

प्रॉमिस 
chrome.gcm.unregister(
  callback?: function,
): Promise<void>

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

पैरामीटर

  • कॉलबैक

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

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

    () => void

रिटर्न

  • Promise<void>

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

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट 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 ज़रूरी नहीं है

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