firebase-admin.messaging package

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

फ़ंक्शन

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

क्लास

क्लास ब्यौरा
ग्राहकों को मैसेज भेजना दिए गए ऐप्लिकेशन से जुड़ी मैसेज सेवा.

इंटरफ़ेस

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

उपनाम टाइप

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

मैसेज सेवा(ऐप्लिकेशन)

डिफ़ॉल्ट ऐप्लिकेशन या किसी खास ऐप्लिकेशन के लिए मैसेज सेवा का इस्तेमाल किया जाता है.

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

हस्ताक्षर:

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

पैरामीटर

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

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

ग्राहकों को मैसेज भेजना

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

पहला उदाहरण

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

दूसरा उदाहरण

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

मैसेज

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

हस्ताक्षर:

export type Message = TokenMessage | TopicMessage | ConditionMessage;