AndroidNotification interface

Android-विशिष्ट अधिसूचना विकल्पों का प्रतिनिधित्व करता है जिन्हें AndroidConfig में शामिल किया जा सकता है .

हस्ताक्षर:

export interface AndroidNotification 

गुण

AndroidNotification.body

Android अधिसूचना का मुख्य भाग. प्रदान किए जाने पर, admin.messaging.Notification के माध्यम से बॉडी सेट को ओवरराइड कर देता है .

हस्ताक्षर:

body?: string;

AndroidNotification.bodyLocArgs

संसाधन कुंजियों की एक सारणी जिसका उपयोग bodyLocKey में प्रारूप निर्दिष्टकर्ताओं के स्थान पर किया जाएगा .

हस्ताक्षर:

bodyLocArgs?: string[];

AndroidNotification.bodyLocKey

ऐप के स्ट्रिंग संसाधन में बॉडी स्ट्रिंग की कुंजी, जिसका उपयोग बॉडी टेक्स्ट को स्थानीयकृत करने के लिए किया जाता है।

हस्ताक्षर:

bodyLocKey?: string;

AndroidNotification.channelId

Android अधिसूचना चैनल आईडी (Android O में नया)। इस चैनल आईडी के साथ कोई भी अधिसूचना प्राप्त होने से पहले ऐप को इस चैनल आईडी के साथ एक चैनल बनाना होगा। यदि आप अनुरोध में यह चैनल आईडी नहीं भेजते हैं, या यदि प्रदान की गई चैनल आईडी अभी तक ऐप द्वारा नहीं बनाई गई है, तो एफसीएम ऐप मेनिफेस्ट में निर्दिष्ट चैनल आईडी का उपयोग करता है।

हस्ताक्षर:

channelId?: string;

AndroidNotification.clickAction

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

हस्ताक्षर:

clickAction?: string;

AndroidNotification.रंग

अधिसूचना आइकन का रंग #rrggbb प्रारूप में।

हस्ताक्षर:

color?: string;

AndroidNotification.defaultLightSettings

यदि true पर सेट है , अधिसूचना के लिए एंड्रॉइड फ्रेमवर्क की डिफ़ॉल्ट एलईडी लाइट सेटिंग्स का उपयोग करें। डिफ़ॉल्ट मान config.xml में निर्दिष्ट हैं . यदि default_light_settings true पर सेट किया गया है और light_settings भी सेट किया गया है, तो डिफ़ॉल्ट मान के बजाय उपयोगकर्ता द्वारा निर्दिष्ट light_settings का उपयोग किया जाता है।

हस्ताक्षर:

defaultLightSettings?: boolean;

AndroidNotification.defaultSound

यदि true पर सेट है , अधिसूचना के लिए एंड्रॉइड फ्रेमवर्क की डिफ़ॉल्ट ध्वनि का उपयोग करें। डिफ़ॉल्ट मान config.xml में निर्दिष्ट हैं .

हस्ताक्षर:

defaultSound?: boolean;

AndroidNotification.defaultVibrateTimings

यदि true पर सेट है , अधिसूचना के लिए एंड्रॉइड फ्रेमवर्क के डिफ़ॉल्ट कंपन पैटर्न का उपयोग करें। डिफ़ॉल्ट मान config.xml में निर्दिष्ट हैं . यदि default_vibrate_timings true पर सेट किया गया है और vibrate_timings भी सेट किया गया है, तो उपयोगकर्ता द्वारा निर्दिष्ट vibrate_timings के बजाय डिफ़ॉल्ट मान का उपयोग किया जाता है .

हस्ताक्षर:

defaultVibrateTimings?: boolean;

AndroidNotification.eventTimestamp

उन सूचनाओं के लिए जो उपयोगकर्ताओं को पूर्ण समय संदर्भ के साथ घटनाओं के बारे में सूचित करती हैं, अधिसूचना में घटना घटित होने का समय निर्धारित करती है। पैनल में सूचनाएं इस समय के अनुसार क्रमबद्ध की जाती हैं।

हस्ताक्षर:

eventTimestamp?: Date;

AndroidNotification.आइकन

एंड्रॉइड अधिसूचना के लिए आइकन संसाधन।

हस्ताक्षर:

icon?: string;

AndroidNotification.imageUrl

अधिसूचना में प्रदर्शित होने वाली छवि का यूआरएल।

हस्ताक्षर:

imageUrl?: string;

AndroidNotification.lightSettings

यदि डिवाइस पर एलईडी उपलब्ध है तो अधिसूचना की एलईडी ब्लिंकिंग दर और रंग को नियंत्रित करने के लिए सेटिंग्स। कुल पलक झपकने का समय OS द्वारा नियंत्रित किया जाता है।

हस्ताक्षर:

lightSettings?: LightSettings;

AndroidNotification.localकेवल

सेट करता है कि यह अधिसूचना केवल वर्तमान डिवाइस के लिए प्रासंगिक है या नहीं। कुछ सूचनाओं को रिमोट डिस्प्ले के लिए अन्य डिवाइसों पर ब्रिज किया जा सकता है, जैसे वेयर ओएस घड़ी। इस अधिसूचना को ब्रिज न करने की अनुशंसा करने के लिए यह संकेत सेट किया जा सकता है। वेयर ओएस गाइड देखें .

