firebase-admin.messaging package

Firebase क्लाउड से मैसेज (FCM).

फ़ंक्शन

फ़ंक्शन	ब्यौरा
getMessaging(ऐप्लिकेशन)	डिफ़ॉल्ट ऐप्लिकेशन या किसी ऐप्लिकेशन के लिए, मैसेज सेवा की सुविधा उपलब्ध कराता है. admin.messaging() को डिफ़ॉल्ट ऐप्लिकेशन की Messaging सेवा को ऐक्सेस करने के लिए, बिना किसी तर्क के कॉल किया जा सकता है. इसके अलावा, किसी खास ऐप्लिकेशन से जुड़ी Messaging सेवा को ऐक्सेस करने के लिए, admin.messaging() को admin.messaging(app) के तौर पर कॉल किया जा सकता है.

क्लास

क्लास	ब्यौरा
FirebaseMessagingError	Firebase मैसेज सेवा के गड़बड़ी कोड का स्ट्रक्चर. इससे PrefixedFirebaseError को भी बढ़ा दिया जाता है.
मैसेज सेवा	मैसेज सेवा, ऐप्लिकेशन पर ही काम करती है.
MessagingClientErrorCode	मैसेज सेवा क्लाइंट के गड़बड़ी कोड और उनके डिफ़ॉल्ट मैसेज.

इंटरफ़ेस

इंटरफ़ेस	ब्यौरा
AndroidConfig	Android के लिए ऐसे खास विकल्प दिखाता है जिन्हें किसी मैसेज में शामिल किया जा सकता है.
AndroidFcmOptions	Android के लिए FCM SDK टूल की ओर से दी गई सुविधाओं के विकल्प दिखाता है.
Androidसूचना	Android के लिए खास तौर पर बने सूचना विकल्प दिखाता है, जिन्हें AndroidConfig में शामिल किया जा सकता है.
ApnsConfig	यह एपीएन के लिए खास तौर पर बने वे विकल्प दिखाता है जिन्हें मैसेज में शामिल किया जा सकता है. एपीएन के साथ काम करने वाले अलग-अलग हेडर और पेलोड फ़ील्ड के लिए, Apple के दस्तावेज़ देखें.
ApnsFcmOptions	iOS के लिए FCM SDK टूल की ओर से उपलब्ध कराई गई सुविधाओं के विकल्प दिखाता है.
ApnsPayload	यह एपीएन मैसेज का पेलोड दिखाता है. मुख्य रूप से aps डिक्शनरी है. हालांकि, इसमें अन्य आर्बिट्रेरी कस्टम कुंजियां भी शामिल हो सकती हैं.
ऐप्लिकेशन	aps डिक्शनरी के बारे में बताता है, जो एपीएन मैसेज का हिस्सा है.
ApsAlert
BaseMessage
BatchResponse	ऐसा इंटरफ़ेस जो Messaging.sendAll() और Messaging.sendMulticast() मेथड से सर्वर के रिस्पॉन्स को दिखाता है.
ConditionMessage
क्रिटिकल साउंड	ज़रूरी साउंड कॉन्फ़िगरेशन को दिखाता है, जिसे एपीएन पेलोड के aps डिक्शनरी में शामिल किया जा सकता है.
DataMessagePayload	FCM के पुराने एपीआई डेटा मैसेज पेलोड को दिखाने वाला इंटरफ़ेस. डेटा मैसेज की मदद से, डेवलपर 4 केबी तक की कस्टम की-वैल्यू पेयर भेज पाते हैं. कुंजियां और मान दोनों स्ट्रिंग होने चाहिए. नीचे दी गई रिज़र्व स्ट्रिंग को छोड़कर, कुंजियां कोई भी कस्टम स्ट्रिंग हो सकती हैं: from google. से शुरू होने वाले सभी कोड सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ के लिए, ईमेल भेजने के अनुरोध बनाएं देखें.
FcmOptions	FCM SDK टूल की सुविधाओं के लिए, प्लैटफ़ॉर्म-इंडिपेंडेंट विकल्पों को दिखाता है.
लाइट सेटिंग	यह सूचना एलईडी को कंट्रोल करने की सेटिंग दिखाती है, जिन्हें AndroidNotification में शामिल किया जा सकता है.
MessagingConditionResponse	ऐसा इंटरफ़ेस जो पुराने Messaging.sendToCondition() तरीके से सर्वर के रिस्पॉन्स को दिखाता है.कोड सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ के लिए, किसी शर्त पर भेजें देखें.
MessagingDeviceGroupResponse	ऐसा इंटरफ़ेस जो Messaging.sendToDeviceGroup() तरीके से सर्वर के जवाब को दिखाता है.कोड के सैंपल और ज़्यादा जानकारी के दस्तावेज़ के लिए, डिवाइस ग्रुप को मैसेज भेजना सेक्शन देखें.
MessagingDeviceresults	अलग-अलग डिवाइसों से मिले स्टेटस के हिसाब से पेलोड
MessagingDeviceResponse	FCM के पुराने एपीआई की मदद से, किसी डिवाइस पर भेजे गए मैसेज की स्थिति दिखाने वाला इंटरफ़ेस.कोड सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ के लिए, अलग-अलग डिवाइसों पर भेजें लेख पढ़ें.
ग्राहकों को मैसेज भेजने के विकल्प	ऐसा इंटरफ़ेस जो FCM के पुराने एपीआई के ज़रिए मैसेज भेजते समय दिया जा सकता है.कोड सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ के लिए, ईमेल भेजने के अनुरोध बनाएं लेख पढ़ें.
मैसेज भेजने का पेलोड	Firebase क्लाउड से मैसेज वाला मैसेज पेलोड दिखाने वाला इंटरफ़ेस. data और notification, दोनों में से कोई एक या दोनों कुंजियां ज़रूरी हैं.कोड के सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ के लिए, ईमेल भेजने के अनुरोध बनाएं पर जाएं.
MessagingTopicManagementResponse	ऐसा इंटरफ़ेस जो Messaging.subscribeToTopic() और Messaging.unsubscribeFromTopic() तरीके से सर्वर के जवाब को दिखाता है.कोड सैंपल और ज़्यादा जानकारी के दस्तावेज़ के लिए, सर्वर से विषय मैनेज करें देखें.
MessagingTopicResponse	ऐसा इंटरफ़ेस जो पुराने Messaging.sendToTopic() तरीके से सर्वर के रिस्पॉन्स को दिखाता है.कोड सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ के लिए, किसी विषय पर भेजें को देखें.
MulticastMessage	Messaging.sendMulticast() तरीके के लिए पेलोड. पेलोड में BaseMessage टाइप के सभी फ़ील्ड और टोकन की सूची होती है.
सूचना	एक सूचना, जिसे मैसेज में शामिल किया जा सकता है.
NotificationMessagePayload	FCM एपीआई की पुरानी सूचना के मैसेज पेलोड को दिखाने वाला इंटरफ़ेस. सूचना वाले मैसेज की मदद से, डेवलपर पहले से तय की-वैल्यू पेयर को 4 केबी तक भेज सकते हैं. स्वीकार की जाने वाली कुंजियों की जानकारी नीचे दी गई है.कोड सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ के लिए, ईमेल भेजने के अनुरोध बनाएं देखें.
SendResponse	बैच रिक्वेस्ट के तौर पर भेजे गए मैसेज की स्थिति दिखाने वाला इंटरफ़ेस.
TokenMessage
TopicMessage
WebpushConfig	यह WebPush प्रोटोकॉल विकल्प को दिखाता है. इस विकल्प को मैसेज में शामिल किया जा सकता है.
WebpushFcmOptions	वेब के लिए FCM SDK टूल की ओर से दी गई सुविधाओं के विकल्प दिखाता है (जो Webpush स्टैंडर्ड का हिस्सा नहीं हैं).
WebpushNotification	यह Webpush से जुड़ी सूचना के उन विकल्पों को दिखाता है जिन्हें WebpushConfig में शामिल किया जा सकता है. इसमें वेब सूचना की खास जानकारी में बताए गए ज़्यादातर स्टैंडर्ड विकल्प काम करते हैं.

