AndroidNotification interface

מייצג את אפשרויות ההתראות הספציפיות לאנדרואיד שניתן לכלול ב- AndroidConfig .

חֲתִימָה:

export interface AndroidNotification 

נכסים

תכונה סוּג תיאור
גוּף חוּט גוף הודעת האנדרואיד. כאשר מסופק, עוקף את הגוף שהוגדר דרך admin.messaging.Notification .
bodyLocArgs חוּט[] מערך של מפתחות משאבים שישמשו במקום מפרטי הפורמט ב- bodyLocKey .
bodyLocKey חוּט מפתח של מחרוזת הגוף במשאב המחרוזת של האפליקציה לשימוש כדי להתאים את גוף הטקסט.
channelId חוּט מזהה ערוץ ההתראות של Android (חדש ב-Android O). על האפליקציה ליצור ערוץ עם מזהה ערוץ זה לפני שניתן יהיה לקבל הודעה כלשהי עם מזהה ערוץ זה. אם לא תשלח את מזהה הערוץ הזה בבקשה, או אם מזהה הערוץ שסופק עדיין לא נוצר על ידי האפליקציה, FCM משתמש במזהה הערוץ שצוין במניפסט האפליקציה.
clickAction חוּט פעולה הקשורה למשתמש לחץ על ההודעה. אם צוין, פעילות עם מסנן כוונות תואם מופעלת כאשר משתמש לוחץ על ההודעה.
צֶבַע חוּט צבע סמל הודעה בפורמט #rrggbb .
defaultLightSettings בוליאני אם מוגדר כ- true , השתמש בהגדרות ברירת המחדל של תאורת LED של מסגרת Android עבור ההתראה. ערכי ברירת המחדל מצוינים ב- config.xml . אם default_light_settings מוגדרת כ- true וגם light_settings מוגדרת, נעשה שימוש light_settings שצוינו על ידי המשתמש במקום ערך ברירת המחדל.
defaultSound בוליאני אם מוגדר כ- true , השתמש בצליל ברירת המחדל של מסגרת Android עבור ההתראה. ערכי ברירת המחדל מצוינים ב- config.xml .
defaultVibrateTimes בוליאני אם מוגדר כ- true , השתמש בדפוס הרטט המוגדר כברירת מחדל של מסגרת Android עבור ההתראה. ערכי ברירת המחדל מצוינים ב- config.xml . אם default_vibrate_timings מוגדר כ- true וגם vibrate_timings מוגדר, ערך ברירת המחדל משמש במקום vibrate_timings שצוינו על ידי המשתמש.
eventTimestamp תַאֲרִיך עבור התראות המודיעות למשתמשים על אירועים עם התייחסות זמן מוחלטת, מגדיר את הזמן שבו האירוע בהודעה התרחש. ההתראות בחלונית ממוינות לפי זמן זה.
סמל חוּט משאב סמלים עבור הודעת אנדרואיד.
כתובת אתר של תמונה חוּט כתובת URL של תמונה שתוצג בהתראה.
הגדרות אור LightSettings הגדרות לשליטה בקצב ההבהוב של ה-LED של ההתראה ובצבע אם LED זמין במכשיר. זמן ההבהוב הכולל נשלט על ידי מערכת ההפעלה.
מקומי בלבד בוליאני מגדיר אם הודעה זו רלוונטית רק למכשיר הנוכחי או לא. ניתן לגשר הודעות מסוימות למכשירים אחרים לצורך תצוגה מרחוק, כגון שעון Wear OS. ניתן להגדיר רמז זה כך שימליץ שלא לגשר על הודעה זו. ראה מדריכי Wear OS .
notificationCount מספר מגדיר את מספר הפריטים שההודעה הזו מייצגת. עשוי להיות מוצג כספירת תגים עבור משגרים התומכים בתג. ראה NotificationBadge . לדוגמה, זה עשוי להיות שימושי אם אתה משתמש רק בהתראה אחת כדי לייצג מספר הודעות חדשות, אבל אתה רוצה שהספירה כאן תייצג את מספר ההודעות החדשות הכוללות. אם אפס או לא צוין, מערכות התומכות בתג משתמשות בברירת המחדל, שהיא הגדלה של מספר המוצג בתפריט לחיצה ארוכה בכל פעם שמגיעה הודעה חדשה.
עדיפות ('min' | 'low' | 'default' | 'high' | 'max') מגדיר את העדיפות היחסית עבור הודעה זו. הודעות בעדיפות נמוכה עשויות להיות מוסתרות מהמשתמש במצבים מסוימים. שימו לב שהעדיפות הזו שונה מ- AndroidMessagePriority . עדיפות זו מעובדת על ידי הלקוח לאחר מסירת ההודעה. ואילו AndroidMessagePriority הוא מושג FCM השולט מתי ההודעה מועברת.
נשמע חוּט שם הקובץ של הצליל שיושמע כשהמכשיר יקבל את ההתראה.
דָבִיק בוליאני כאשר מוגדר false או לא מוגדר, ההתראה נדחית אוטומטית כאשר המשתמש לוחץ עליה בחלונית. כאשר מוגדר כ- true , ההודעה נמשכת גם כאשר המשתמש לוחץ עליה.
תָג חוּט תג הודעה. זהו מזהה המשמש להחלפת הודעות קיימות במגירת ההודעות. אם לא צוין, כל בקשה יוצרת הודעה חדשה.
טֵלֵפּרִינטֶר חוּט מגדיר את טקסט ה"טיקר", שנשלח לשירותי נגישות. לפני רמת API 21 (Lollipop), מגדיר את הטקסט שיוצג בשורת המצב כאשר ההודעה מגיעה לראשונה.
כותרת חוּט כותרת הודעת האנדרואיד. כאשר מסופק, עוקף את הכותרת שהוגדרה דרך admin.messaging.Notification .
titleLocArgs חוּט[] מערך של מפתחות משאבים שישמשו במקום מפרטי הפורמט ב- titleLocKey .
titleLocKey חוּט מפתח של מחרוזת הכותרת במשאב המחרוזת של האפליקציה לשימוש כדי להתאים את טקסט הכותרת.
vibrateTimingsMillis מספר[] מגדיר את דפוס הרטט לשימוש. העבירו מערך של אלפיות שניות כדי להפעיל או לכבות את הוויברטור. הערך הראשון מציין את משך ההמתנה לפני הפעלת הוויברטור. הערך הבא מציין את משך הזמן לשמירה על הוויברטור. הערכים הבאים מתחלפים בין משך זמן כיבוי הוויברטור להפעלת הרטט. אם vibrate_timings מוגדר ו- default_vibrate_timings מוגדר כ- true , ערך ברירת המחדל משמש במקום vibrate_timings שצוין על ידי המשתמש.
רְאוּת ('פרטי' | 'ציבורי' | 'סודי') מגדיר את החשיפה של ההודעה. חייב להיות private , public או secret . אם לא צוין, ברירת המחדל היא private .

