chrome.gcm

תיאור

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

הרשאות

gcm

תכונות

MAX_MESSAGE_SIZE

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

Value

4096

שיטות

register()

הבטחה

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

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

פרמטרים

• senderIds

  מחרוזת[]

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

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

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

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

  (registrationId: string)=>void

  • registrationId

    מחרוזת

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

החזרות

• הבטחה<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.

  • messageId

    מחרוזת

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

  • timeToLive

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

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

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

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

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

  (messageId: string)=>void

  • messageId

    מחרוזת

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

החזרות

• הבטחה<string>

  Chrome 116 ומעלה

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

unregister()

הבטחה

chrome.gcm.unregister(
  callback?: function,
)

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

פרמטרים

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

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

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

  ()=>void

החזרות

• Promise<void>

  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

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

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