chrome.gcm

תאריך הרענון: 2026-09-25 robots: noindex

תיאור

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

הרשאות

gcm

מאפיינים

MAX_MESSAGE_SIZE

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

ערך

4096

Methods

register()

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

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

פרמטרים

  • senderIds

    string[]

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

  • callback

    פונקציה אופציונלית

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

    (registrationId: string) => void

    • registrationId

      מחרוזת

      מזהה רישום שהוקצה לאפליקציה על ידי FCM.

החזרות

  • Promise<string>

    ‫Chrome 116 ואילך

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

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

send()

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

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

פרמטרים

  • הודעה

    אובייקט

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

    • נתונים

      אובייקט

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

    • destinationId

      מחרוזת

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

    • messageId

      מחרוזת

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

    • timeToLive

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

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

  • callback

    פונקציה אופציונלית

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

    (messageId: string) => void

    • messageId

      מחרוזת

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

החזרות

  • Promise<string>

    ‫Chrome 116 ואילך

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

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

unregister()

Promise 
chrome.gcm.unregister(
  callback?: function,
): Promise<void>

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

פרמטרים

  • callback

    פונקציה אופציונלית

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 116 ואילך

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

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

אירועים

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

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

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