Firebase Cloud Messaging (FCM).
פונקציות
פוּנקצִיָה | תיאור |
---|---|
getMessaging(אפליקציה) | מקבל את שירות ההודעות עבור אפליקציית ברירת המחדל או אפליקציה נתונה. ניתן לקרוא admin.messaging() ללא ארגומנטים לגישה לשירות Messaging של אפליקציית ברירת המחדל או כ- admin.messaging(app) כדי לגשת לשירות Messaging המשויך לאפליקציה ספציפית. |
שיעורים
מעמד | תיאור |
---|---|
הודעות | שירות הודעות קשור לאפליקציה שסופקה. |
ממשקים
מִמְשָׁק | תיאור |
---|---|
AndroidConfig | מייצג את האפשרויות הספציפיות לאנדרואיד שניתן לכלול בהודעה . |
AndroidFcmOptions | מייצג אפשרויות לתכונות המסופקות על ידי FCM SDK עבור Android. |
AndroidNotification | מייצג את אפשרויות ההתראות הספציפיות לאנדרואיד שניתן לכלול ב- AndroidConfig . |
ApnsConfig | מייצג את האפשרויות הספציפיות ל-APNs שניתן לכלול בהודעה . עיין בתיעוד של Apple עבור כותרות ושדות מטען שונים הנתמכים על ידי APNs. |
ApnsFcmOptions | מייצג אפשרויות לתכונות המסופקות על ידי FCM SDK עבור iOS. |
ApnsPayload | מייצג את המטען של הודעת APNs. מורכב בעיקר ממילון aps . אבל עשוי להכיל גם מפתחות מותאמים אישית שרירותיים אחרים. |
Aps | מייצג את מילון ה-aps שהוא חלק מהודעות APN. |
ApsAlert | |
BaseMessage | |
BatchResponse | ממשק המייצג את תגובת השרת מהשיטות Messaging.sendAll() ו- Messaging.sendMulticast() . |
ConditionMessage | |
CriticalSound | מייצג תצורת סאונד קריטית שניתן לכלול במילון aps של מטען APNs. |
DataMessagePayload | ממשק המייצג מטען נתוני API מדור קודם של FCM. הודעות נתונים מאפשרות למפתחים לשלוח עד 4KB של זוגות מפתח-ערך מותאמים אישית. המפתחות והערכים חייבים להיות מחרוזות. המפתחות יכולים להיות כל מחרוזת מותאמת אישית, למעט המחרוזות השמורות הבאות:
|
FcmOptions | מייצג אפשרויות בלתי תלויות בפלטפורמה עבור תכונות המסופקות על ידי ערכות ה-FCM SDK. |
LightSettings | מייצג הגדרות לשליטה ב-LED של התראות שניתן לכלול ב- AndroidNotification . |
MessagingConditionResponse | ממשק המייצג את תגובת השרת משיטת Messaging.sendToCondition() מדור קודם. ראה שלח לתנאי לדוגמאות קוד ותיעוד מפורט. |
MessagingDeviceGroupResponse | ממשק המייצג את תגובת השרת משיטת Messaging.sendToDeviceGroup() . ראה שליחת הודעות לקבוצות מכשירים לקבלת דוגמאות קוד ותיעוד מפורט. |
MessagingDeviceResult | עומס תגובת סטטוס אינדיבידואלי ממכשירים בודדים |
הודעות התקנים תגובה | ממשק המייצג את המצב של הודעה שנשלחה למכשיר בודד באמצעות ממשקי ה-API מדור קודם של FCM. ראה שליחה למכשירים בודדים לקבלת דוגמאות קוד ותיעוד מפורט. |
אפשרויות הודעות | ממשק המייצג את האפשרויות שניתן לספק בעת שליחת הודעה דרך ממשקי ה-API מדור קודם של FCM. ראה בניית בקשות לשלוח עבור דוגמאות קוד ותיעוד מפורט. |
MessagingPayload | ממשק המייצג מטען הודעות של Firebase Cloud Messaging. יש צורך באחד ממפתחות data notification או שניהם. ראה בניית בקשות לשלוח עבור דוגמאות קוד ותיעוד מפורט. |
MessagingTopicManagementResponse | ממשק המייצג את תגובת השרת מהשיטות Messaging.subscribeToTopic() ו- Messaging.unsubscribeFromTopic() . ראה ניהול נושאים מהשרת לדוגמאות קוד ותיעוד מפורט. |
MessagingTopicResponse | ממשק המייצג את תגובת השרת משיטת Messaging.sendToTopic() מדור קודם. ראה שלח לנושא לדוגמאות קוד ותיעוד מפורט. |
MulticastMessage | מטען עבור שיטת Messaging.sendMulticast() . המטען מכיל את כל השדות בסוג BaseMessage, ורשימת אסימונים. |
הוֹדָעָה | הודעה שניתן לכלול בהודעה . |
NotificationMessagePayload | ממשק המייצג עומס הודעת הודעות API מדור קודם של FCM. הודעות התראה מאפשרות למפתחים לשלוח עד 4KB של זוגות מפתח-ערך מוגדרים מראש. מפתחות מקובלים מפורטים להלן. ראה בניית בקשות לשלוח עבור דוגמאות קוד ותיעוד מפורט. |
שלח תגובה | ממשק המייצג את המצב של הודעה בודדת שנשלחה כחלק מבקשת אצווה. |
TokenMessage | |
TopicMessage | |
WebpushConfig | מייצג את אפשרויות פרוטוקול WebPush שניתן לכלול בהודעה . |
WebpushFcmOptions | מייצג אפשרויות לתכונות המסופקות על ידי FCM SDK for Web (שאינן חלק מתקן Webpush). |
WebpushNotification | מייצג את אפשרויות ההתראה הספציפיות ל-WebPush שניתן לכלול ב- WebpushConfig . זה תומך ברוב האפשרויות הסטנדרטיות כפי שהוגדרו במפרט Web Notification . |
הקלד כינויים
הקלד כינוי | תיאור |
---|---|
הוֹדָעָה | מטען עבור פעולת Messaging.send() . המטען מכיל את כל השדות בסוג BaseMessage, ובדיוק אחד של אסימון, נושא או תנאי. |
getMessaging()
מקבל את שירות ההודעות עבור אפליקציית ברירת המחדל או אפליקציה נתונה.
ניתן לקרוא admin.messaging()
ללא ארגומנטים לגישה לשירות Messaging
של אפליקציית ברירת המחדל או כ- admin.messaging(app)
כדי לגשת לשירות Messaging
המשויך לאפליקציה ספציפית.
חֲתִימָה:
export declare function getMessaging(app?: App): Messaging;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
אפליקציה | אפליקציה | אפליקציה אופציונלית ששירות Messaging שלה להחזיר. אם לא יסופק, שירות ברירת המחדל Messaging יוחזר. |
החזרות:
שירות Messaging
ברירת המחדל אם לא מסופקת אפליקציה או שירות Messaging
המשויך לאפליקציה שסופקה.
דוגמה 1
// Get the Messaging service for the default app
const defaultMessaging = getMessaging();
דוגמה 2
// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);
הוֹדָעָה
מטען עבור פעולת Messaging.send() . המטען מכיל את כל השדות בסוג BaseMessage, ובדיוק אחד של אסימון, נושא או תנאי.
חֲתִימָה:
export type Message = TokenMessage | TopicMessage | ConditionMessage;