chrome.gcm

ब्यौरा

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

अनुमतियां

gcm

प्रॉपर्टी

MAX_MESSAGE_SIZE

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

मान

4096

तरीके

register()

प्रॉमिस 
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
)

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

पैरामीटर

  • senderIds

    स्ट्रिंग[]

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

  • कॉलबैक

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

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

    (registrationId: string) => void

    • registrationId

      स्ट्रिंग

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

रिटर्न

  • प्रॉमिस<string>

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

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

send()

प्रॉमिस 
chrome.gcm.send(
  message: object,
  callback?: function,
)

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

पैरामीटर

  • मैसेज

    ऑब्जेक्ट

    FCM के ज़रिए दूसरे पक्ष को भेजने के लिए मैसेज.

    • डेटा

      ऑब्जेक्ट

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

    • destinationId

      स्ट्रिंग

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

    • messageId

      स्ट्रिंग

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

    • timeToLive

      नंबर वैकल्पिक

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

  • कॉलबैक

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

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

    (messageId: string) => void

    • messageId

      स्ट्रिंग

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

रिटर्न

  • प्रॉमिस<string>

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

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

unregister()

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

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

पैरामीटर

  • कॉलबैक

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

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

    () => void

रिटर्न

  • प्रॉमिस<void>

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

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

इवेंट

onMessage

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

FCM से मैसेज मिलने पर ट्रिगर होता है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (message: object) => void

    • मैसेज

      ऑब्जेक्ट

onMessagesDeleted

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

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

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    () => void

onSendError

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

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

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (error: object) => void

    • गड़बड़ी

      ऑब्जेक्ट

      • विवरण

        ऑब्जेक्ट

        गड़बड़ी के बारे में ज़्यादा जानकारी (उपलब्ध होने पर).

      • errorMessage

        स्ट्रिंग

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

      • messageId

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

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