firebase-admin.messaging package

फायरबेस क्लाउड मैसेजिंग (एफसीएम)।

कार्य

समारोह विवरण
संदेश प्राप्त करें(ऐप) डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए मैसेजिंग सेवा प्राप्त होती है। डिफ़ॉल्ट ऐप की Messaging सेवा तक पहुंचने के लिए admin.messaging() को बिना किसी तर्क के या किसी विशिष्ट ऐप से जुड़ी Messaging सेवा तक पहुंचने के लिए admin.messaging(app) के रूप में कॉल किया जा सकता है।

कक्षाओं

कक्षा विवरण
संदेश मैसेजिंग सेवा प्रदत्त ऐप से जुड़ी हुई है।

इंटरफेस

इंटरफेस विवरण
Androidकॉन्फिग एंड्रॉइड-विशिष्ट विकल्पों का प्रतिनिधित्व करता है जिन्हें एक संदेश में शामिल किया जा सकता है .
AndroidFcmविकल्प एंड्रॉइड के लिए एफसीएम एसडीके द्वारा प्रदान की गई सुविधाओं के विकल्पों का प्रतिनिधित्व करता है।
Android अधिसूचना Android-विशिष्ट अधिसूचना विकल्पों का प्रतिनिधित्व करता है जिन्हें AndroidConfig में शामिल किया जा सकता है .
ApnsConfig एपीएन-विशिष्ट विकल्पों का प्रतिनिधित्व करता है जिन्हें एक संदेश में शामिल किया जा सकता है . एपीएन द्वारा समर्थित विभिन्न हेडर और पेलोड फ़ील्ड के लिए ऐप्पल दस्तावेज़ देखें।
ApnsFcmविकल्प आईओएस के लिए एफसीएम एसडीके द्वारा प्रदान की गई सुविधाओं के विकल्पों का प्रतिनिधित्व करता है।
Apnsपेलोड APNs संदेश के पेलोड का प्रतिनिधित्व करता है। इसमें मुख्य रूप से aps शब्दकोश शामिल है। लेकिन इसमें अन्य मनमानी कस्टम कुंजियाँ भी शामिल हो सकती हैं।
ए पी एस एपीएस शब्दकोश का प्रतिनिधित्व करता है जो एपीएन संदेशों का हिस्सा है।
एप्सअलर्ट
बेसमैसेज
बैचरिस्पॉन्स Message.sendAll() और Message.sendMulticast() तरीकों से सर्वर प्रतिक्रिया का प्रतिनिधित्व करने वाला इंटरफ़ेस।
शर्तसंदेश
क्रिटिकलसाउंड एक महत्वपूर्ण ध्वनि विन्यास का प्रतिनिधित्व करता है जिसे एपीएन पेलोड के aps शब्दकोश में शामिल किया जा सकता है।
डेटामैसेजपेलोड एफसीएम लीगेसी एपीआई डेटा संदेश पेलोड का प्रतिनिधित्व करने वाला इंटरफ़ेस। डेटा संदेश डेवलपर्स को 4KB तक कस्टम कुंजी-मूल्य जोड़े भेजने देते हैं। कुंजियाँ और मान दोनों स्ट्रिंग होने चाहिए। निम्नलिखित आरक्षित स्ट्रिंग्स को छोड़कर, कुंजियाँ कोई भी कस्टम स्ट्रिंग हो सकती हैं:
  • from
  • google.
कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए बिल्ड सेंड अनुरोध देखें।
एफसीएम विकल्प एफसीएम एसडीके द्वारा प्रदान की गई सुविधाओं के लिए प्लेटफ़ॉर्म-स्वतंत्र विकल्पों का प्रतिनिधित्व करता है।
लाइटसेटिंग्स अधिसूचना एलईडी को नियंत्रित करने के लिए सेटिंग्स का प्रतिनिधित्व करता है जिसे एंड्रॉइड अधिसूचना में शामिल किया जा सकता है .
मैसेजिंग कंडीशन रिस्पॉन्स इंटरफ़ेस लीगेसी Messating.sendToCondition() विधि से सर्वर प्रतिक्रिया का प्रतिनिधित्व करता है। कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए एक शर्त भेजें देखें।
मैसेजिंगडिवाइसग्रुपरिस्पॉन्स Message.sendToDeviceGroup() विधि से सर्वर प्रतिक्रिया का प्रतिनिधित्व करने वाला इंटरफ़ेस। कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए डिवाइस समूहों को संदेश भेजें देखें।
मैसेजिंगडिवाइसपरिणाम एकल उपकरणों से व्यक्तिगत स्थिति प्रतिक्रिया पेलोड
मैसेजिंगडिवाइसेसरिस्पॉन्स एफसीएम लीगेसी एपीआई के माध्यम से एक व्यक्तिगत डिवाइस पर भेजे गए संदेश की स्थिति का प्रतिनिधित्व करने वाला इंटरफ़ेस। कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए अलग-अलग डिवाइस पर भेजें देखें।
मैसेजिंग विकल्प इंटरफ़ेस उन विकल्पों का प्रतिनिधित्व करता है जो एफसीएम लीगेसी एपीआई के माध्यम से संदेश भेजते समय प्रदान किए जा सकते हैं। कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए बिल्ड सेंड अनुरोध देखें।
मैसेजिंगपेलोड फ़ायरबेस क्लाउड मैसेजिंग संदेश पेलोड का प्रतिनिधित्व करने वाला इंटरफ़ेस। data और notification कुंजियों में से एक या दोनों की आवश्यकता है। कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए बिल्ड सेंड अनुरोध देखें।
मैसेजिंगविषयप्रबंधनप्रतिक्रिया Message.subscribeToTopic() और Message.unsubscribeFromTopic() तरीकों से सर्वर प्रतिक्रिया का प्रतिनिधित्व करने वाला इंटरफ़ेस। कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए सर्वर से विषय प्रबंधित करें देखें।
मैसेजिंग टॉपिक रिस्पॉन्स इंटरफ़ेस लीगेसी Message.sendToTopic() विधि से सर्वर प्रतिक्रिया का प्रतिनिधित्व करता है। कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए किसी विषय पर भेजें देखें।
मल्टीकास्टमैसेज Message.sendMulticast() विधि के लिए पेलोड। पेलोड में बेसमैसेज प्रकार के सभी फ़ील्ड और टोकन की एक सूची शामिल है।
अधिसूचना एक अधिसूचना जिसे संदेश में शामिल किया जा सकता है .
अधिसूचना संदेशपेलोड एफसीएम लीगेसी एपीआई अधिसूचना संदेश पेलोड का प्रतिनिधित्व करने वाला इंटरफ़ेस। अधिसूचना संदेश डेवलपर्स को 4KB तक पूर्वनिर्धारित कुंजी-मूल्य जोड़े भेजने देते हैं। स्वीकृत कुंजियाँ नीचे उल्लिखित हैं। कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए बिल्ड सेंड अनुरोध देखें।
प्रतिक्रिया भेजो इंटरफ़ेस एक व्यक्तिगत संदेश की स्थिति का प्रतिनिधित्व करता है जिसे बैच अनुरोध के हिस्से के रूप में भेजा गया था।
टोकनमैसेज
विषयसंदेश
WebpushConfig वेबपश प्रोटोकॉल विकल्पों का प्रतिनिधित्व करता है जिन्हें एक संदेश में शामिल किया जा सकता है .
WebpushFcmOptions वेब के लिए एफसीएम एसडीके द्वारा प्रदान की गई सुविधाओं के विकल्पों का प्रतिनिधित्व करता है (जो वेबपश मानक का हिस्सा नहीं हैं)।
वेबपुश अधिसूचना WebPush-विशिष्ट अधिसूचना विकल्पों का प्रतिनिधित्व करता है जिन्हें WebpushConfig में शामिल किया जा सकता है . यह वेब अधिसूचना विनिर्देश में परिभाषित अधिकांश मानक विकल्पों का समर्थन करता है .

उपनाम टाइप करें

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

संदेश प्राप्त करें()

डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए मैसेजिंग सेवा प्राप्त होती है।

डिफ़ॉल्ट ऐप की 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);

संदेश

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

हस्ताक्षर:

export type Message = TokenMessage | TopicMessage | ConditionMessage;