इंटरफ़ेस उन विकल्पों का प्रतिनिधित्व करता है जो एफसीएम लीगेसी एपीआई के माध्यम से संदेश भेजते समय प्रदान किए जा सकते हैं।
कोड नमूने और विस्तृत दस्तावेज़ीकरण के लिए बिल्ड सेंड अनुरोध देखें।
हस्ताक्षर:
export interface MessagingOptions
गुण
संपत्ति | प्रकार | विवरण |
---|---|---|
पतनकुंजी | डोरी | संदेशों के एक समूह की पहचान करने वाली स्ट्रिंग (उदाहरण के लिए, "अपडेट उपलब्ध") जिसे संक्षिप्त किया जा सकता है, ताकि डिलीवरी फिर से शुरू होने पर केवल अंतिम संदेश भेजा जा सके। इसका उपयोग डिवाइस के वापस ऑनलाइन आने या सक्रिय होने पर एक जैसे कई संदेश भेजने से बचने के लिए किया जाता है। संदेश किस क्रम में भेजे जाएंगे इसकी कोई गारंटी नहीं है। किसी भी समय अधिकतम चार अलग-अलग संक्षिप्त कुंजियों की अनुमति है। इसका मतलब है कि एफसीएम सर्वर एक साथ प्रति क्लाइंट ऐप पर चार अलग-अलग सेंड-टू-सिंक संदेशों को स्टोर कर सकता है। यदि आप इस संख्या को पार कर जाते हैं, तो इसकी कोई गारंटी नहीं है कि एफसीएम सर्वर कौन सी चार पतन कुंजियाँ रखेगा। **डिफ़ॉल्ट मान:** कोई नहीं |
सामग्री उपलब्ध है | बूलियन | आईओएस पर, एपीएन पेलोड में content-available दर्शाने के लिए इस फ़ील्ड का उपयोग करें। जब कोई अधिसूचना या डेटा संदेश भेजा जाता है और इसे true पर सेट किया जाता है, तो एक निष्क्रिय क्लाइंट ऐप जागृत हो जाता है। एंड्रॉइड पर, डेटा संदेश ऐप को डिफ़ॉल्ट रूप से सक्रिय कर देते हैं। Chrome पर, यह ध्वज वर्तमान में समर्थित नहीं है. **डिफ़ॉल्ट मान:** false |
पूर्वाभ्यास | बूलियन | संदेश वास्तव में भेजा जाना चाहिए या नहीं. जब true पर सेट किया जाता है, तो डेवलपर्स को वास्तव में कोई संदेश भेजे बिना अनुरोध का परीक्षण करने की अनुमति मिलती है। जब false पर सेट किया जाता है, तो संदेश भेजा जाएगा। **डिफ़ॉल्ट मान:** false |
परिवर्तनशील सामग्री | बूलियन | आईओएस पर, एपीएन पेलोड में mutable-content प्रतिनिधित्व करने के लिए इस फ़ील्ड का उपयोग करें। जब कोई अधिसूचना भेजी जाती है और इसे true पर सेट किया जाता है, तो अधिसूचना सेवा ऐप एक्सटेंशन का उपयोग करके अधिसूचना की सामग्री को प्रदर्शित होने से पहले संशोधित किया जा सकता है . एंड्रॉइड और वेब पर, इस पैरामीटर को नजरअंदाज कर दिया जाएगा। **डिफ़ॉल्ट मान:** false |
प्राथमिकता | डोरी | संदेश की प्राथमिकता. मान्य मान "normal" और "high". iOS पर, ये APN की प्राथमिकताओं 5 और 10 के अनुरूप हैं। डिफ़ॉल्ट रूप से, अधिसूचना संदेश उच्च प्राथमिकता के साथ भेजे जाते हैं, और डेटा संदेश सामान्य प्राथमिकता के साथ भेजे जाते हैं। सामान्य प्राथमिकता क्लाइंट ऐप की बैटरी खपत को अनुकूलित करती है और इसका उपयोग तब तक किया जाना चाहिए जब तक कि तत्काल डिलीवरी की आवश्यकता न हो। सामान्य प्राथमिकता वाले संदेशों के लिए, ऐप को अनिर्दिष्ट देरी से संदेश प्राप्त हो सकता है। जब कोई संदेश उच्च प्राथमिकता के साथ भेजा जाता है, तो उसे तुरंत भेजा जाता है, और ऐप निष्क्रिय डिवाइस को जगा सकता है और आपके सर्वर पर नेटवर्क कनेक्शन खोल सकता है। अधिक जानकारी के लिए, संदेश की प्राथमिकता निर्धारित करना देखें . **डिफ़ॉल्ट मान:** अधिसूचना संदेशों के लिए "high" , डेटा संदेशों के लिए "normal" |
प्रतिबंधितपैकेजनाम | डोरी | संदेश प्राप्त करने के लिए एप्लिकेशन का पैकेज नाम जिससे पंजीकरण टोकन मेल खाना चाहिए। **डिफ़ॉल्ट मान:** कोई नहीं |
जीने के लिए समय | संख्या | यदि डिवाइस ऑफ़लाइन है तो संदेश को FCM स्टोरेज में कितने समय तक (सेकंड में) रखा जाना चाहिए। समर्थित रहने का अधिकतम समय चार सप्ताह है, और डिफ़ॉल्ट मान भी चार सप्ताह है। अधिक जानकारी के लिए, संदेश का जीवनकाल निर्धारित करना देखें . **डिफ़ॉल्ट मान:** 2419200 (सेकेंड में चार सप्ताह दर्शाता है) |
मैसेजिंगऑप्शंस.collapseKey
संदेशों के एक समूह की पहचान करने वाली स्ट्रिंग (उदाहरण के लिए, "अपडेट उपलब्ध") जिसे संक्षिप्त किया जा सकता है, ताकि डिलीवरी फिर से शुरू होने पर केवल अंतिम संदेश भेजा जा सके। इसका उपयोग डिवाइस के वापस ऑनलाइन आने या सक्रिय होने पर एक जैसे कई संदेश भेजने से बचने के लिए किया जाता है।
संदेश किस क्रम में भेजे जाएंगे इसकी कोई गारंटी नहीं है।
किसी भी समय अधिकतम चार अलग-अलग संक्षिप्त कुंजियों की अनुमति है। इसका मतलब है कि एफसीएम सर्वर एक साथ प्रति क्लाइंट ऐप पर चार अलग-अलग सेंड-टू-सिंक संदेशों को स्टोर कर सकता है। यदि आप इस संख्या को पार कर जाते हैं, तो इसकी कोई गारंटी नहीं है कि एफसीएम सर्वर कौन सी चार पतन कुंजियाँ रखेगा।
**डिफ़ॉल्ट मान:** कोई नहीं
हस्ताक्षर:
collapseKey?: string;
संदेश विकल्प.सामग्री उपलब्ध
आईओएस पर, एपीएन पेलोड में content-available
दर्शाने के लिए इस फ़ील्ड का उपयोग करें। जब कोई अधिसूचना या डेटा संदेश भेजा जाता है और इसे true
पर सेट किया जाता है , एक निष्क्रिय क्लाइंट ऐप जागृत है। एंड्रॉइड पर, डेटा संदेश ऐप को डिफ़ॉल्ट रूप से सक्रिय कर देते हैं। Chrome पर, यह ध्वज वर्तमान में समर्थित नहीं है.
**डिफ़ॉल्ट मान:** false
हस्ताक्षर:
contentAvailable?: boolean;
मैसेजिंगऑप्शंस.ड्राईरन
संदेश वास्तव में भेजा जाना चाहिए या नहीं. जब true
पर सेट किया जाए , डेवलपर्स को वास्तव में कोई संदेश भेजे बिना अनुरोध का परीक्षण करने की अनुमति देता है। जब false
पर सेट किया जाता है , संदेश भेजा जाएगा.
**डिफ़ॉल्ट मान:** false
हस्ताक्षर:
dryRun?: boolean;
मैसेजिंगऑप्शंस.म्यूटेबलकंटेंट
आईओएस पर, एपीएन पेलोड में mutable-content
प्रतिनिधित्व करने के लिए इस फ़ील्ड का उपयोग करें। जब एक अधिसूचना भेजी जाती है और इसे true
पर सेट किया जाता है , अधिसूचना सेवा ऐप एक्सटेंशन का उपयोग करके अधिसूचना की सामग्री को प्रदर्शित होने से पहले संशोधित किया जा सकता है .
एंड्रॉइड और वेब पर, इस पैरामीटर को नजरअंदाज कर दिया जाएगा।
**डिफ़ॉल्ट मान:** false
हस्ताक्षर:
mutableContent?: boolean;
संदेश-विकल्प.प्राथमिकता
संदेश की प्राथमिकता. मान्य मान "normal"
और "high".
iOS पर, ये APNs प्राथमिकताओं 5
और 10
के अनुरूप हैं .
डिफ़ॉल्ट रूप से, अधिसूचना संदेश उच्च प्राथमिकता के साथ भेजे जाते हैं, और डेटा संदेश सामान्य प्राथमिकता के साथ भेजे जाते हैं। सामान्य प्राथमिकता क्लाइंट ऐप की बैटरी खपत को अनुकूलित करती है और इसका उपयोग तब तक किया जाना चाहिए जब तक कि तत्काल डिलीवरी की आवश्यकता न हो। सामान्य प्राथमिकता वाले संदेशों के लिए, ऐप को अनिर्दिष्ट देरी से संदेश प्राप्त हो सकता है।
जब कोई संदेश उच्च प्राथमिकता के साथ भेजा जाता है, तो उसे तुरंत भेजा जाता है, और ऐप निष्क्रिय डिवाइस को जगा सकता है और आपके सर्वर पर नेटवर्क कनेक्शन खोल सकता है।
अधिक जानकारी के लिए, संदेश की प्राथमिकता निर्धारित करना देखें .
**डिफ़ॉल्ट मान:** अधिसूचना संदेशों के लिए "high"
, डेटा संदेशों के लिए "normal"
हस्ताक्षर:
priority?: string;
मेसेजिंगऑप्शंस.प्रतिबंधितपैकेजनाम
संदेश प्राप्त करने के लिए एप्लिकेशन का पैकेज नाम जिससे पंजीकरण टोकन मेल खाना चाहिए।
**डिफ़ॉल्ट मान:** कोई नहीं
हस्ताक्षर:
restrictedPackageName?: string;
मैसेजिंगऑप्शंस.टाइमटूलाइव
यदि डिवाइस ऑफ़लाइन है तो संदेश को FCM स्टोरेज में कितने समय तक (सेकंड में) रखा जाना चाहिए। समर्थित रहने का अधिकतम समय चार सप्ताह है, और डिफ़ॉल्ट मान भी चार सप्ताह है। अधिक जानकारी के लिए, संदेश का जीवनकाल निर्धारित करना देखें .
**डिफ़ॉल्ट मान:** 2419200
(सेकेंड में चार सप्ताह दर्शाता है)
हस्ताक्षर:
timeToLive?: number;