ब्यौरा
chrome.gcm
का इस्तेमाल करके, ऐप्लिकेशन और एक्सटेंशन को चालू करें, ताकि Firebase क्लाउड से मैसेज (FCM) की मदद से मैसेज भेजे और पाए जा सकें.
अनुमतियां
gcm
प्रॉपर्टी
MAX_MESSAGE_SIZE
किसी मैसेज में सभी कुंजी/वैल्यू पेयर का ज़्यादा से ज़्यादा साइज़ (बाइट में).
वैल्यू
4096
तरीके
register()
chrome.gcm.register(
senderIds: string[],
callback?: function,
)
ऐप्लिकेशन को FCM के साथ रजिस्टर करता है. रजिस्ट्रेशन आईडी, callback
से मिलेगा. अगर senderIds
की उसी सूची के साथ register
को फिर से कॉल किया जाता है, तो वही रजिस्ट्रेशन आईडी दिया जाएगा.
पैरामीटर
-
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 (एपीआई) कंसोल में बताया गया है.
-
messageId
स्ट्रिंग
मैसेज का आईडी. ऐप्लिकेशन के दायरे में आने वाले हर मैसेज के लिए, यह यूनीक होना चाहिए. आईडी चुनने और मैनेज करने के बारे में सलाह पाने के लिए, क्लाउड से मैसेज भेजने का दस्तावेज़ देखें.
-
timeToLive
नंबर ज़रूरी नहीं
मैसेज के लाइव होने का समय (सेकंड में). अगर उस समय पर मैसेज नहीं भेजा जा सकता, तो onSendError इवेंट दर्ज किया जाएगा. टाइम-टू-लाइव 0 का मतलब है कि मैसेज तुरंत भेज दिया जाना चाहिए या अगर यह संभव नहीं है, तो मैसेज नहीं भेज दिया जाना चाहिए. लाइव जाने के समय की डिफ़ॉल्ट वैल्यू 86,400 सेकंड (1 दिन) है और यह वैल्यू ज़्यादा से ज़्यादा 24,19,200 सेकंड (28 दिन) होती है.
-
-
कॉलबैक
फ़ंक्शन ज़रूरी नहीं
callback
पैरामीटर ऐसा दिखता है:(messageId: string) => void
-
messageId
स्ट्रिंग
उस मैसेज का आईडी जिसके लिए कॉलबैक जारी किया गया था.
-
रिटर्न
-
प्रॉमिस<string>
Chrome 116 और इसके बाद के वर्शनप्रॉमिस, मेनिफ़ेस्ट V3 और इसके बाद के वर्शन में काम करता है. हालांकि, पुराने सिस्टम के साथ काम करने के लिए कॉलबैक दिए जाते हैं. आप एक ही फ़ंक्शन कॉल पर दोनों का इस्तेमाल नहीं कर सकते. प्रॉमिस उसी टाइप के साथ रिज़ॉल्व हो जाती है जिसे कॉलबैक को पास किया जाता है.
unregister()
chrome.gcm.unregister(
callback?: function,
)
FCM से ऐप्लिकेशन का रजिस्ट्रेशन रद्द करता है.
पैरामीटर
-
कॉलबैक
फ़ंक्शन ज़रूरी नहीं
callback
पैरामीटर ऐसा दिखता है:() => void
रिटर्न
-
Promise<void>
Chrome 116 और इसके बाद के वर्शनप्रॉमिस, मेनिफ़ेस्ट V3 और इसके बाद के वर्शन में काम करता है. हालांकि, पुराने सिस्टम के साथ काम करने के लिए कॉलबैक दिए जाते हैं. आप एक ही फ़ंक्शन कॉल पर दोनों का इस्तेमाल नहीं कर सकते. प्रॉमिस उसी टाइप के साथ रिज़ॉल्व हो जाती है जिसे कॉलबैक को पास किया जाता है.
इवेंट
onMessage
chrome.gcm.onMessage.addListener(
callback: function,
)
FCM से मैसेज मिलने पर सक्रिय होता है.
पैरामीटर
-
कॉलबैक
फ़ंक्शन
callback
पैरामीटर ऐसा दिखता है:(message: object) => void
-
ग्राहक का मैसेज
ऑब्जेक्ट
-
collapseKey
स्ट्रिंग ज़रूरी नहीं
मैसेज की कुंजी को छोटा करें. ज़्यादा जानकारी के लिए, छोटे और छोटे किए जा सकने वाले मैसेज देखें.
-
डेटा
ऑब्जेक्ट
मैसेज का डेटा.
-
इन्होंने भेजा है
स्ट्रिंग ज़रूरी नहीं
भेजने वाला व्यक्ति जिसने मैसेज जारी किया.
-
-
onMessagesDeleted
chrome.gcm.onMessagesDeleted.addListener(
callback: function,
)
यह तब सक्रिय होता है, जब FCM सर्वर को ऐप्लिकेशन सर्वर से ऐप्लिकेशन को भेजे गए मैसेज मिटाने होते थे. इस इवेंट को मैनेज करने के बारे में जानने के लिए, मैसेज से अब तक की जानकारी देखें.
पैरामीटर
-
कॉलबैक
फ़ंक्शन
callback
पैरामीटर ऐसा दिखता है:() => void
onSendError
chrome.gcm.onSendError.addListener(
callback: function,
)
FCM सर्वर पर मैसेज भेजना संभव नहीं होने पर सक्रिय किया जाता है.
पैरामीटर
-
कॉलबैक
फ़ंक्शन
callback
पैरामीटर ऐसा दिखता है:(error: object) => void
-
गड़बड़ी
ऑब्जेक्ट
-
विवरण
ऑब्जेक्ट
गड़बड़ी के बारे में ज़्यादा जानकारी, अगर उपलब्ध हो.
-
errorMessage
स्ट्रिंग
समस्या के बारे में जानकारी देने वाला गड़बड़ी का मैसेज.
-
messageId
स्ट्रिंग ज़रूरी नहीं
इस गड़बड़ी वाले मैसेज का आईडी, अगर गड़बड़ी किसी खास मैसेज से जुड़ी हो.
-
-