Messaging class

שירות הודעות קשור לאפליקציה שסופקה.

חֲתִימָה:

export declare class Messaging 

נכסים

תכונה	משנה	סוּג	תיאור
אפליקציה		אפליקציה	האפליקציה המשויכת למופע הנוכחי של שירות Messaging .

שיטות

שיטה	משנה	תיאור
שלח (הודעה, dryRun)		שולח את ההודעה הנתונה דרך FCM.
sendAll(messages, dryRun)		שולח את כל ההודעות במערך הנתון באמצעות Firebase Cloud Messaging. משתמש באצווה כדי לשלוח את כל הרשימה כשיחת RPC אחת. בהשוואה לשיטת send() , שיטה זו היא דרך יעילה משמעותית לשליחת מספר הודעות. רשימת התגובות המתקבלת מערך ההחזרה מתאימה לסדר האסימונים ב- MulticastMessage . שגיאה משיטה זו מצביעה על כשל מוחלט, כלומר אף אחת מההודעות ברשימה לא נשלחה. כשלים חלקיים מסומנים על ידי ערך החזרה BatchResponse .
sendEach(messages, dryRun)		שולח כל הודעה במערך הנתון באמצעות Firebase Cloud Messaging. שלא כמו Messaging.sendAll() , שיטה זו מבצעת קריאת RPC אחת עבור כל הודעה במערך הנתון. רשימת התגובות המתקבלת מערך ההחזרה מתאימה לסדר messages . שגיאה משיטה זו או BatchResponse עם כל הכשלים מציינת כישלון מוחלט, כלומר לא ניתן לשלוח אף אחת מההודעות ברשימה. כשלים חלקיים או ללא כשלים מסומנים רק על ידי ערך החזרה BatchResponse .
sendEachForMulticast(הודעה, dryRun)		שולח את הודעת השידור הנתונה לכל אסימוני הרישום של FCM שצוינו בה. שיטה זו משתמשת בממשק ה-API של Messaging.sendEach() מתחת למכסה המנוע כדי לשלוח את ההודעה הנתונה לכל נמעני היעד. רשימת התגובות המתקבלת מערך ההחזרה מתאימה לסדר האסימונים ב- MulticastMessage . שגיאה משיטה זו או BatchResponse עם כל הכשלים מציינת כישלון מוחלט, כלומר ניתן לשלוח את ההודעות ברשימה. כשלים או כשלים חלקיים מסומנים רק על ידי ערך החזרה BatchResponse .
sendMulticast(הודעה, dryRun)		שולח את הודעת השידור הנתונה לכל אסימוני הרישום של FCM שצוינו בה. שיטה זו משתמשת בממשק ה-API sendAll() מתחת למכסה המנוע כדי לשלוח את ההודעה הנתונה לכל נמעני היעד. רשימת התגובות המתקבלת מערך ההחזרה מתאימה לסדר האסימונים ב- MulticastMessage . שגיאה משיטה זו מצביעה על כשל מוחלט, כלומר ההודעה לא נשלחה לאף אחד מהאסימונים ברשימה. כשלים חלקיים מסומנים על ידי ערך החזרה BatchResponse .
sendToCondition(מצב, מטען, אפשרויות)		שולח הודעת FCM לתנאי. ראה שלח לתנאי לדוגמאות קוד ותיעוד מפורט.
sendToDevice(RegistrationTokenOrTokens, מטען, אפשרויות)		שולח הודעת FCM למכשיר בודד התואם לאסימון הרישום שסופק. ראה שליחה למכשירים בודדים לקבלת דוגמאות קוד ותיעוד מפורט. לוקח registrationToken לשליחה למכשיר בודד או פרמטר registrationTokens המכיל מערך של אסימונים לשליחה למספר מכשירים.
sendToDeviceGroup(notificationKey, מטען, אפשרויות)		שולח הודעת FCM לקבוצת מכשירים התואמת למפתח ההתראה שסופק. ראה שלח לקבוצת התקנים לקבלת דוגמאות קוד ותיעוד מפורט.
sendToTopic(נושא, מטען, אפשרויות)		שולח הודעת FCM לנושא. ראה שלח לנושא לדוגמאות קוד ותיעוד מפורט.
subscribeTopic(RegistrationTokenOrTokens, topic)		עושה מנוי על מכשיר לנושא FCM. ראה הרשמה לנושא לדוגמאות קוד ותיעוד מפורט. לחלופין, אתה יכול לספק מערך של אסימונים כדי להירשם למספר מכשירים.
unsubscribeFromTopic(RegistrationTokenOrTokens, topic)		מבטל את הרישום של מכשיר לנושא של FCM. ראה ביטול הרשמה לנושא לדוגמאות קוד ותיעוד מפורט. לחלופין, אתה יכול לספק מערך של אסימונים לביטול הרישום של מכשירים מרובים.

