chrome.gcm

תיאור

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

הרשאות

gcm

מאפיינים

MAX_MESSAGE_SIZE

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

ערך

4096

שיטות

register()

הבטחה 
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
)

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

פרמטרים

  • senderIds

    String[]

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

  • קריאה חוזרת (callback)

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

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

    (registrationId: string) => void

    • registrationId

      מחרוזת

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

החזרות

  • Promise<string>

    Chrome 116 ואילך

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.

send()

הבטחה 
chrome.gcm.send(
  message: object,
  callback?: function,
)

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

פרמטרים

  • הודעה

    אובייקט

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

    • נתונים

      אובייקט

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

    • destinationId

      מחרוזת

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

    • messageId

      מחרוזת

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

    • timeToLive

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

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

  • קריאה חוזרת (callback)

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

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

    (messageId: string) => void

    • messageId

      מחרוזת

      מזהה ההודעה שעבורה בוצעה הקריאה החוזרת.

החזרות

  • Promise<string>

    Chrome 116 ואילך

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.

unregister()

הבטחה 
chrome.gcm.unregister(
  callback?: function,
)

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

פרמטרים

  • קריאה חוזרת (callback)

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

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

    () => void

החזרות

  • הבטחה<Empty>

    Chrome 116 ואילך

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.

אירועים

onMessage

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

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

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

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

    (message: object) => void

    • הודעה

      אובייקט

      • collapseKey

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

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

      • נתונים

        אובייקט

        נתוני ההודעה

      • החל מ-

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

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

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

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

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