@firebase/messaging

फ़ंक्शन

फ़ंक्शन ब्यौरा
फ़ंक्शन(ऐप्लिकेशन, ...)
getMessaging(ऐप्लिकेशन) Firebase क्लाउड से मैसेज वाला इंस्टेंस फ़ेच करता है.
फ़ंक्शन(मैसेज सेवा, ...)
deleteToken(मैसेज सेवा) इस मैसेज सेवा इंस्टेंस से जुड़े रजिस्ट्रेशन टोकन को मिटाता है और पुश सदस्यता से मैसेज सेवा इंस्टेंस की सदस्यता छोड़ता है.
getToken(मैसेज सेवा, विकल्प) पुश नोटिफ़िकेशन के लिए मैसेज सेवा इंस्टेंस की सदस्यता लेता है. Firebase क्लाउड से मैसेज वाला रजिस्ट्रेशन टोकन दिखाता है. इसका इस्तेमाल उस मैसेज सेवा इंस्टेंस पर पुश मैसेज भेजने के लिए किया जा सकता है.अगर सूचना पाने की अनुमति पहले से नहीं दी गई है, तो यह तरीका उपयोगकर्ता से अनुमति मांगता है. अगर उपयोगकर्ता, ऐप्लिकेशन को सूचनाएं दिखाने की अनुमति नहीं देता है, तो लागू किया गया प्रॉमिस अस्वीकार हो जाता है.
onMessage(Messages, NextOrObserver) जब कोई पुश मैसेज मिलता है और उपयोगकर्ता फ़िलहाल आपके ऑरिजिन के किसी पेज पर है, तो मैसेज को पेज पर भेजा जाता है. साथ ही, पुश मैसेज के पेलोड के साथ onMessage() इवेंट भेज दिया जाता है.
फ़ंक्शन()
issupported() यह जांच करता है कि ब्राउज़र में सभी ज़रूरी एपीआई मौजूद हैं या नहीं.

इंटरफ़ेस

इंटरफ़ेस ब्यौरा
FcmOptions वेब के लिए FCM SDK टूल की ओर से दी गई सुविधाओं के विकल्प. WebpushFcmOptions देखें.
GetTokenOptions getToken() के लिए विकल्प.
MessagePayload मैसेज पेलोड, जिसमें सूचना पेलोड शामिल है और यह सूचना पेलोड के साथ दिखाया जाता है. साथ ही, डेटा पेलोड में डेवलपर की ओर से Send API की मदद से भेजे गए कुंजी-वैल्यू पेयर की मनमुताबिक तय संख्या मौजूद होती है.
मैसेज सेवा Firebase क्लाउड से मैसेज वाले SDK टूल का सार्वजनिक इंटरफ़ेस.
सूचना पेलोड सूचना की जानकारी दिखाएं. Send API की मदद से जानकारी भेजी जाती है.

फ़ंक्शन(ऐप्लिकेशन, ...)

getMessaging(ऐप्लिकेशन)

Firebase क्लाउड से मैसेज वाला इंस्टेंस फ़ेच करता है.

हस्ताक्षर:

export declare function getMessagingInWindow(app?: FirebaseApp): Messaging;

पैरामीटर

पैरामीटर टाइप ब्यौरा
ऐप्लिकेशन FirebaseApp

लौटाए जाने वाले प्रॉडक्ट:

मैसेज सेवा

Firebase क्लाउड से मैसेज का इंस्टेंस, जो दिए गए Firebase ऐप्लिकेशन से जुड़ा है.

फ़ंक्शन(मैसेजिंग, ...)

DeleteToken(मैसेज सेवा)

इस मैसेज सेवा इंस्टेंस से जुड़े रजिस्ट्रेशन टोकन को मिटाता है और पुश सदस्यता से मैसेज सेवा इंस्टेंस की सदस्यता छोड़ता है.

हस्ताक्षर:

export declare function deleteToken(messaging: Messaging): Promise<boolean>;

पैरामीटर

पैरामीटर टाइप ब्यौरा
मैसेज सेवा मैसेज सेवा मैसेज सेवा का इंस्टेंस.

लौटाए जाने वाले प्रॉडक्ट:

Promise&lt;boolean&gt;

टोकन मिटाए जाने के बाद प्रॉमिस रिज़ॉल्व हो जाएगा.

getToken(मैसेज सेवा, विकल्प)

पुश नोटिफ़िकेशन के लिए मैसेज सेवा इंस्टेंस की सदस्यता लेता है. Firebase क्लाउड से मैसेज वाला रजिस्ट्रेशन टोकन दिखाता है. इसका इस्तेमाल उस मैसेज सेवा के इंस्टेंस पर पुश मैसेज भेजने के लिए किया जा सकता है.

अगर सूचना पाने की अनुमति पहले से नहीं दी गई है, तो इस तरीके में उपयोगकर्ता से अनुमति मांगी जाती है. अगर उपयोगकर्ता, ऐप्लिकेशन को सूचनाएं दिखाने की अनुमति नहीं देता है, तो लागू किया गया प्रॉमिस अस्वीकार हो जाता है.

हस्ताक्षर:

export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;

पैरामीटर

पैरामीटर टाइप ब्यौरा
मैसेज सेवा मैसेज सेवा मैसेज सेवा का इंस्टेंस.
विकल्प GetTokenOptions यह एक वैकल्पिक वैपिड कुंजी और सर्विस वर्कर रजिस्ट्रेशन का विकल्प देता है.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<string>

प्रॉमिस किसी FCM रजिस्ट्रेशन टोकन के साथ पूरा होता है.

onMessage(मैसेज सेवा, NextOrObserver)

जब कोई पुश मैसेज मिलता है और उपयोगकर्ता फ़िलहाल आपके ऑरिजिन के किसी पेज पर है, तो मैसेज को पेज पर भेजा जाता है. साथ ही, पुश मैसेज के पेलोड के साथ onMessage() इवेंट भेज दिया जाता है.

हस्ताक्षर:

export declare function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

पैरामीटर

पैरामीटर टाइप ब्यौरा
मैसेज सेवा मैसेज सेवा मैसेज सेवा का इंस्टेंस.
नेक्स्ट ऑऑब्ज़र्वर NextFn<MessagePayload> | ऑब्ज़र्वर<MessagePayload> यह फ़ंक्शन या next तय किया गया ऑब्ज़र्वर ऑब्जेक्ट तब कॉल किया जाता है, जब कोई मैसेज मिलता है और उपयोगकर्ता फ़िलहाल आपका पेज देख रहा होता है.

लौटाए जाने वाले प्रॉडक्ट:

सदस्यता छोड़ें

मैसेज को सुनना बंद करने के लिए, दिए गए इस फ़ंक्शन को एक्ज़ीक्यूट करें.

फ़ंक्शन()

issupported()

यह जांच करता है कि ब्राउज़र में सभी ज़रूरी एपीआई मौजूद हैं या नहीं.

हस्ताक्षर:

export declare function isWindowSupported(): Promise<boolean>;

लौटाए जाने वाले प्रॉडक्ट:

Promise&lt;boolean&gt;

ऐसा प्रॉमिस जो बूलियन वैल्यू में बदल जाता है.