AndroidNotification.body

גוף הודעת האנדרואיד. כאשר מסופק, עוקף את הגוף שהוגדר דרך admin.messaging.Notification .

חֲתִימָה:

body?: string;

AndroidNotification.bodyLocArgs

מערך של מפתחות משאבים שישמשו במקום מפרטי הפורמט ב- bodyLocKey .

חֲתִימָה:

bodyLocArgs?: string[];

AndroidNotification.bodyLocKey

מפתח של מחרוזת הגוף במשאב המחרוזת של האפליקציה לשימוש כדי להתאים את גוף הטקסט.

חֲתִימָה:

bodyLocKey?: string;

AndroidNotification.channelId

מזהה ערוץ ההתראות של Android (חדש ב-Android O). על האפליקציה ליצור ערוץ עם מזהה ערוץ זה לפני שניתן יהיה לקבל הודעה כלשהי עם מזהה ערוץ זה. אם לא תשלח את מזהה הערוץ הזה בבקשה, או אם מזהה הערוץ שסופק עדיין לא נוצר על ידי האפליקציה, FCM משתמש במזהה הערוץ שצוין במניפסט האפליקציה.

חֲתִימָה:

channelId?: string;

AndroidNotification.clickAction

פעולה הקשורה למשתמש לחץ על ההודעה. אם צוין, פעילות עם מסנן כוונות תואם מופעלת כאשר משתמש לוחץ על ההודעה.

חֲתִימָה:

clickAction?: string;

AndroidNotification.color

צבע סמל הודעה בפורמט #rrggbb .

חֲתִימָה:

color?: string;

AndroidNotification.defaultLightSettings

אם מוגדר כ- true , השתמש בהגדרות ברירת המחדל של תאורת LED של מסגרת Android עבור ההתראה. ערכי ברירת המחדל מצוינים ב- config.xml . אם default_light_settings מוגדרת כ- true וגם light_settings מוגדרת, נעשה שימוש light_settings שצוינו על ידי המשתמש במקום ערך ברירת המחדל.

חֲתִימָה:

defaultLightSettings?: boolean;

AndroidNotification.defaultSound

אם מוגדר כ- true , השתמש בצליל ברירת המחדל של מסגרת Android עבור ההתראה. ערכי ברירת המחדל מצוינים ב- config.xml .