उपनामों का प्रकार

उपनाम टाइप करें	ब्यौरा
मैसेज	Messaging.send() ऑपरेशन के लिए पेलोड. पेलोड में BaseMessage टाइप के सभी फ़ील्ड शामिल होते हैं. साथ ही, इनमें सिर्फ़ एक टोकन, विषय या शर्त भी शामिल होती है.

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

डिफ़ॉल्ट ऐप्लिकेशन या किसी ऐप्लिकेशन के लिए, मैसेज भेजने की सेवा चालू करता है.

डिफ़ॉल्ट ऐप्लिकेशन की Messaging सेवा को ऐक्सेस करने के लिए, admin.messaging() को बिना किसी आर्ग्युमेंट के कॉल किया जा सकता है. इसके अलावा, किसी खास ऐप्लिकेशन से जुड़ी Messaging सेवा को ऐक्सेस करने के लिए, admin.messaging(app) को कॉल किया जा सकता है.

हस्ताक्षर:

export declare function getMessaging(app?: App): Messaging;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ऐप्लिकेशन	ऐप्लिकेशन	वैकल्पिक ऐप्लिकेशन जिसकी Messaging सेवा वापस करनी है. अगर इस नीति को उपलब्ध नहीं कराया जाता है, तो Messaging की डिफ़ॉल्ट सेवा दी जाएगी.

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

मैसेज सेवा

अगर कोई ऐप्लिकेशन नहीं दिया जाता है या दिए गए ऐप्लिकेशन से जुड़ी Messaging सेवा, तो Messaging की डिफ़ॉल्ट सेवा.

उदाहरण 1

// Get the Messaging service for the default app
const defaultMessaging = getMessaging();

उदाहरण 2

// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);

मैसेज

Messaging.send() ऑपरेशन के लिए पेलोड. पेलोड में BaseMessage टाइप के सभी फ़ील्ड शामिल होते हैं. साथ ही, इनमें सिर्फ़ एक टोकन, विषय या शर्त भी शामिल होती है.

हस्ताक्षर:

export type Message = TokenMessage | TopicMessage | ConditionMessage;