MessagingOptions interface

ממשק המייצג את האפשרויות שניתן לספק בעת שליחת הודעה דרך ממשקי ה-API מדור קודם של FCM.

ראה בניית בקשות לשלוח עבור דוגמאות קוד ותיעוד מפורט.

חֲתִימָה:

export interface MessagingOptions 

נכסים

תכונה סוּג תיאור
collapseKey חוּט מחרוזת המזהה קבוצת הודעות (לדוגמה, "עדכונים זמינים") שניתן לכווץ, כך שרק ההודעה האחרונה נשלחת כאשר ניתן לחדש את המסירה. זה משמש כדי למנוע שליחת יותר מדי מאותן הודעות כשהמכשיר חוזר לאינטרנט או הופך לפעיל. אין ערובה לסדר שליחת ההודעות. מותר לכל היותר ארבעה מפתחות כיווץ שונים בכל זמן נתון. המשמעות היא ששרת FCM יכול לאחסן בו זמנית ארבע הודעות שונות של שליחה לסנכרון לכל אפליקציית לקוח. אם תחרוג ממספר זה, אין ערובה אילו ארבעה מפתחות כיווץ ישמור שרת FCM. **ערך ברירת מחדל:** אין
תוכן זמין בוליאני ב-iOS, השתמש בשדה זה כדי לייצג content-available במטען ה-APN. כאשר נשלחת הודעה או הודעת נתונים וזה מוגדר כ- true , אפליקציית לקוח לא פעילה מתעוררת. ב-Android, הודעות נתונים מעירות את האפליקציה כברירת מחדל. ב-Chrome, הדגל הזה אינו נתמך כרגע. **ערך ברירת מחדל:** false
ריצה יבשה בוליאני האם אכן יש לשלוח את ההודעה או לא. כאשר מוגדר כ- true , מאפשר למפתחים לבדוק בקשה מבלי לשלוח הודעה בפועל. כאשר מוגדר כ- false , ההודעה תישלח. **ערך ברירת מחדל:** false
mutableContent בוליאני ב-iOS, השתמש בשדה זה כדי לייצג mutable-content במטען ה-APN. כאשר הודעה נשלחת וזה מוגדר כ- true , ניתן לשנות את תוכן ההודעה לפני הצגתה, באמצעות תוסף אפליקציית Notification Service . באנדרואיד ובאינטרנט, הפרמטר הזה יתעלם. **ערך ברירת מחדל:** false
עדיפות חוּט העדיפות של ההודעה. ערכים חוקיים הם "normal" "high". ב-iOS, אלה תואמים את סדר העדיפויות של APN 5 ו 10 . כברירת מחדל, הודעות התראה נשלחות בעדיפות גבוהה, והודעות נתונים נשלחות בעדיפות רגילה. עדיפות רגילה מייעלת את צריכת הסוללה של אפליקציית הלקוח ויש להשתמש בה אלא אם נדרשת אספקה ​​מיידית. עבור הודעות עם עדיפות רגילה, האפליקציה עשויה לקבל את ההודעה באיחור לא מוגדר. כאשר הודעה נשלחת בעדיפות גבוהה, היא נשלחת מיד, והאפליקציה יכולה להעיר מכשיר שינה ולפתוח חיבור רשת לשרת שלך. למידע נוסף, ראה הגדרת עדיפות של הודעה . **ערך ברירת מחדל:** "high" עבור הודעות התראה, "normal" עבור הודעות נתונים
restrictedPackageName חוּט שם החבילה של האפליקציה שאסימוני הרישום חייבים להתאים כדי לקבל את ההודעה. **ערך ברירת מחדל:** אין
זמן לחיות מספר כמה זמן (בשניות) יש לשמור את ההודעה באחסון FCM אם המכשיר לא מקוון. הזמן המקסימלי לחיות נתמך הוא ארבעה שבועות, וערך ברירת המחדל הוא גם ארבעה שבועות. למידע נוסף, ראה הגדרת תוחלת החיים של הודעה . **ערך ברירת מחדל:** 2419200 (המייצג ארבעה שבועות, בשניות)

MessagingOptions.collapseKey

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

אין ערובה לסדר שליחת ההודעות.

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

**ערך ברירת מחדל:** אין

חֲתִימָה:

collapseKey?: string;

MessagingOptions.contentAvailable

ב-iOS, השתמש בשדה זה כדי לייצג content-available במטען ה-APN. כאשר נשלחת הודעה או הודעת נתונים וזה מוגדר כ- true , אפליקציית לקוח לא פעילה מתעוררת. ב-Android, הודעות נתונים מעירות את האפליקציה כברירת מחדל. ב-Chrome, הדגל הזה אינו נתמך כרגע.

**ערך ברירת מחדל:** false

חֲתִימָה:

contentAvailable?: boolean;

MessagingOptions.dryRun

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

**ערך ברירת מחדל:** false

חֲתִימָה:

dryRun?: boolean;

MessagingOptions.mutableContent

ב-iOS, השתמש בשדה זה כדי לייצג mutable-content במטען ה-APN. כאשר נשלחת הודעה וזה מוגדר כ- true , ניתן לשנות את תוכן ההודעה לפני הצגתה, באמצעות תוסף אפליקציית שירות התראות .

באנדרואיד ובאינטרנט, הפרמטר הזה יתעלם.

**ערך ברירת מחדל:** false

חֲתִימָה:

mutableContent?: boolean;

הודעות אפשרויות.עדיפות

העדיפות של ההודעה. ערכים חוקיים הם "normal" "high". ב-iOS, אלה תואמים לעדיפויות APN 5 ו 10 .

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

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

למידע נוסף, ראה הגדרת עדיפות של הודעה .

**ערך ברירת מחדל:** "high" עבור הודעות התראה, "normal" עבור הודעות נתונים

חֲתִימָה:

priority?: string;

MessagingOptions.restrictedPackageName

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

**ערך ברירת מחדל:** אין

חֲתִימָה:

restrictedPackageName?: string;

MessagingOptions.timeToLive

כמה זמן (בשניות) יש לשמור את ההודעה באחסון FCM אם המכשיר לא מקוון. הזמן המקסימלי לחיות נתמך הוא ארבעה שבועות, וערך ברירת המחדל הוא גם ארבעה שבועות. למידע נוסף, ראה הגדרת תוחלת החיים של הודעה .

**ערך ברירת מחדל:** 2419200 (המייצג ארבעה שבועות, בשניות)

חֲתִימָה:

timeToLive?: number;