@firebase/messaging/sw

कार्य

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

इंटरफेस

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

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

रिटर्न:

संदेश

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

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

प्रयोगात्मकSetDeliveryMetricsExportedToBigQueryEnabled(मैसेजिंग, सक्षम करें)

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

हस्ताक्षर:

export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;

पैरामीटर

पैरामीटर प्रकार विवरण
मैसेजिंग संदेश FirebaseMessaging उदाहरण।
सक्षम बूलियन क्या फायरबेस क्लाउड मैसेजिंग को संदेश डिलीवरी मेट्रिक्स को BigQuery में निर्यात करना चाहिए।

रिटर्न:

खालीपन

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

जब ऐप पृष्ठभूमि में हो तब कोई संदेश प्राप्त होने पर कॉल किया जाता है। यदि कोई सक्रिय विंडो प्रदर्शित नहीं होती है तो ऐप को पृष्ठभूमि में माना जाता है।

हस्ताक्षर:

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

पैरामीटर

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

रिटर्न:

सदस्यता रद्द

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

समारोह()

समर्थित है()

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

हस्ताक्षर:

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

रिटर्न:

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

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