@firebase/messaging/sw

פונקציות

פוּנקצִיָה תיאור
פונקציה (אפליקציה,...)
getMessaging(אפליקציה) מאחזר מופע Firebase Cloud Messaging.
פונקציה (הודעות, ...)
experimentalSetDeliveryMetricsExportedToBigQueryEnabled(הודעות, הפעל) מפעיל או משבית את ערכי מסירת ההודעות של Firebase Cloud Messaging אל BigQuery. כברירת מחדל, ערכי מסירת הודעות אינם מיוצאים אל BigQuery. השתמש בשיטה זו כדי להפעיל או להשבית את הייצוא בזמן ריצה.
onBackgroundMessage(messaging, nextOrObserver) נקרא כאשר מתקבלת הודעה כשהאפליקציה ברקע. אפליקציה נחשבת ברקע אם לא מוצג חלון פעיל.
פוּנקצִיָה()
נתמך() בודק אם כל ממשקי ה-API הנדרשים קיימים בתוך SW Context

ממשקים

מִמְשָׁק תיאור
FcmOptions אפשרויות לתכונות הניתנות על ידי FCM SDK for Web. ראה WebpushFcmOptions .
GetTokenOptions אפשרויות עבור getToken() .
MessagePayload מטען הודעות שמכיל את מטען ההודעות המיוצג עם NotificationPayload ואת מטען הנתונים שמכיל מספר שרירותי של זוגות מפתח-ערך שנשלחו על ידי מפתחים דרך ממשק ה- API של שלח .
הודעות ממשק ציבורי של Firebase Cloud Messaging SDK.
NotificationPayload הצג פרטי הודעה. הפרטים נשלחים דרך ה- API של שלח .

פונקציה (אפליקציה,...)

getMessaging(אפליקציה)

מאחזר מופע Firebase Cloud Messaging.

חֲתִימָה:

export declare function getMessagingInSw(app?: FirebaseApp): Messaging;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפליקציה FirebaseApp

החזרות:

הודעות

מופע Firebase Cloud Messaging המשויך לאפליקציית Firebase שסופקה.

פונקציה (הודעות, ...)

experimentalSetDeliveryMetricsExportedToBigQueryEnabled(הודעות, הפעל)

מפעיל או משבית את ערכי מסירת ההודעות של Firebase Cloud Messaging אל BigQuery. כברירת מחדל, ערכי מסירת הודעות אינם מיוצאים אל BigQuery. השתמש בשיטה זו כדי להפעיל או להשבית את הייצוא בזמן ריצה.

חֲתִימָה:

export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
הודעות הודעות מופע FirebaseMessaging .
לְאַפשֵׁר בוליאני האם Firebase Cloud Messaging צריך לייצא מדדי מסירת הודעות ל-BigQuery.

החזרות:

בָּטֵל

onBackgroundMessage(messaging, nextOrObserver)

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

חֲתִימָה:

export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
הודעות הודעות מופע ההודעות .
nextOrObserver NextFn < MessagePayload > | מַשׁקִיף < MessagePayload > פונקציה זו, או אובייקט צופה עם ההגדרה next , נקראת כאשר מתקבלת הודעה והאפליקציה נמצאת כרגע ברקע.

החזרות:

בטל את הרישום

כדי להפסיק להאזין להודעות, בצע את הפונקציה שהוחזרה

פוּנקצִיָה()

נתמך()

בודק אם כל ממשקי ה-API הנדרשים קיימים בתוך SW Context

חֲתִימָה:

export declare function isSwSupported(): Promise<boolean>;

החזרות:

הבטחה<בוליאנית>

הבטחה שנפתרת לבוליאן.