Messaging.app

האפליקציה המשויכת למופע הנוכחי של שירות Messaging .

חֲתִימָה:

get app(): App;

דוגמא

var app = messaging.app;

Messaging.send()

שולח את ההודעה הנתונה דרך FCM.

חֲתִימָה:

send(message: Message, dryRun?: boolean): Promise<string>;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
הוֹדָעָה	הוֹדָעָה	מטען ההודעה.
ריצה יבשה	בוליאני	האם לשלוח את ההודעה במצב הפעלה יבשה (אימות בלבד).

החזרות:

הבטחה<string>

הבטחה שמומשה עם מחרוזת מזהה הודעה ייחודית לאחר שההודעה נמסרה בהצלחה לשירות FCM לצורך מסירה.

Messaging.sendAll()

אזהרה: ממשק API זה מיושן כעת.

השתמש ב-Messaging.sendEach() במקום זאת.

שולח את כל ההודעות במערך הנתון באמצעות Firebase Cloud Messaging. משתמש באצווה כדי לשלוח את כל הרשימה כשיחת RPC אחת. בהשוואה לשיטת send() , שיטה זו היא דרך יעילה משמעותית לשליחת מספר הודעות.

רשימת התגובות המתקבלת מערך ההחזרה מתאימה לסדר האסימונים ב- MulticastMessage . שגיאה משיטה זו מצביעה על כשל מוחלט, כלומר אף אחת מההודעות ברשימה לא נשלחה. כשלים חלקיים מסומנים על ידי ערך החזרה BatchResponse .

חֲתִימָה:

sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
הודעות	הוֹדָעָה []	מערך לא ריק המכיל עד 500 הודעות.
ריצה יבשה	בוליאני	האם לשלוח את ההודעות במצב הפעלה יבשה (אימות בלבד).

החזרות:

הבטחה< BatchResponse >

הבטחה שהתגשמה עם אובייקט המייצג את התוצאה של פעולת השליחה.

Messaging.sendEach()

שולח כל הודעה במערך הנתון באמצעות Firebase Cloud Messaging.

שלא כמו Messaging.sendAll() , שיטה זו מבצעת קריאת RPC אחת עבור כל הודעה במערך הנתון.

רשימת התגובות המתקבלת מערך ההחזרה מתאימה לסדר messages . שגיאה משיטה זו או BatchResponse עם כל הכשלים מציינת כישלון מוחלט, כלומר לא ניתן לשלוח אף אחת מההודעות ברשימה. כשלים חלקיים או ללא כשלים מסומנים רק על ידי ערך החזרה BatchResponse .

חֲתִימָה:

sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
הודעות	הוֹדָעָה []	מערך לא ריק המכיל עד 500 הודעות.
ריצה יבשה	בוליאני	האם לשלוח את ההודעות במצב הפעלה יבשה (אימות בלבד).

החזרות:

הבטחה< BatchResponse >

הבטחה שהתגשמה עם אובייקט המייצג את התוצאה של פעולת השליחה.

Messaging.sendEachForMulticast()

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

שיטה זו משתמשת בממשק ה-API של Messaging.sendEach() מתחת למכסה המנוע כדי לשלוח את ההודעה הנתונה לכל נמעני היעד. רשימת התגובות המתקבלת מערך ההחזרה מתאימה לסדר האסימונים ב- MulticastMessage . שגיאה משיטה זו או BatchResponse עם כל הכשלים מציינת כישלון מוחלט, כלומר ניתן לשלוח את ההודעות ברשימה. כשלים או כשלים חלקיים מסומנים רק על ידי ערך החזרה BatchResponse .

חֲתִימָה:

sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
הוֹדָעָה	MulticastMessage	הודעת ריבוי שידור המכילה עד 500 אסימונים.
ריצה יבשה	בוליאני	האם לשלוח את ההודעה במצב הפעלה יבשה (אימות בלבד).

