browser.gcm

ब्यौरा

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

अनुमतियां

gcm

प्रॉपर्टी

MAX_MESSAGE_SIZE

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

वैल्यू

4096

तरीके

register()

browser.gcm.register(
  senderIds: string[],
): Promise<string>

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

पैरामीटर

• senderIds

  string[]

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

रिटर्न

• Promise<string>

  Chrome 116+ browser.* Chrome 148 से

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

send()

browser.gcm.send(
  message: object,
): Promise<string>

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

पैरामीटर

• मैसेज

  ऑब्जेक्ट

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

  • डेटा

    ऑब्जेक्ट

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

  • destinationId

    स्ट्रिंग

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

  • messageId

    स्ट्रिंग

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

  • timeToLive

    number ज़रूरी नहीं

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

रिटर्न

• Promise<string>

  Chrome 116+ browser.* Chrome 148 से

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

unregister()

browser.gcm.unregister(): Promise<void>

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

रिटर्न

• वादा<शून्य>

  Chrome 116+ browser.* Chrome 148 से

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

इवेंट

onMessage

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

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

पैरामीटर

• कॉलबैक

  फ़ंक्शन

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

  (message: object) => void

  • मैसेज

    ऑब्जेक्ट

    • collapseKey

      string ज़रूरी नहीं

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

    • डेटा

      ऑब्जेक्ट

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

    • से

      string ज़रूरी नहीं

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

onMessagesDeleted

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

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

पैरामीटर

• कॉलबैक

  फ़ंक्शन

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

  () => void

onSendError

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

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

पैरामीटर

• कॉलबैक

  फ़ंक्शन

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

  (error: object) => void

  • गड़बड़ी

    ऑब्जेक्ट

    • विवरण

      ऑब्जेक्ट

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

    • errorMessage

      स्ट्रिंग

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

    • messageId

      string ज़रूरी नहीं

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