ממשק המייצג עומס הודעת הודעות API מדור קודם של FCM. הודעות התראה מאפשרות למפתחים לשלוח עד 4KB של זוגות מפתח-ערך מוגדרים מראש. מפתחות מקובלים מפורטים להלן.
ראה בניית בקשות לשלוח עבור דוגמאות קוד ותיעוד מפורט.
חֲתִימָה:
export interface NotificationMessagePayload
נכסים
| תכונה | סוּג | תיאור |
|---|---|---|
| תָג | חוּט | ערך התג בסמל האפליקציה במסך הבית. אם לא צוין, התג לא משתנה. אם מוגדר ל 0 , התג יוסר. **פלטפורמות:** iOS |
| גוּף | חוּט | גוף ההודעה. **פלטפורמות:** iOS, Android, אינטרנט |
| bodyLocArgs | חוּט | ערכי מחרוזת משתנים שישמשו במקום מפרטי הפורמט ב- body_loc_key לשימוש כדי להתאים את גוף הטקסט ללוקליזציה הנוכחית של המשתמש. הערך צריך להיות מערך JSON מחרוזת. **iOS:** מתאים ל- loc-args במטען ה-APN. ראה הפניה למפתח מטען ולוקליזציה של התוכן של ההודעות המרוחקות שלך למידע נוסף. **אנדרואיד:** ראה עיצוב ועיצוב למידע נוסף. **פלטפורמות:** iOS, אנדרואיד |
| bodyLocKey | חוּט | המפתח למחרוזת הגוף במשאבי המחרוזת של האפליקציה לשימוש כדי לבצע לוקליזציה של טקסט הגוף ללוקליזציה הנוכחית של המשתמש. **iOS:** מתאים למקש loc-key במטען ה-APN. ראה הפניה למפתח מטען ולוקליזציה של התוכן של ההודעות המרוחקות שלך למידע נוסף. **אנדרואיד:** ראה משאבי מחרוזת למידע נוסף. **פלטפורמות:** iOS, אנדרואיד |
| clickAction | חוּט | פעולה הקשורה למשתמש לחץ על ההודעה. אם צוין, פעילות עם מסנן כוונות תואם מופעלת כאשר משתמש לוחץ על ההודעה. * **פלטפורמות:** אנדרואיד |
| צֶבַע | חוּט | צבע סמל ההודעה, מבוטא בפורמט #rrggbb . **פלטפורמות:** אנדרואיד |
| סמל | חוּט | סמל ההודעה. **אנדרואיד:** מגדיר את סמל ההתראות ל- myicon עבור myicon של משאבים שניתן לצייר. אם לא תשלח מפתח זה בבקשה, FCM מציג את סמל המפעיל שצוין במניפסט האפליקציה שלך. **אינטרנט:** כתובת האתר לשימוש עבור סמל ההודעה. **פלטפורמות:** אנדרואיד, אינטרנט |
| נשמע | חוּט | הצליל שיושמע כאשר המכשיר מקבל התראה. תומך ב"ברירת מחדל" עבור צליל ההתראה המוגדר כברירת מחדל של המכשיר או שם הקובץ של משאב קול ארוז באפליקציה. קבצי הקול חייבים להיות ב- /res/raw/ . **פלטפורמות:** אנדרואיד |
| תָג | חוּט | מזהה המשמש להחלפת הודעות קיימות במגירת ההודעות. אם לא צוין, כל בקשה יוצרת הודעה חדשה. אם צוין וכבר מוצגת הודעה עם אותו תג, ההודעה החדשה מחליפה את הקיימת במגירת ההודעות. **פלטפורמות:** אנדרואיד |
| כותרת | חוּט | כותרת ההודעה. **פלטפורמות:** iOS, Android, אינטרנט |
| titleLocArgs | חוּט | ערכי מחרוזת משתנים שישמשו במקום מפרטי הפורמט ב- title_loc_key לשימוש כדי להתאים את טקסט הכותרת ללוקליזציה הנוכחית של המשתמש. הערך צריך להיות מערך JSON מחרוזת. **iOS:** מתאים ל- title-loc-args במטען ה-APN. ראה הפניה למפתח מטען ולוקליזציה של התוכן של ההודעות המרוחקות שלך למידע נוסף. **אנדרואיד:** ראה עיצוב ועיצוב למידע נוסף. **פלטפורמות:** iOS, אנדרואיד |
| titleLocKey | חוּט | המפתח למחרוזת הכותרת במשאבי המחרוזת של האפליקציה לשימוש כדי לבצע לוקליזציה של טקסט הכותרת ללוקליזציה הנוכחית של המשתמש. **iOS:** מקביל ל- title-loc-key במטען ה-APN. ראה הפניה למפתח מטען ולוקליזציה של התוכן של ההודעות המרוחקות שלך למידע נוסף. **אנדרואיד:** ראה משאבי מחרוזת למידע נוסף. **פלטפורמות:** iOS, אנדרואיד |
NotificationMessagePayload.badge
ערך התג בסמל האפליקציה במסך הבית.
אם לא צוין, התג לא משתנה.
אם מוגדר ל 0 , התג מוסר.
**פלטפורמות:** iOS
חֲתִימָה:
badge?: string;
NotificationMessagePayload.body
גוף ההודעה.
**פלטפורמות:** iOS, Android, אינטרנט
חֲתִימָה:
body?: string;
NotificationMessagePayload.bodyLocArgs
ערכי מחרוזת משתנים שישמשו במקום מפרטי הפורמט ב- body_loc_key לשימוש כדי להתאים את גוף הטקסט ללוקליזציה הנוכחית של המשתמש.
הערך צריך להיות מערך JSON מחרוזת.
**iOS:** מתאים ל- loc-args במטען ה-APN. ראה הפניה למפתח מטען ולוקליזציה של התוכן של ההודעות המרוחקות שלך למידע נוסף.
**אנדרואיד:** ראה עיצוב ועיצוב למידע נוסף.
**פלטפורמות:** iOS, אנדרואיד
חֲתִימָה:
bodyLocArgs?: string;
NotificationMessagePayload.bodyLocKey
המפתח למחרוזת הגוף במשאבי המחרוזת של האפליקציה לשימוש כדי לבצע לוקליזציה של טקסט הגוף ללוקליזציה הנוכחית של המשתמש.
**iOS:** מתאים למקש loc-key במטען ה-APN. ראה הפניה למפתח מטען ולוקליזציה של התוכן של ההודעות המרוחקות שלך למידע נוסף.
**אנדרואיד:** ראה משאבי מחרוזת למידע נוסף.
**פלטפורמות:** iOS, אנדרואיד
חֲתִימָה:
bodyLocKey?: string;
NotificationMessagePayload.clickAction
פעולה הקשורה למשתמש לחץ על ההודעה. אם צוין, פעילות עם מסנן כוונות תואם מופעלת כאשר משתמש לוחץ על ההודעה.
* **פלטפורמות:** אנדרואיד
חֲתִימָה:
clickAction?: string;
NotificationMessagePayload.color
צבע סמל ההודעה, מבוטא בפורמט #rrggbb .
**פלטפורמות:** אנדרואיד
חֲתִימָה:
color?: string;
NotificationMessagePayload.icon
סמל ההודעה.
**אנדרואיד:** מגדיר את סמל ההתראות ל- myicon עבור myicon של משאבים שניתן לצייר . אם לא תשלח מפתח זה בבקשה, FCM מציג את סמל המפעיל שצוין במניפסט האפליקציה שלך.
**אינטרנט:** כתובת האתר לשימוש עבור סמל ההודעה.
**פלטפורמות:** אנדרואיד, אינטרנט
חֲתִימָה:
icon?: string;
NotificationMessagePayload.sound
הצליל שיושמע כאשר המכשיר מקבל התראה. תומך ב"ברירת מחדל" עבור צליל ההתראה המוגדר כברירת מחדל של המכשיר או שם הקובץ של משאב קול ארוז באפליקציה. קבצי הקול חייבים להיות ב- /res/raw/ .
**פלטפורמות:** אנדרואיד
חֲתִימָה:
sound?: string;
NotificationMessagePayload.tag
מזהה המשמש להחלפת הודעות קיימות במגירת ההודעות.
אם לא צוין, כל בקשה יוצרת הודעה חדשה.
אם צוין וכבר מוצגת הודעה עם אותו תג, ההודעה החדשה מחליפה את הקיימת במגירת ההודעות.
**פלטפורמות:** אנדרואיד
חֲתִימָה:
tag?: string;
NotificationMessagePayload.title
כותרת ההודעה.
**פלטפורמות:** iOS, Android, אינטרנט
חֲתִימָה:
title?: string;
NotificationMessagePayload.titleLocArgs
ערכי מחרוזת משתנים שישמשו במקום מפרטי הפורמט ב- title_loc_key לשימוש כדי להתאים את טקסט הכותרת ללוקליזציה הנוכחית של המשתמש.
הערך צריך להיות מערך JSON מחרוזת.
**iOS:** מתאים ל- title-loc-args במטען ה-APN. ראה הפניה למפתח מטען ולוקליזציה של התוכן של ההודעות המרוחקות שלך למידע נוסף.
**אנדרואיד:** ראה עיצוב ועיצוב למידע נוסף.
**פלטפורמות:** iOS, אנדרואיד
חֲתִימָה:
titleLocArgs?: string;
NotificationMessagePayload.titleLocKey
המפתח למחרוזת הכותרת במשאבי המחרוזת של האפליקציה לשימוש כדי לבצע לוקליזציה של טקסט הכותרת ללוקליזציה הנוכחית של המשתמש.
**iOS:** מקביל ל- title-loc-key במטען ה-APN. ראה הפניה למפתח מטען ולוקליזציה של התוכן של ההודעות המרוחקות שלך למידע נוסף.
**אנדרואיד:** ראה משאבי מחרוזת למידע נוסף.
**פלטפורמות:** iOS, אנדרואיד
חֲתִימָה:
titleLocKey?: string;