חֲתִימָה:

defaultSound?: boolean;

AndroidNotification.defaultVibrateTimings

אם מוגדר כ- true , השתמש בדפוס הרטט המוגדר כברירת מחדל של מסגרת Android עבור ההתראה. ערכי ברירת המחדל מצוינים ב- config.xml . אם default_vibrate_timings מוגדר כ- true וגם vibrate_timings מוגדר, ערך ברירת המחדל משמש במקום vibrate_timings שצוינו על ידי המשתמש .

חֲתִימָה:

defaultVibrateTimings?: boolean;

AndroidNotification.eventTimestamp

עבור התראות המודיעות למשתמשים על אירועים עם התייחסות זמן מוחלטת, מגדיר את הזמן שבו האירוע בהודעה התרחש. ההתראות בחלונית ממוינות לפי זמן זה.

חֲתִימָה:

eventTimestamp?: Date;

AndroidNotification.icon

משאב סמלים עבור הודעת אנדרואיד.

חֲתִימָה:

icon?: string;

AndroidNotification.imageUrl

כתובת URL של תמונה שתוצג בהתראה.

חֲתִימָה:

imageUrl?: string;

AndroidNotification.lightSettings

הגדרות לשליטה בקצב ההבהוב של ה-LED של ההתראה ובצבע אם LED זמין במכשיר. זמן ההבהוב הכולל נשלט על ידי מערכת ההפעלה.

חֲתִימָה:

lightSettings?: LightSettings;

AndroidNotification.localOnly

מגדיר אם הודעה זו רלוונטית רק למכשיר הנוכחי או לא. ניתן לגשר הודעות מסוימות למכשירים אחרים לצורך תצוגה מרחוק, כגון שעון Wear OS. ניתן להגדיר רמז זה כך שימליץ שלא לגשר על הודעה זו. ראה מדריכי Wear OS .

חֲתִימָה:

localOnly?: boolean;

AndroidNotification.notificationCount

מגדיר את מספר הפריטים שההודעה הזו מייצגת. עשוי להיות מוצג כספירת תגים עבור משגרים התומכים בתג. ראה NotificationBadge . לדוגמה, זה עשוי להיות שימושי אם אתה משתמש רק בהתראה אחת כדי לייצג מספר הודעות חדשות, אבל אתה רוצה שהספירה כאן תייצג את מספר ההודעות החדשות הכוללות. אם אפס או לא צוין, מערכות התומכות בתג משתמשות בברירת המחדל, שהיא הגדלה של מספר המוצג בתפריט לחיצה ארוכה בכל פעם שמגיעה הודעה חדשה.

חֲתִימָה:

notificationCount?: number;

AndroidNotification.priority

מגדיר את העדיפות היחסית עבור הודעה זו. הודעות בעדיפות נמוכה עשויות להיות מוסתרות מהמשתמש במצבים מסוימים. שימו לב שעדיפות זו שונה מ- AndroidMessagePriority . עדיפות זו מעובדת על ידי הלקוח לאחר מסירת ההודעה. ואילו AndroidMessagePriority הוא מושג FCM השולט מתי ההודעה מועברת.

חֲתִימָה:

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

AndroidNotification.sound

שם הקובץ של הצליל שיושמע כשהמכשיר יקבל את ההתראה.

חֲתִימָה:

sound?: string;

AndroidNotification.sticky

כאשר מוגדר false או לא מוגדר, ההתראה נדחית אוטומטית כאשר המשתמש לוחץ עליה בחלונית. כאשר מוגדר כ- true , ההודעה נמשכת גם כשהמשתמש לוחץ עליה.

חֲתִימָה:

sticky?: boolean;

AndroidNotification.tag

תג הודעה. זהו מזהה המשמש להחלפת הודעות קיימות במגירת ההודעות. אם לא צוין, כל בקשה יוצרת הודעה חדשה.

חֲתִימָה:

tag?: string;

AndroidNotification.ticker

מגדיר את טקסט ה"טיקר", שנשלח לשירותי נגישות. לפני רמת API 21 (Lollipop), מגדיר את הטקסט שיוצג בשורת המצב כאשר ההודעה מגיעה לראשונה.

חֲתִימָה:

ticker?: string;

AndroidNotification.title

כותרת הודעת האנדרואיד. כאשר מסופק, עוקף את הכותרת שהוגדרה דרך 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.visibility

מגדיר את החשיפה של ההודעה. חייב להיות או private , public , או secret . אם לא מצוין, ברירת המחדל היא private .

חֲתִימָה:

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