החזרות:

הבטחה< BatchResponse >

הבטחה שהתגשמה עם אובייקט המייצג את התוצאה של פעולת השליחה.

Messaging.sendMulticast()

אזהרה: ממשק API זה מיושן כעת.

השתמש ב- Messaging.sendEachForMulticast() במקום זאת.

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

שיטה זו משתמשת בממשק ה-API sendAll() מתחת למכסה המנוע כדי לשלוח את ההודעה הנתונה לכל נמעני היעד. רשימת התגובות המתקבלת מערך ההחזרה מתאימה לסדר האסימונים ב- MulticastMessage . שגיאה משיטה זו מצביעה על כשל מוחלט, כלומר ההודעה לא נשלחה לאף אחד מהאסימונים ברשימה. כשלים חלקיים מסומנים על ידי ערך החזרה BatchResponse .

חֲתִימָה:

sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
הוֹדָעָה	MulticastMessage	הודעת ריבוי שידור המכילה עד 500 אסימונים.
ריצה יבשה	בוליאני	האם לשלוח את ההודעה במצב הפעלה יבשה (אימות בלבד).

החזרות:

הבטחה< BatchResponse >

הבטחה שהתגשמה עם אובייקט המייצג את התוצאה של פעולת השליחה.

Messaging.sendToCondition()

שולח הודעת FCM לתנאי.

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

חֲתִימָה:

sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
מַצָב	חוּט	התנאי הקובע לאילו נושאים לשלוח את ההודעה.
מטען	MessagingPayload	מטען ההודעה.
אפשרויות	אפשרויות הודעות	אפשרויות אופציונליות לשינוי ההודעה.

החזרות:

הבטחה< MessagingConditionResponse >

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

Messaging.sendToDevice()

אזהרה: ממשק API זה מיושן כעת.

השתמש ב-Messaging.send() במקום זאת.

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

ראה שליחה למכשירים בודדים לקבלת דוגמאות קוד ותיעוד מפורט. לוקח registrationToken לשליחה למכשיר בודד או פרמטר registrationTokens המכיל מערך של אסימונים לשליחה למספר מכשירים.

חֲתִימָה:

sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
registrationTokenOrTokens	מחרוזת | חוּט[]
מטען	MessagingPayload	מטען ההודעה.
אפשרויות	אפשרויות הודעות	אפשרויות אופציונליות לשינוי ההודעה.

החזרות:

הבטחה< MessagingDevicesResponse >

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

Messaging.sendToDeviceGroup()

אזהרה: ממשק API זה מיושן כעת.

השתמש ב-Messaging.send() במקום זאת.

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

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

חֲתִימָה:

sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
NotificationKey	חוּט	מפתח ההתראה של קבוצת המכשירים שאליה יש לשלוח את ההודעה.
מטען	MessagingPayload	מטען ההודעה.
אפשרויות	אפשרויות הודעות	אפשרויות אופציונליות לשינוי ההודעה.

החזרות:

הבטחה< MessagingDeviceGroupResponse >

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

Messaging.sendToTopic()

שולח הודעת FCM לנושא.

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

חֲתִימָה:

sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
נוֹשֵׂא	חוּט	הנושא שאליו לשלוח את ההודעה.
מטען	MessagingPayload	מטען ההודעה.
אפשרויות	אפשרויות הודעות	אפשרויות אופציונליות לשינוי ההודעה.

החזרות:

הבטחה< MessagingTopicResponse >

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

Messaging.subscribeToTopic()

עושה מנוי על מכשיר לנושא FCM.

ראה הרשמה לנושא לדוגמאות קוד ותיעוד מפורט. לחלופין, אתה יכול לספק מערך של אסימונים כדי להירשם למספר מכשירים.

חֲתִימָה:

subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
registrationTokenOrTokens	מחרוזת | חוּט[]
נוֹשֵׂא	חוּט	הנושא שאליו יש להירשם.

החזרות:

הבטחה< MessagingTopicManagementResponse >

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

Messaging.unsubscribeFromTopic()

מבטל את הרישום של מכשיר לנושא של FCM.

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

חֲתִימָה:

unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
registrationTokenOrTokens	מחרוזת | חוּט[]
נוֹשֵׂא	חוּט	הנושא שממנו יש לבטל את המנוי.

החזרות:

הבטחה< MessagingTopicManagementResponse >

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