פונקציות
| פוּנקצִיָה | תיאור |
|---|---|
| פונקציה (אפליקציה,...) | |
| getMessaging(אפליקציה) | מאחזר מופע Firebase Cloud Messaging. |
| פונקציה (הודעות, ...) | |
| deleteToken(הודעות) | מוחק את אסימון הרישום המשויך למופע הודעות זה ומבטל את הרישום למופע ההודעות ממנוי הדחיפה. |
| getToken(הודעות, אפשרויות) | נרשם כמנוי למופע ההודעות כדי לדחוף התראות. מחזירה אסימון רישום של Firebase Cloud Messaging שניתן להשתמש בו כדי לשלוח הודעות דחיפה לאותו מופע הודעות . אם עדיין לא ניתנה הרשאת הודעה, שיטה זו מבקשת מהמשתמש הרשאה. ההבטחה המוחזרת נדחית אם המשתמש אינו מאפשר לאפליקציה להציג התראות. |
| onMessage(messaging, nextOrObserver) | כאשר מתקבלת הודעת דחיפה והמשתמש נמצא כעת בדף עבור המקור שלך, ההודעה מועברת לדף ואירוע onMessage() נשלח עם המטען של הודעת הדחיפה. |
| פוּנקצִיָה() | |
| נתמך() | בודק אם כל ממשקי ה-API הנדרשים קיימים בדפדפן. |
ממשקים
| מִמְשָׁק | תיאור |
|---|---|
| FcmOptions | אפשרויות לתכונות הניתנות על ידי FCM SDK for Web. ראה WebpushFcmOptions . |
| GetTokenOptions | אפשרויות עבור getToken() . |
| MessagePayload | מטען הודעות שמכיל את מטען ההודעות המיוצג עם NotificationPayload ואת מטען הנתונים שמכיל מספר שרירותי של זוגות מפתח-ערך שנשלחו על ידי מפתחים דרך ממשק ה- API של שלח . |
| הודעות | ממשק ציבורי של Firebase Cloud Messaging SDK. |
| NotificationPayload | הצג פרטי הודעה. הפרטים נשלחים דרך ה- API של שלח . |
פונקציה (אפליקציה,...)
getMessaging(אפליקציה)
מאחזר מופע Firebase Cloud Messaging.
חֲתִימָה:
export declare function getMessagingInWindow(app?: FirebaseApp): Messaging;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| אפליקציה | FirebaseApp |
החזרות:
מופע Firebase Cloud Messaging המשויך לאפליקציית Firebase שסופקה.
פונקציה (הודעות, ...)
deleteToken(הודעות)
מוחק את אסימון הרישום המשויך למופע הודעות זה ומבטל את הרישום למופע ההודעות ממנוי הדחיפה.
חֲתִימָה:
export declare function deleteToken(messaging: Messaging): Promise<boolean>;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| הודעות | הודעות | מופע ההודעות . |
החזרות:
הבטחה<בוליאנית>
ההבטחה נפתרת כאשר האסימון נמחק בהצלחה.
getToken(הודעות, אפשרויות)
נרשם כמנוי למופע ההודעות כדי לדחוף התראות. מחזירה אסימון רישום של Firebase Cloud Messaging שניתן להשתמש בו כדי לשלוח הודעות דחיפה לאותו מופע הודעות .
אם עדיין לא ניתנה הרשאת הודעה, שיטה זו מבקשת מהמשתמש הרשאה. ההבטחה המוחזרת נדחית אם המשתמש אינו מאפשר לאפליקציה להציג התראות.
חֲתִימָה:
export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| הודעות | הודעות | מופע ההודעות . |
| אפשרויות | GetTokenOptions | מספק מפתח לא אופציונלי ורישום שירות עובד אופציונלי. |
החזרות:
הבטחה<string>
ההבטחה נפתרת עם אסימון רישום של FCM.
onMessage(messaging, nextOrObserver)
כאשר מתקבלת הודעת דחיפה והמשתמש נמצא כעת בדף עבור המקור שלך, ההודעה מועברת לדף ואירוע onMessage() נשלח עם המטען של הודעת הדחיפה.
חֲתִימָה:
export declare function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| הודעות | הודעות | מופע ההודעות . |
| nextOrObserver | NextFn < MessagePayload > | מַשׁקִיף < MessagePayload > | פונקציה זו, או אובייקט צופה עם ההגדרה next , נקראת כאשר מתקבלת הודעה והמשתמש צופה כעת בדף שלך. |
החזרות:
כדי להפסיק להאזין להודעות, בצע את הפונקציה שהוחזרה.
פוּנקצִיָה()
נתמך()
בודק אם כל ממשקי ה-API הנדרשים קיימים בדפדפן.
חֲתִימָה:
export declare function isWindowSupported(): Promise<boolean>;
החזרות:
הבטחה<בוליאנית>
הבטחה שנפתרת לבוליאן.