browser.gcm

תיאור

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

הרשאות

gcm

מאפיינים

MAX_MESSAGE_SIZE

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

ערך

4096

Methods

register()

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

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

פרמטרים

• senderIds

  string[]‎

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

החזרות

• Promise<string>

  ‫Chrome 116 ואילך ‫browser.* ‎ מ-Chrome 148

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

send()

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

שליחת הודעה לפי התוכן שלה.

פרמטרים

• הודעה

  אובייקט

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

  • נתונים

    אובייקט

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

  • destinationId

    מחרוזת

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

  • messageId

    מחרוזת

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

  • timeToLive

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

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

החזרות

• Promise<string>

  ‫Chrome 116 ואילך ‫browser.* ‎ מ-Chrome 148

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

unregister()

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

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

החזרות

• Promise<void>

  ‫Chrome 116 ואילך ‫browser.* ‎ מ-Chrome 148

  ההבטחה מתקיימת אחרי שהביטול של הרישום מסתיים. אם ה-promise לא נדחה, סימן שהביטול הצליח.

אירועים

onMessage

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

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

פרמטרים

• callback

  פונקציה

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

  (message: object) => void

  • הודעה

    אובייקט

    • collapseKey

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

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

    • נתונים

      אובייקט

      נתוני ההודעה.

    • החל מ-

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

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

onMessagesDeleted

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

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

פרמטרים

• callback

  פונקציה

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

  () => void

onSendError

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

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

פרמטרים

• callback

  פונקציה

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

  (error: object) => void

  • error

    אובייקט

    • פרטים

      אובייקט

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

    • errorMessage

      מחרוזת

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

    • messageId

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

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