हस्ताक्षर:

localOnly?: boolean;

AndroidNotification.notificationCount

यह अधिसूचना जिन आइटमों का प्रतिनिधित्व करती है उनकी संख्या निर्धारित करती है। बैजिंग का समर्थन करने वाले लॉन्चर्स के लिए बैज गिनती के रूप में प्रदर्शित किया जा सकता है। नोटिफिकेशनबैज देखें . उदाहरण के लिए, यह उपयोगी हो सकता है यदि आप कई नए संदेशों को दर्शाने के लिए सिर्फ एक अधिसूचना का उपयोग कर रहे हैं लेकिन आप चाहते हैं कि यहां गिनती कुल नए संदेशों की संख्या का प्रतिनिधित्व करे। यदि शून्य या अनिर्दिष्ट है, तो बैजिंग का समर्थन करने वाले सिस्टम डिफ़ॉल्ट का उपयोग करते हैं, जो हर बार एक नई अधिसूचना आने पर लॉन्ग-प्रेस मेनू पर प्रदर्शित संख्या को बढ़ाता है।

हस्ताक्षर:

notificationCount?: number;

AndroidNotification.प्राथमिकता

इस अधिसूचना के लिए सापेक्ष प्राथमिकता निर्धारित करता है। कुछ स्थितियों में कम-प्राथमिकता वाली सूचनाएं उपयोगकर्ता से छिपाई जा सकती हैं। ध्यान दें कि यह प्राथमिकता AndroidMessagePriority से भिन्न है . यह प्राथमिकता संदेश डिलीवर होने के बाद क्लाइंट द्वारा संसाधित की जाती है। जबकि AndroidMessagePriority एक FCM अवधारणा है जो संदेश वितरित होने पर नियंत्रण करती है।

हस्ताक्षर:

priority?: ('min' | 'low' | 'default' | 'high' | 'max');

AndroidNotification.ध्वनि

डिवाइस द्वारा अधिसूचना प्राप्त होने पर बजाई जाने वाली ध्वनि का फ़ाइल नाम।

हस्ताक्षर:

sound?: string;

AndroidNotification.चिपचिपा

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

हस्ताक्षर:

sticky?: boolean;

AndroidNotification.tag

अधिसूचना टैग. यह एक पहचानकर्ता है जिसका उपयोग अधिसूचना ड्रॉअर में मौजूदा सूचनाओं को बदलने के लिए किया जाता है। यदि निर्दिष्ट नहीं है, तो प्रत्येक अनुरोध एक नई अधिसूचना बनाता है।

हस्ताक्षर:

tag?: string;

AndroidNotification.ticker

"टिकर" टेक्स्ट सेट करता है, जो एक्सेसिबिलिटी सेवाओं को भेजा जाता है। एपीआई स्तर 21 (लॉलीपॉप) से पहले, उस टेक्स्ट को सेट करता है जो अधिसूचना पहली बार आने पर स्टेटस बार में प्रदर्शित होता है।

हस्ताक्षर:

ticker?: string;

AndroidNotification.शीर्षक

Android अधिसूचना का शीर्षक. प्रदान किए जाने पर, admin.messaging.Notification के माध्यम से सेट किए गए शीर्षक को ओवरराइड कर देता है .

हस्ताक्षर:

title?: string;

AndroidNotification.titleLocArgs

संसाधन कुंजियों की एक सारणी जिसका उपयोग titleLocKey में प्रारूप विनिर्देशकों के स्थान पर किया जाएगा .

हस्ताक्षर:

titleLocArgs?: string[];

AndroidNotification.titleLocKey

शीर्षक पाठ को स्थानीयकृत करने के लिए उपयोग करने के लिए ऐप के स्ट्रिंग संसाधन में शीर्षक स्ट्रिंग की कुंजी।

हस्ताक्षर:

titleLocKey?: string;

AndroidNotification.vibrateTimingsMillis

उपयोग के लिए कंपन पैटर्न सेट करता है। वाइब्रेटर को चालू या बंद करने के लिए मिलीसेकंड की एक श्रृंखला गुजारें। पहला मान वाइब्रेटर चालू करने से पहले प्रतीक्षा करने की अवधि को इंगित करता है। अगला मान वाइब्रेटर को चालू रखने की अवधि को इंगित करता है। बाद के मान वाइब्रेटर को बंद करने और वाइब्रेटर को चालू करने की अवधि के बीच वैकल्पिक होते हैं। यदि vibrate_timings सेट है और default_vibrate_timings true पर सेट है , उपयोगकर्ता द्वारा निर्दिष्ट vibrate_timings के बजाय डिफ़ॉल्ट मान का उपयोग किया जाता है .

हस्ताक्षर:

vibrateTimingsMillis?: number[];

AndroidNotification.दृश्यता

अधिसूचना की दृश्यता निर्धारित करता है. या तो private होना चाहिए , public , या secret . यदि अनिर्दिष्ट है, तो डिफ़ॉल्ट private हो जाता है .

हस्ताक्षर:

visibility?: ('private' | 'public' | 'secret');