मैसेजिंग सेवा प्रदत्त ऐप से जुड़ी हुई है।
हस्ताक्षर:
export declare class Messaging
गुण
संपत्ति | संशोधक | प्रकार | विवरण |
---|---|---|---|
अनुप्रयोग | अनुप्रयोग | ऐप वर्तमान Messaging सेवा उदाहरण से जुड़ा है। |
तरीकों
तरीका | संशोधक | विवरण |
---|---|---|
भेजें (संदेश, ड्राईरन) | दिए गए संदेश को FCM के माध्यम से भेजता है। | |
सभी भेजें(संदेश, ड्राईरन) | फायरबेस क्लाउड मैसेजिंग के माध्यम से दिए गए एरे में सभी संदेश भेजता है। संपूर्ण सूची को एकल RPC कॉल के रूप में भेजने के लिए बैचिंग को नियोजित करता है। send() विधि की तुलना में, यह विधि कई संदेश भेजने का काफी अधिक कुशल तरीका है। रिटर्न वैल्यू से प्राप्त प्रतिक्रिया सूची MulticastMessage में टोकन के क्रम से मेल खाती है। इस विधि से कोई त्रुटि पूर्ण विफलता को इंगित करती है, जिसका अर्थ है कि सूची में से कोई भी संदेश नहीं भेजा जा सका। आंशिक विफलताओं को BatchResponse रिटर्न मान द्वारा दर्शाया जाता है। | |
प्रत्येक भेजें(संदेश, ड्राई रन) | दिए गए एरे में प्रत्येक संदेश को फायरबेस क्लाउड मैसेजिंग के माध्यम से भेजता है। मैसेजिंग से भिन्न .sendAll() , यह विधि दिए गए सरणी में प्रत्येक संदेश के लिए एक एकल RPC कॉल करती है। रिटर्न वैल्यू से प्राप्त प्रतिक्रिया सूची messages के क्रम से मेल खाती है। इस विधि से एक त्रुटि या सभी विफलताओं के साथ एक BatchResponse कुल विफलता को इंगित करता है, जिसका अर्थ है कि सूची में से कोई भी संदेश नहीं भेजा जा सका। आंशिक विफलता या कोई विफलता केवल BatchResponse रिटर्न मान द्वारा इंगित की जाती है। | |
भेजेंप्रत्येकफॉरमल्टीकास्ट(संदेश, ड्राईरन) | दिए गए मल्टीकास्ट संदेश को उसमें निर्दिष्ट सभी एफसीएम पंजीकरण टोकन पर भेजता है। यह विधि सभी लक्षित प्राप्तकर्ताओं को दिए गए संदेश को भेजने के लिए मेसेजिंग.sendEach() एपीआई का उपयोग करती है। रिटर्न वैल्यू से प्राप्त प्रतिक्रिया सूची MulticastMessage में टोकन के क्रम से मेल खाती है। इस विधि से एक त्रुटि या सभी विफलताओं के साथ एक BatchResponse कुल विफलता को इंगित करता है, जिसका अर्थ है कि सूची में संदेश भेजे जा सकते हैं। आंशिक विफलताएँ या विफलताएँ केवल BatchResponse रिटर्न मान द्वारा इंगित की जाती हैं। | |
सेंडमल्टीकास्ट (संदेश, ड्राई रन) | दिए गए मल्टीकास्ट संदेश को उसमें निर्दिष्ट सभी एफसीएम पंजीकरण टोकन पर भेजता है। यह विधि सभी लक्षित प्राप्तकर्ताओं को दिए गए संदेश को भेजने के लिए हुड के तहत sendAll() एपीआई का उपयोग करती है। रिटर्न वैल्यू से प्राप्त प्रतिक्रिया सूची MulticastMessage में टोकन के क्रम से मेल खाती है। इस विधि से एक त्रुटि पूर्ण विफलता को इंगित करती है, जिसका अर्थ है कि संदेश सूची में किसी भी टोकन पर नहीं भेजा गया था। आंशिक विफलताओं को BatchResponse रिटर्न मान द्वारा दर्शाया जाता है। | |
भेजेंToCondition (स्थिति, पेलोड, विकल्प) | किसी शर्त पर FCM संदेश भेजता है. कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए एक शर्त भेजें देखें। | |
सेंडटूडिवाइस(पंजीकरणटोकनऑरटोकन, पेलोड, विकल्प) | प्रदान किए गए पंजीकरण टोकन के अनुरूप एकल डिवाइस पर एक एफसीएम संदेश भेजता है। कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए अलग-अलग डिवाइस पर भेजें देखें। एक डिवाइस पर भेजने के लिए या तो एक registrationToken लेता है या एकाधिक डिवाइस पर भेजने के लिए टोकन की एक श्रृंखला वाला एक registrationTokens पैरामीटर लेता है। | |
sentToDeviceGroup (अधिसूचना कुंजी, पेलोड, विकल्प) | प्रदान की गई अधिसूचना कुंजी के अनुरूप डिवाइस समूह को एक एफसीएम संदेश भेजता है। कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए डिवाइस समूह को भेजें देखें। | |
भेजेंToTopic(विषय, पेलोड, विकल्प) | किसी विषय पर FCM संदेश भेजता है. कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए किसी विषय पर भेजें देखें। | |
subscribeToTopic(registrationTokenOrTokens, विषय) | किसी डिवाइस को FCM विषय की सदस्यता देता है। कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए किसी विषय की सदस्यता लें देखें। वैकल्पिक रूप से, आप एकाधिक डिवाइसों की सदस्यता लेने के लिए टोकन की एक श्रृंखला प्रदान कर सकते हैं। | |
विषय से सदस्यता समाप्त करें(पंजीकरणटोकनऑरटोकन, विषय) | FCM विषय से किसी डिवाइस की सदस्यता समाप्त करता है। कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए किसी विषय से सदस्यता समाप्त करें देखें। वैकल्पिक रूप से, आप एकाधिक डिवाइसों की सदस्यता समाप्त करने के लिए टोकन की एक श्रृंखला प्रदान कर सकते हैं। |
मैसेजिंग.ऐप
ऐप वर्तमान Messaging
सेवा उदाहरण से जुड़ा है।
हस्ताक्षर:
get app(): App;
उदाहरण
var app = messaging.app;
मैसेजिंग.भेजें()
दिए गए संदेश को FCM के माध्यम से भेजता है।
हस्ताक्षर:
send(message: Message, dryRun?: boolean): Promise<string>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
संदेश | संदेश | संदेश पेलोड. |
पूर्वाभ्यास | बूलियन | संदेश को ड्राई-रन (केवल सत्यापन) मोड में भेजना है या नहीं। |
रिटर्न:
वादा<स्ट्रिंग>
संदेश को डिलीवरी के लिए एफसीएम सेवा को सफलतापूर्वक सौंपने के बाद एक अद्वितीय संदेश आईडी स्ट्रिंग के साथ एक वादा पूरा किया गया।
मैसेजिंग.सब भेजें()
इसके बजाय Message.sendEach() का उपयोग करें।
फायरबेस क्लाउड मैसेजिंग के माध्यम से दिए गए एरे में सभी संदेश भेजता है। संपूर्ण सूची को एकल RPC कॉल के रूप में भेजने के लिए बैचिंग को नियोजित करता है। send()
विधि की तुलना में, यह विधि कई संदेश भेजने का काफी अधिक कुशल तरीका है।
रिटर्न वैल्यू से प्राप्त प्रतिक्रिया सूची MulticastMessage
में टोकन के क्रम से मेल खाती है . इस विधि से कोई त्रुटि पूर्ण विफलता को इंगित करती है, जिसका अर्थ है कि सूची में से कोई भी संदेश नहीं भेजा जा सका। आंशिक विफलताओं को BatchResponse
रिटर्न मान द्वारा दर्शाया जाता है।
हस्ताक्षर:
sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
संदेशों | संदेश [] | एक गैर-रिक्त सरणी जिसमें अधिकतम 500 संदेश हैं। |
पूर्वाभ्यास | बूलियन | संदेशों को ड्राई-रन (केवल सत्यापन) मोड में भेजना है या नहीं। |
रिटर्न:
वादा< बैचरिस्पॉन्स >
सेंड ऑपरेशन के परिणाम का प्रतिनिधित्व करने वाली वस्तु के साथ पूरा किया गया एक वादा।
मैसेजिंग.sendEach()
दिए गए एरे में प्रत्येक संदेश को फायरबेस क्लाउड मैसेजिंग के माध्यम से भेजता है।
मैसेजिंग से भिन्न .sendAll() , यह विधि दिए गए सरणी में प्रत्येक संदेश के लिए एक एकल RPC कॉल करती है।
रिटर्न वैल्यू से प्राप्त प्रतिक्रियाओं की सूची messages
के क्रम से मेल खाती है . इस विधि से एक त्रुटि या सभी विफलताओं के साथ एक BatchResponse
कुल विफलता को इंगित करता है, जिसका अर्थ है कि सूची में से कोई भी संदेश नहीं भेजा जा सका। आंशिक विफलता या कोई विफलता केवल BatchResponse
रिटर्न मान द्वारा इंगित की जाती है।
हस्ताक्षर:
sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
संदेशों | संदेश [] | एक गैर-रिक्त सरणी जिसमें अधिकतम 500 संदेश हैं। |
पूर्वाभ्यास | बूलियन | संदेशों को ड्राई-रन (केवल सत्यापन) मोड में भेजना है या नहीं। |
रिटर्न:
वादा< बैचरिस्पॉन्स >
सेंड ऑपरेशन के परिणाम का प्रतिनिधित्व करने वाली वस्तु के साथ पूरा किया गया एक वादा।
मैसेजिंग.sendEachForMulticast()
दिए गए मल्टीकास्ट संदेश को उसमें निर्दिष्ट सभी एफसीएम पंजीकरण टोकन पर भेजता है।
यह विधि सभी लक्षित प्राप्तकर्ताओं को दिए गए संदेश को भेजने के लिए मेसेजिंग.sendEach() एपीआई का उपयोग करती है। रिटर्न वैल्यू से प्राप्त प्रतिक्रिया सूची MulticastMessage
में टोकन के क्रम से मेल खाती है . इस विधि से एक त्रुटि या सभी विफलताओं के साथ एक BatchResponse
कुल विफलता को इंगित करता है, जिसका अर्थ है कि सूची में संदेश भेजे जा सकते हैं। आंशिक विफलताएँ या विफलताएँ केवल BatchResponse
रिटर्न मान द्वारा इंगित की जाती हैं।
हस्ताक्षर:
sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
संदेश | मल्टीकास्टमैसेज | एक मल्टीकास्ट संदेश जिसमें 500 टोकन तक हैं। |
पूर्वाभ्यास | बूलियन | संदेश को ड्राई-रन (केवल सत्यापन) मोड में भेजना है या नहीं। |
रिटर्न:
वादा< बैचरिस्पॉन्स >
सेंड ऑपरेशन के परिणाम का प्रतिनिधित्व करने वाली वस्तु के साथ पूरा किया गया एक वादा।
मैसेजिंग.सेंडमल्टीकास्ट()
इसके बजाय Message.sendEachForMulticast() का उपयोग करें।
दिए गए मल्टीकास्ट संदेश को उसमें निर्दिष्ट सभी एफसीएम पंजीकरण टोकन पर भेजता है।
यह विधि सभी लक्षित प्राप्तकर्ताओं को दिए गए संदेश को भेजने के लिए हुड के तहत sendAll()
एपीआई का उपयोग करती है। रिटर्न वैल्यू से प्राप्त प्रतिक्रिया सूची MulticastMessage
में टोकन के क्रम से मेल खाती है . इस विधि से एक त्रुटि पूर्ण विफलता को इंगित करती है, जिसका अर्थ है कि संदेश सूची में किसी भी टोकन पर नहीं भेजा गया था। आंशिक विफलताओं को BatchResponse
रिटर्न मान द्वारा दर्शाया जाता है।
हस्ताक्षर:
sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
संदेश | मल्टीकास्टमैसेज | एक मल्टीकास्ट संदेश जिसमें 500 टोकन तक हैं। |
पूर्वाभ्यास | बूलियन | संदेश को ड्राई-रन (केवल सत्यापन) मोड में भेजना है या नहीं। |
रिटर्न:
वादा< बैचरिस्पॉन्स >
सेंड ऑपरेशन के परिणाम का प्रतिनिधित्व करने वाली वस्तु के साथ पूरा किया गया एक वादा।
मैसेजिंग.sendToCondition()
किसी शर्त पर FCM संदेश भेजता है.
कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए एक शर्त भेजें देखें।
हस्ताक्षर:
sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
स्थिति | डोरी | यह निर्धारित करने वाली शर्त कि संदेश किस विषय पर भेजा जाए। |
पेलोड | मैसेजिंगपेलोड | संदेश पेलोड. |
विकल्प | मैसेजिंग विकल्प | संदेश को बदलने के लिए वैकल्पिक विकल्प. |
रिटर्न:
वादा< मैसेजिंगकंडीशनरिस्पॉन्स >
संदेश भेजे जाने के बाद सर्वर की प्रतिक्रिया के साथ एक वादा पूरा हुआ।
मैसेजिंग.sendToDevice()
इसके बजाय मेसेजिंग.सेंड() का उपयोग करें।
प्रदान किए गए पंजीकरण टोकन के अनुरूप एकल डिवाइस पर एक एफसीएम संदेश भेजता है।
कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए अलग-अलग डिवाइस पर भेजें देखें। एक डिवाइस पर भेजने के लिए या तो एक registrationToken
लेता है या एकाधिक डिवाइस पर भेजने के लिए टोकन की एक श्रृंखला वाला एक registrationTokens
पैरामीटर लेता है।
हस्ताक्षर:
sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
पंजीकरणटोकनयाटोकन | स्ट्रिंग | डोरी[] | |
पेलोड | मैसेजिंगपेलोड | संदेश पेलोड. |
विकल्प | मैसेजिंग विकल्प | संदेश को बदलने के लिए वैकल्पिक विकल्प. |
रिटर्न:
वादा< मैसेजिंगडिवाइसेसरिस्पॉन्स >
संदेश भेजे जाने के बाद सर्वर की प्रतिक्रिया के साथ एक वादा पूरा हुआ।
मैसेजिंग.sendToDeviceGroup()
इसके बजाय मेसेजिंग.सेंड() का उपयोग करें।
प्रदान की गई अधिसूचना कुंजी के अनुरूप डिवाइस समूह को एक एफसीएम संदेश भेजता है।
कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए डिवाइस समूह को भेजें देखें।
हस्ताक्षर:
sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
अधिसूचनाकुंजी | डोरी | डिवाइस समूह के लिए अधिसूचना कुंजी जिसमें संदेश भेजना है। |
पेलोड | मैसेजिंगपेलोड | संदेश पेलोड. |
विकल्प | मैसेजिंग विकल्प | संदेश को बदलने के लिए वैकल्पिक विकल्प. |
रिटर्न:
वादा< मैसेजिंगडिवाइसग्रुपरिस्पॉन्स >
संदेश भेजे जाने के बाद सर्वर की प्रतिक्रिया के साथ एक वादा पूरा हुआ।
मैसेजिंग.sendToTopic()
किसी विषय पर FCM संदेश भेजता है.
कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए किसी विषय पर भेजें देखें।
हस्ताक्षर:
sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
विषय | डोरी | जिस विषय पर संदेश भेजना है. |
पेलोड | मैसेजिंगपेलोड | संदेश पेलोड. |
विकल्प | मैसेजिंग विकल्प | संदेश को बदलने के लिए वैकल्पिक विकल्प. |
रिटर्न:
वादा< मैसेजिंगटॉपिकरिस्पॉन्स >
संदेश भेजे जाने के बाद सर्वर की प्रतिक्रिया के साथ एक वादा पूरा हुआ।
मैसेजिंग.subscribeToTopic()
किसी डिवाइस को FCM विषय की सदस्यता देता है।
कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए किसी विषय की सदस्यता लें देखें। वैकल्पिक रूप से, आप एकाधिक डिवाइसों की सदस्यता लेने के लिए टोकन की एक श्रृंखला प्रदान कर सकते हैं।
हस्ताक्षर:
subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
पंजीकरणटोकनयाटोकन | स्ट्रिंग | डोरी[] | |
विषय | डोरी | जिस विषय की सदस्यता लेनी है. |
रिटर्न:
वादा< मैसेजिंगटॉपिकमैनेजमेंटरिस्पॉन्स >
डिवाइस द्वारा विषय की सदस्यता लेने के बाद सर्वर की प्रतिक्रिया से एक वादा पूरा हुआ।
मैसेजिंग.अनसब्सक्राइबफ्रॉमटॉपिक()
FCM विषय से किसी डिवाइस की सदस्यता समाप्त करता है।
कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए किसी विषय से सदस्यता समाप्त करें देखें। वैकल्पिक रूप से, आप एकाधिक डिवाइसों की सदस्यता समाप्त करने के लिए टोकन की एक श्रृंखला प्रदान कर सकते हैं।
हस्ताक्षर:
unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
पंजीकरणटोकनयाटोकन | स्ट्रिंग | डोरी[] | |
विषय | डोरी | वह विषय जिससे सदस्यता समाप्त करनी है. |
रिटर्न:
वादा< मैसेजिंगटॉपिकमैनेजमेंटरिस्पॉन्स >
विषय से डिवाइस की सदस्यता समाप्त होने के बाद सर्वर की प्रतिक्रिया से एक वादा पूरा हुआ।