Android के लिए खास तौर पर बने सूचना विकल्प दिखाता है, जिन्हें AndroidConfig में शामिल किया जा सकता है.
हस्ताक्षर:
export interface AndroidNotification
प्रॉपर्टी
| प्रॉपर्टी | टाइप | ब्यौरा |
|---|---|---|
| मुख्य हिस्सा | स्ट्रिंग | Android की सूचना का मुख्य हिस्सा. जब यह पैरामीटर उपलब्ध कराया जाता है, तो यह admin.messaging.Notification के ज़रिए सेट किए गए मुख्य हिस्से को बदल देता है. |
| bodyLocArgs | स्ट्रिंग[] | रिसॉर्स कुंजियों का कलेक्शन, जिसका इस्तेमाल bodyLocKey में फ़ॉर्मैट की जानकारी देने वाले डिवाइसों की जगह किया जाएगा. |
| bodyLocKey | स्ट्रिंग | ऐप्लिकेशन के स्ट्रिंग संसाधन में मौजूद मुख्य हिस्से वाली स्ट्रिंग की कुंजी. इसका इस्तेमाल मुख्य हिस्से को स्थानीय भाषा में लिखने के लिए किया जाता है. |
| चैनल आईडी | स्ट्रिंग | Android की सूचना का चैनल आईडी (Android O में नया). इस चैनल आईडी वाली कोई भी सूचना पाने से पहले, ऐप्लिकेशन को इस चैनल आईडी के साथ एक चैनल बनाना होगा. अगर आप अनुरोध में यह चैनल आईडी नहीं भेजते हैं या ऐप्लिकेशन ने अभी तक चैनल आईडी नहीं बनाया है, तो FCM, ऐप्लिकेशन मेनिफ़ेस्ट में बताए गए चैनल आईडी का इस्तेमाल करता है. |
| क्लिक ऐक्शन | स्ट्रिंग | सूचना पर उपयोगकर्ता के क्लिक से जुड़ी कार्रवाई. अगर तय किया गया है, तो किसी उपयोगकर्ता के सूचना पर क्लिक करने पर, मैच होने वाले इंटेंट फ़िल्टर वाली गतिविधि लॉन्च होती है. |
| रंग | स्ट्रिंग | #rrggbb फ़ॉर्मैट में सूचना आइकॉन का रंग. |
| डिफ़ॉल्ट लाइटसेटिंग | बूलियन | अगर यह नीति true पर सेट है, तो सूचना पाने के लिए Android फ़्रेमवर्क की एलईडी लाइट की डिफ़ॉल्ट सेटिंग इस्तेमाल करें. डिफ़ॉल्ट वैल्यू, config.xml में दी गई हैं. अगर default_light_settings को true पर सेट किया गया है और light_settings को भी सेट किया गया है, तो डिफ़ॉल्ट वैल्यू के बजाय, उपयोगकर्ता के हिसाब से तय किए गए light_settings का इस्तेमाल किया जाएगा. |
| डिफ़ॉल्ट आवाज़ | बूलियन | अगर यह नीति true पर सेट है, तो सूचना के लिए Android फ़्रेमवर्क की डिफ़ॉल्ट आवाज़ का इस्तेमाल करें. डिफ़ॉल्ट वैल्यू, config.xml में दी गई हैं. |
| डिफ़ॉल्ट वाइब्रेटटाइम्स | बूलियन | अगर यह नीति true पर सेट है, तो सूचना के लिए Android फ़्रेमवर्क के डिफ़ॉल्ट वाइब्रेशन पैटर्न का इस्तेमाल करें. डिफ़ॉल्ट वैल्यू, config.xml में दी गई हैं. अगर default_vibrate_timings को true पर सेट किया गया है और vibrate_timings भी सेट है, तो उपयोगकर्ता के बताए गए vibrate_timings के बजाय, डिफ़ॉल्ट वैल्यू का इस्तेमाल किया जाता है. |
| इवेंट का टाइमस्टैंप | तारीख | उपयोगकर्ताओं को सटीक समय के रेफ़रंस के साथ इवेंट के बारे में बताने वाली सूचनाओं के लिए, सूचना में इवेंट के होने का समय सेट करता है. पैनल में सूचनाएं इस समय के हिसाब से क्रम में लगी हैं. |
| आइकॉन | स्ट्रिंग | Android की सूचना के लिए आइकॉन संसाधन. |
| imageUrl | स्ट्रिंग | सूचना में दिखाई जाने वाली इमेज का यूआरएल. |
| lightSettings | लाइट सेटिंग | डिवाइस पर एलईडी उपलब्ध होने पर, सूचना की एलईडी ब्लिंक करने की दर और रंग को कंट्रोल करने की सेटिंग. ब्लिंक करने के कुल समय को ओएस कंट्रोल करता है. |
| लोकल ओनली | बूलियन | सेट करता है कि यह सूचना केवल वर्तमान डिवाइस के लिए प्रासंगिक है या नहीं. कुछ सूचनाओं को रिमोट डिसप्ले के लिए दूसरे डिवाइसों पर जोड़ा जा सकता है, जैसे कि Wear OS स्मार्टवॉच. इस संकेत को यह सुझाव देने के लिए सेट किया जा सकता है कि इस सूचना को ऐक्सेस न किया जाए. Wear OS गाइड देखें. |
| सूचना की संख्या | नंबर | इस सूचना में दिखाए जाने वाले आइटम की संख्या सेट करता है. इसे उन लॉन्चर के लिए बैज की संख्या के तौर पर दिखाया जा सकता है जिन पर बैज काम करता है. NotificationBadge देखें. उदाहरण के लिए, यह तब उपयोगी हो सकता है, जब आप एक से ज़्यादा नए मैसेज दिखाने के लिए सिर्फ़ एक सूचना का इस्तेमाल कर रहे हों, लेकिन आपको यहां बताई गई संख्या से नए मैसेज की कुल संख्या दिखानी हो. अगर यह संख्या शून्य है या सेट नहीं की गई है, तो बैजिंग का समर्थन करने वाले सिस्टम डिफ़ॉल्ट का उपयोग करते हैं, जो हर बार कोई नई सूचना आने पर देर तक दबाएं मेनू पर दिखाई जाने वाली संख्या को बढ़ाने के लिए है. |
| प्राथमिकता | ('कम से कम' | 'कम' | 'डिफ़ॉल्ट' | 'ज़्यादा' | 'ज़्यादा से ज़्यादा') | इस सूचना को प्राथमिकता के हिसाब से सेट करता है. कुछ स्थितियों में, हो सकता है कि कम ज़रूरी सूचनाएं उपयोगकर्ता को न दिखें. ध्यान दें कि यह प्राथमिकता, AndroidMessagePriority से अलग है. मैसेज डिलीवर होने के बाद, क्लाइंट इस प्राथमिकता को प्रोसेस करता है. वहीं, AndroidMessagePriority एक FCM कॉन्सेप्ट है, जो यह कंट्रोल करता है कि मैसेज कब डिलीवर किया जाए. |
| साउंड | स्ट्रिंग | डिवाइस को सूचना मिलने पर, चलाई जाने वाली आवाज़ की फ़ाइल का नाम. |
| स्टिकी | बूलियन | अगर नीति को false पर सेट किया जाता है या इसे सेट नहीं किया जाता है, तो पैनल में उपयोगकर्ता के क्लिक करने पर यह अपने-आप खारिज हो जाती है. अगर नीति को true पर सेट किया जाता है, तो सूचना तब भी बनी रहती है, जब उपयोगकर्ता इस पर क्लिक करता है. |
| टैग | स्ट्रिंग | सूचना टैग. यह एक आइडेंटिफ़ायर है, जिसका इस्तेमाल सूचना दिखाने वाले पैनल में मौजूदा सूचनाओं को बदलने के लिए किया जाता है. अगर यह नीति तय नहीं की गई है, तो हर अनुरोध के लिए नई सूचना बनाई जा सकती है. |
| टिकर | स्ट्रिंग | "टिकर" सेट करता है टेक्स्ट होता है. इसे सुलभता सेवाओं को भेजा जाता है. एपीआई लेवल 21 (Lollipop) से पहले, वह टेक्स्ट सेट करता है जो पहली बार सूचना आने पर स्टेटस बार में दिखाया जाता है. |
| टाइटल | स्ट्रिंग | Android की सूचना का टाइटल. जब यह दिया जाता है, तो admin.messaging.Notification के ज़रिए सेट किए गए टाइटल को बदल दिया जाता है. |
| titleLocArgs | स्ट्रिंग[] | रिसॉर्स कुंजियों का कलेक्शन, जिसका इस्तेमाल titleLocKey में फ़ॉर्मैट की जानकारी देने वाले डिवाइसों की जगह किया जाएगा. |
| titleLocKey | स्ट्रिंग | ऐप्लिकेशन के स्ट्रिंग संसाधन में मौजूद टाइटल स्ट्रिंग की कुंजी, जिसका इस्तेमाल टाइटल टेक्स्ट को स्थानीय भाषा में लिखने में किया जाता है. |
| vibrateTimingsMillis | नंबर[] | इस्तेमाल करने के लिए वाइब्रेशन का पैटर्न सेट करता है. वाइब्रेटर चालू या बंद करने के लिए, मिलीसेकंड के कलेक्शन को पास करें. पहली वैल्यू से पता चलता है कि वाइब्रेटर चालू करने से पहले, आपको कितनी देर इंतज़ार करना होगा. अगली वैल्यू से पता चलता है कि वाइब्रेटर को चालू रखना है या नहीं. इसके बाद, अलग-अलग समय में अलग-अलग वैल्यू दिखाई जाती हैं, ताकि वाइब्रेटर चालू किया जा सके और उसे बंद किया जा सके. अगर vibrate_timings और default_vibrate_timings को true पर सेट किया गया है, तो उपयोगकर्ता के हिसाब से तय की गई vibrate_timings के बजाय, डिफ़ॉल्ट वैल्यू का इस्तेमाल किया जाता है. |
| विज़िबिलिटी | ('निजी' | 'सार्वजनिक' | 'सीक्रेट') | इससे यह सेट किया जाता है कि सूचना किसको दिखे. private, public या secret होना चाहिए. अगर इसके लिए कोई वैल्यू सेट नहीं की गई है, तो डिफ़ॉल्ट रूप से private सेट होती है. |
AndroidNotification.body
Android की सूचना का मुख्य हिस्सा. यह पैरामीटर उपलब्ध होने पर, admin.messaging.Notification के ज़रिए सेट किए गए मुख्य हिस्से को बदल देता है.
हस्ताक्षर:
body?: string;
Androidसूचना.bodyLocArgs
रिसॉर्स कुंजियों का कलेक्शन, जिसका इस्तेमाल bodyLocKey में फ़ॉर्मैट की जानकारी देने वाले टूल की जगह किया जाएगा.
हस्ताक्षर:
bodyLocArgs?: string[];
Androidसूचना.bodyLocKey
ऐप्लिकेशन के स्ट्रिंग संसाधन में मौजूद मुख्य हिस्से वाली स्ट्रिंग की कुंजी. इसका इस्तेमाल मुख्य हिस्से को स्थानीय भाषा में लिखने के लिए किया जाता है.
हस्ताक्षर:
bodyLocKey?: string;
Androidसूचना.channelId
Android की सूचना का चैनल आईडी (Android O में नया). इस चैनल आईडी वाली कोई भी सूचना पाने से पहले, ऐप्लिकेशन को इस चैनल आईडी के साथ एक चैनल बनाना होगा. अगर आप अनुरोध में यह चैनल आईडी नहीं भेजते हैं या ऐप्लिकेशन ने अभी तक चैनल आईडी नहीं बनाया है, तो FCM, ऐप्लिकेशन मेनिफ़ेस्ट में बताए गए चैनल आईडी का इस्तेमाल करता है.
हस्ताक्षर:
channelId?: string;
Androidसूचना.क्लिक एक्शन
सूचना पर उपयोगकर्ता के क्लिक से जुड़ी कार्रवाई. अगर तय किया गया है, तो किसी उपयोगकर्ता के सूचना पर क्लिक करने पर, मैच होने वाले इंटेंट फ़िल्टर वाली गतिविधि लॉन्च होती है.
हस्ताक्षर:
clickAction?: string;
Androidसूचना.रंग
#rrggbb फ़ॉर्मैट में सूचना आइकॉन का रंग.
हस्ताक्षर:
color?: string;
Androidसूचना.डिफ़ॉल्ट लाइटसेटिंग
अगर इसे true पर सेट किया जाता है, तो सूचना के लिए Android फ़्रेमवर्क की एलईडी लाइट की डिफ़ॉल्ट सेटिंग इस्तेमाल करें. डिफ़ॉल्ट वैल्यू, config.xml में दी गई हैं. अगर default_light_settings को true पर सेट किया गया है और light_settings को भी सेट किया गया है, तो डिफ़ॉल्ट वैल्यू के बजाय, उपयोगकर्ता के हिसाब से तय किए गए light_settings का इस्तेमाल किया जाएगा.
हस्ताक्षर:
defaultLightSettings?: boolean;
Androidसूचना.डिफ़ॉल्ट आवाज़
अगर यह नीति true पर सेट है, तो सूचना के लिए Android फ़्रेमवर्क की डिफ़ॉल्ट आवाज़ का इस्तेमाल करें. डिफ़ॉल्ट वैल्यू, config.xml में दी गई हैं.
हस्ताक्षर:
defaultSound?: boolean;
AndroidNotification.defaultveTimings
अगर यह नीति true पर सेट है, तो सूचना के लिए Android फ़्रेमवर्क के डिफ़ॉल्ट वाइब्रेशन पैटर्न का इस्तेमाल करें. डिफ़ॉल्ट वैल्यू, config.xml में दी गई हैं. अगर default_vibrate_timings को true पर सेट किया गया है और vibrate_timings भी सेट है, तो उपयोगकर्ता की तय की गई vibrate_timings के बजाय, डिफ़ॉल्ट वैल्यू का इस्तेमाल किया जाता है.
हस्ताक्षर:
defaultVibrateTimings?: boolean;
Androidसूचना.eventtimestamp
उपयोगकर्ताओं को सटीक समय के रेफ़रंस के साथ इवेंट के बारे में बताने वाली सूचनाओं के लिए, सूचना में इवेंट के होने का समय सेट करता है. पैनल में सूचनाएं इस समय के हिसाब से क्रम में लगी हैं.
हस्ताक्षर:
eventTimestamp?: Date;
Androidसूचना.आइकॉन
Android की सूचना के लिए आइकॉन संसाधन.
हस्ताक्षर:
icon?: string;
Androidसूचना.imageUrl
सूचना में दिखाई जाने वाली इमेज का यूआरएल.
हस्ताक्षर:
imageUrl?: string;
Androidसूचना.लाइटसेटिंग
डिवाइस पर एलईडी उपलब्ध होने पर, सूचना की एलईडी ब्लिंक करने की दर और रंग को कंट्रोल करने की सेटिंग. ब्लिंक करने के कुल समय को ओएस कंट्रोल करता है.
हस्ताक्षर:
lightSettings?: LightSettings;
Androidसूचना.localOnly
सेट करता है कि यह सूचना केवल वर्तमान डिवाइस के लिए प्रासंगिक है या नहीं. कुछ सूचनाओं को रिमोट डिसप्ले के लिए दूसरे डिवाइसों पर जोड़ा जा सकता है, जैसे कि Wear OS स्मार्टवॉच. इस संकेत को यह सुझाव देने के लिए सेट किया जा सकता है कि इस सूचना को ऐक्सेस न किया जाए. Wear OS गाइड देखें.
हस्ताक्षर:
localOnly?: boolean;
Androidसूचना.सूचनाकाउंट
इस सूचना में दिखाए जाने वाले आइटम की संख्या सेट करता है. इसे उन लॉन्चर के लिए बैज की संख्या के तौर पर दिखाया जा सकता है जिन पर बैज काम करता है. NotificationBadge देखें. उदाहरण के लिए, यह तब उपयोगी हो सकता है, जब आप एक से ज़्यादा नए मैसेज दिखाने के लिए सिर्फ़ एक सूचना का इस्तेमाल कर रहे हों, लेकिन आपको यहां बताई गई संख्या से नए मैसेज की कुल संख्या दिखानी हो. अगर यह संख्या शून्य है या सेट नहीं की गई है, तो बैजिंग का समर्थन करने वाले सिस्टम डिफ़ॉल्ट का उपयोग करते हैं, जो हर बार कोई नई सूचना आने पर देर तक दबाएं मेनू पर दिखाई जाने वाली संख्या को बढ़ाने के लिए है.
हस्ताक्षर:
notificationCount?: number;
Androidसूचना.प्राथमिकता
इस सूचना को प्राथमिकता के हिसाब से सेट करता है. कुछ स्थितियों में, हो सकता है कि कम ज़रूरी सूचनाएं उपयोगकर्ता को न दिखें. ध्यान दें कि यह प्राथमिकता AndroidMessagePriority से अलग है. मैसेज डिलीवर होने के बाद, क्लाइंट इस प्राथमिकता को प्रोसेस करता है. वहीं, AndroidMessagePriority एक FCM कॉन्सेप्ट है, जो यह कंट्रोल करता है कि मैसेज कब डिलीवर किया जाए.
हस्ताक्षर:
priority?: ('min' | 'low' | 'default' | 'high' | 'max');
Androidसूचना.sound
डिवाइस को सूचना मिलने पर, चलाई जाने वाली आवाज़ की फ़ाइल का नाम.
हस्ताक्षर:
sound?: string;
Androidसूचना.स्टिकी
अगर नीति को false पर सेट किया जाता है या इसे सेट नहीं किया जाता है, तो पैनल में उपयोगकर्ता के क्लिक करने पर यह अपने-आप खारिज हो जाती है. अगर सूचना को true पर सेट किया जाता है, तो उपयोगकर्ता के क्लिक करने के बाद भी यह सूचना बनी रहती है.
हस्ताक्षर:
sticky?: boolean;
Androidसूचना.टैग
सूचना टैग. यह एक आइडेंटिफ़ायर है, जिसका इस्तेमाल सूचना दिखाने वाले पैनल में मौजूदा सूचनाओं को बदलने के लिए किया जाता है. अगर यह नीति तय नहीं की गई है, तो हर अनुरोध के लिए नई सूचना बनाई जा सकती है.
हस्ताक्षर:
tag?: string;
Androidसूचना.टिकर
"टिकर" सेट करता है टेक्स्ट होता है. इसे सुलभता सेवाओं को भेजा जाता है. एपीआई लेवल 21 (Lollipop) से पहले, वह टेक्स्ट सेट करता है जो पहली बार सूचना आने पर स्टेटस बार में दिखाया जाता है.
हस्ताक्षर:
ticker?: string;
Androidसूचना.टाइटल
Android की सूचना का टाइटल. जब यह दिया जाता है, तो यह admin.messaging.Notification के ज़रिए सेट किए गए टाइटल को बदल देता है.
हस्ताक्षर:
title?: string;
Androidसूचना.titleLocArgs
रिसॉर्स कुंजियों का कलेक्शन, जिसका इस्तेमाल titleLocKey में फ़ॉर्मैट की जानकारी देने वाले टूल की जगह किया जाएगा.
हस्ताक्षर:
titleLocArgs?: string[];
Androidसूचना.titleLocKey
ऐप्लिकेशन के स्ट्रिंग संसाधन में मौजूद टाइटल स्ट्रिंग की कुंजी, जिसका इस्तेमाल टाइटल टेक्स्ट को स्थानीय भाषा में लिखने में किया जाता है.
हस्ताक्षर:
titleLocKey?: string;
Androidसूचना.vibrateTimingsMillis
इस्तेमाल करने के लिए वाइब्रेशन का पैटर्न सेट करता है. वाइब्रेटर चालू या बंद करने के लिए, मिलीसेकंड के कलेक्शन को पास करें. पहली वैल्यू से पता चलता है कि वाइब्रेटर चालू करने से पहले, आपको कितनी देर इंतज़ार करना होगा. अगली वैल्यू से पता चलता है कि वाइब्रेटर को चालू रखना है या नहीं. इसके बाद, अलग-अलग समय में अलग-अलग वैल्यू दिखाई जाती हैं, ताकि वाइब्रेटर चालू किया जा सके और उसे बंद किया जा सके. अगर vibrate_timings और default_vibrate_timings को true पर सेट किया गया है, तो उपयोगकर्ता की तय की गई vibrate_timings के बजाय, डिफ़ॉल्ट वैल्यू का इस्तेमाल किया जाता है.
हस्ताक्षर:
vibrateTimingsMillis?: number[];
AndroidNotification.visibility
इससे यह सेट किया जाता है कि सूचना किसको दिखे. private, public या secret होना चाहिए. अगर कोई वैल्यू नहीं बताई गई है, तो डिफ़ॉल्ट रूप से private पर सेट होती है.
हस्ताक्षर:
visibility?: ('private' | 'public' | 'secret');