browser.gcm

תיאור

משתמשים ב-chrome.gcm כדי לאפשר לאפליקציות ולתוספים לשלוח ולקבל הודעות דרך העברת הודעות בענן ב-Firebase ‏ (FCM).

הרשאות

gcm

מאפיינים

MAX_MESSAGE_SIZE

הגודל המקסימלי (בבייטים) של כל זוגות המפתח/ערך בהודעה.

ערך

4096

Methods

register()

chrome.gcm.register(
  senderIds: string[],
): Promise<string>

האפליקציה נרשמת ב-FCM. מזהה הרישום יוחזר על ידי callback. אם הפונקציה register נקראת שוב עם אותה רשימה של senderIds, יוחזר אותו מזהה רישום.

פרמטרים

  • senderIds

    string[]

    רשימה של מזהי שרתים שמורשים לשלוח הודעות לאפליקציה. הקובץ צריך להכיל לפחות מזהה שולח אחד, ולא יותר מ-100 מזהי שולח.

החזרות

  • Promise<string>

    ‫Chrome 116 ואילך

    ההבטחה נפתרת כשההרשמה מסתיימת.

send()

chrome.gcm.send(
  message: object,
): Promise<string>

שליחת הודעה בהתאם לתוכן שלה.

פרמטרים

  • הודעה

    אובייקט

    ההודעה שרוצים לשלוח לצד השני דרך FCM.

    • נתונים

      אובייקט

      נתוני ההודעה לשליחה לשרת. אסור להשתמש ב-goog. וב-google (לא תלוי רישיות) וב-collapse_key (תלוי רישיות) כקידומות של מפתחות. הסכום של כל צמדי המפתח/ערך לא יכול לעלות על gcm.MAX_MESSAGE_SIZE.

    • destinationId

      מחרוזת

      המזהה של השרת שאליו רוצים לשלוח את ההודעה, כפי שהוקצה על ידי Google API Console.

    • messageId

      מחרוזת

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

    • timeToLive

      מספר אופציונלי

      משך החיים של ההודעה בשניות. אם אי אפשר לשלוח את ההודעה בפרק הזמן הזה, יופעל אירוע onSendError. ערך של 0 ב-TTL מציין שההודעה צריכה להישלח באופן מיידי, או שהשליחה תיכש�� אם זה לא אפשרי. ערך ברירת המחדל של משך החיים הוא 86,400 שניות (יום אחד), והערך המקסימלי הוא 2,419,200 שניות (28 ימים).

החזרות

  • Promise<string>

    ‫Chrome 116 ואילך

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

unregister()

chrome.gcm.unregister(): Promise<void>

ביטול הרישום של האפליקציה מ-FCM.

החזרות

  • Promise<void>

    ‫Chrome 116 ואילך

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

אירועים

onMessage

chrome.gcm.onMessage.addListener(
  callback: function,
)

האירוע מופעל כשמתקבלת הודעה דרך FCM.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

    (message: object) => void

onMessagesDeleted

chrome.gcm.onMessagesDeleted.addListener(
  callback: function,
)

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

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

    () => void

onSendError

chrome.gcm.onSendError.addListener(
  callback: function,
)

האירוע מופעל כשאי אפשר לשלוח הודעה לשרת FCM.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

    (error: object) => void

    • error

      אובייקט

      • פרטים

        אובייקט

        פרטים נוספים שקשורים לשגיאה, אם יש כאלה.

      • errorMessage

        מחרוזת

        הודעת השגיאה שמתארת את הבעיה.

      • messageId

        מחרוזת אופציונלי

        המזהה של ההודעה עם השגיאה הזו, אם השגיאה קשורה להודעה ספציפית.