@firebase/messaging

कार्य

समारोह विवरण
फ़ंक्शन (ऐप, ...)
संदेश प्राप्त करें(ऐप) फ़ायरबेस क्लाउड मैसेजिंग उदाहरण पुनर्प्राप्त करता है।
फ़ंक्शन (मैसेजिंग, ...)
डिलीटटोकन(मैसेजिंग) इस मैसेजिंग इंस्टेंस से जुड़े पंजीकरण टोकन को हटा देता है और पुश सब्सक्रिप्शन से मैसेजिंग इंस्टेंस की सदस्यता समाप्त कर देता है।
getToken(मैसेजिंग, विकल्प) नोटिफिकेशन पुश करने के लिए मैसेजिंग इंस्टेंस की सदस्यता लेता है। एक फायरबेस क्लाउड मैसेजिंग पंजीकरण टोकन लौटाता है जिसका उपयोग उस मैसेजिंग इंस्टेंस पर पुश संदेश भेजने के लिए किया जा सकता है। यदि अधिसूचना की अनुमति पहले से नहीं दी गई है, तो यह विधि उपयोगकर्ता से अनुमति मांगती है। यदि उपयोगकर्ता ऐप को सूचनाएं दिखाने की अनुमति नहीं देता है तो लौटाया गया वादा अस्वीकार कर दिया जाता है।
ऑनमैसेज(मैसेजिंग, नेक्स्टऑरऑब्जर्वर) जब एक पुश संदेश प्राप्त होता है और उपयोगकर्ता वर्तमान में आपके मूल पृष्ठ पर है, तो संदेश को पृष्ठ पर भेज दिया जाता है और पुश संदेश के पेलोड के साथ एक onMessage() ईवेंट भेजा जाता है।
समारोह()
समर्थित है() जाँचता है कि ब्राउज़र में सभी आवश्यक एपीआई मौजूद हैं या नहीं।

इंटरफेस

इंटरफेस विवरण
एफसीएम विकल्प वेब के लिए एफसीएम एसडीके द्वारा प्रदान की गई सुविधाओं के विकल्प। WebpushFcmOptions देखें .
GetTokenOptions GetToken के लिए विकल्प() .
संदेशपेलोड संदेश पेलोड जिसमें नोटिफिकेशन पेलोड होता है जिसे नोटिफिकेशनपेलोड के साथ दर्शाया जाता है और डेटा पेलोड जिसमें सेंड एपीआई के माध्यम से डेवलपर्स द्वारा भेजे गए कुंजी-मूल्य जोड़े की मनमानी संख्या होती है .
संदेश फायरबेस क्लाउड मैसेजिंग एसडीके का सार्वजनिक इंटरफ़ेस।
अधिसूचनापेलोड अधिसूचना विवरण प्रदर्शित करें. विवरण सेंड एपीआई के माध्यम से भेजे जाते हैं .

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

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

फ़ायरबेस क्लाउड मैसेजिंग उदाहरण पुनर्प्राप्त करता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
अनुप्रयोग फायरबेस ऐप

रिटर्न:

संदेश

दिए गए फायरबेस ऐप से जुड़ा फायरबेस क्लाउड मैसेजिंग इंस्टेंस।

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

डिलीटटोकन(मैसेजिंग)

इस मैसेजिंग इंस्टेंस से जुड़े पंजीकरण टोकन को हटा देता है और पुश सब्सक्रिप्शन से मैसेजिंग इंस्टेंस की सदस्यता समाप्त कर देता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
मैसेजिंग संदेश मैसेजिंग उदाहरण.

रिटर्न:

वादा<बूलियन>

टोकन सफलतापूर्वक हटा दिए जाने पर वादा हल हो जाता है।

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

नोटिफिकेशन पुश करने के लिए मैसेजिंग इंस्टेंस की सदस्यता लेता है। एक फायरबेस क्लाउड मैसेजिंग पंजीकरण टोकन लौटाता है जिसका उपयोग उस मैसेजिंग इंस्टेंस पर पुश संदेश भेजने के लिए किया जा सकता है।

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
मैसेजिंग संदेश मैसेजिंग उदाहरण.
विकल्प GetTokenOptions एक वैकल्पिक अस्पष्ट कुंजी और एक वैकल्पिक सेवा कार्यकर्ता पंजीकरण प्रदान करता है।

रिटर्न:

वादा<स्ट्रिंग>

वादा FCM पंजीकरण टोकन के साथ हल हो जाता है।

ऑनमैसेज(मैसेजिंग, नेक्स्टऑरऑब्जर्वर)

जब एक पुश संदेश प्राप्त होता है और उपयोगकर्ता वर्तमान में आपके मूल पृष्ठ पर है, तो संदेश को पृष्ठ पर भेज दिया जाता है और पुश संदेश के पेलोड के साथ एक onMessage() ईवेंट भेजा जाता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
मैसेजिंग संदेश मैसेजिंग उदाहरण.
NextOrObserver NextFn < संदेशपेलोड > | देखने वाला < संदेशपेलोड > यह फ़ंक्शन, या next परिभाषित पर्यवेक्षक ऑब्जेक्ट को तब कॉल किया जाता है जब कोई संदेश प्राप्त होता है और उपयोगकर्ता वर्तमान में आपका पृष्ठ देख रहा है।

रिटर्न:

सदस्यता रद्द

संदेशों को सुनना बंद करने के लिए इस लौटाए गए फ़ंक्शन को निष्पादित करें।

समारोह()

समर्थित है()

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

हस्ताक्षर:

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

रिटर्न:

वादा<बूलियन>

एक वादा जो एक बूलियन को हल करता है।