browser.notifications

תיאור

אפשר להשתמש ב-API של chrome.notifications כדי ליצור התראות עשירות באמצעות תבניות ולהציג את ההתראות האלה למשתמשים במגש המערכת.

הרשאות

notifications

סוגים

NotificationBitmap

NotificationButton

מאפיינים

  • iconUrl

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

    הוצא משימוש ב-Chrome 59

    סמלי הלחצנים לא מוצגים למשתמשי Mac OS X.

  • title

    מחרוזת

NotificationItem

מאפיינים

  • הודעה

    מחרוזת

    פרטים נוספים על הפריט הזה.

  • title

    מחרוזת

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

NotificationOptions

מאפיינים

  • appIconMaskUrl

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

    הוצא משימוש ב-Chrome 59

    משתמשי Mac OS X לא רואים את מסכת סמל האפליקציה.

    כתובת URL למסכה של סמל האפליקציה. על כתובות ה-URL חלות אותן הגבלות שחלות על iconUrl.

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

  • כפתורים

    NotificationButton[] אופציונלי

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

  • contextMessage

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

    תוכן חלופי להתראה עם גופן דק יותר.

  • eventTime

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

    חותמת זמן שמשויכת להתראה, באלפיות השנייה אחרי תחילת התקופה (למשל Date.now() + n).

  • iconUrl

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

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

    כתובות ה-URL יכולות להיות כתובת URL של נתונים, כתובת URL של blob או כתובת URL שקשורה למשאב בקובץ ה-‎ .crx של התוסף הזה

    **הערה:**הערך הזה נדרש לשיטה notifications.create().

  • imageUrl

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

    הוצא משימוש ב-Chrome 59

    התמונה לא מוצגת למשתמשי Mac OS X.

    כתובת URL לתמונה הממוזערת של התמונה בהתראות מסוג תמונה. על כתובות ה-URL חלות אותן הגבלות שחלות על iconUrl.

  • isClickable

    בוליאני אופציונלי

    הוצא משימוש ב-Chrome 67

    המערכת מתעלמת מהרמז הזה לממשק המשתמש החל מגרסה 67 של Chrome

  • פריטים

    NotificationItem[] אופציונלי

    פריטים להתראות על כמה פריטים. משתמשים ב-Mac OS X רואים רק את הפריט הראשון.

  • הודעה

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

    התוכן העיקרי של ההתראה.

    **הערה:**הערך הזה נדרש לשיטה notifications.create().

  • הקמפיין

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

    העדיפות נעה בין 2- ל-2. ‫-2 היא העדיפות הנמוכה ביותר. ‫2 היא הרמה הגבוהה ביותר. ברירת המחדל היא אפס. בפלטפורמות שלא תומכות במרכז התראות (Windows, ‏ Linux ו-Mac), הערכים ‎-2 ו-‎-1 גורמים לשגיאה כי התראות עם רמות העדיפות האלה לא יוצגו בכלל.

  • התקדמות

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

    ההתקדמות הנוכחית נעה בין 0 ל-100.

  • requireInteraction

    בוליאני אופציונלי

    ‫Chrome 50 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

    מציין שההתראה צריכה להישאר גלויה במסך עד שהמשתמש מפעיל או סוגר אותה. ערך ברירת המחדל הוא false.

  • שקט

    בוליאני אופציונלי

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

    מציין שלא יופעלו צלילים או רטט כשההתראה מוצגת. ערך ברירת המחדל הוא false.

  • title

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

    כותרת ההתראה (למשל, שם השולח באימייל).

    **הערה:**הערך הזה נדרש לשיטה notifications.create().

  • סוג

    TemplateType אופציונלי

    איזה סוג של התראה להציג. חובה בשיטה notifications.create.

PermissionLevel

טיפוסים בני מנייה (enum)

"granted"
מציין שהמשתמש בחר להציג התראות מהאפליקציה או מהתוסף. זוהי ברירת המחדל בזמן ההתקנה.

"denied"
מציין שהמשתמש בחר לא להציג התראות מהאפליקציה או מהתוסף.

TemplateType

טיפוסים בני מנייה (enum)

"basic"
מכיל סמל, כותרת, הודעה, expandedMessage ועד שני לחצנים.

"image"
מכיל סמל, כותרת, הודעה, expandedMessage, תמונה ועד שני לחצנים.

"list"
מכיל סמל, כותרת, הודעה, פריטים ועד שני כפתורים. משתמשים ב-Mac OS X רואים רק את הפריט הראשון.

"progress"
מכיל סמל, כותרת, הודעה, התקדמות ועד שני כפתורים.

Methods

clear()

browser.notifications.clear(
  notificationId: string,
): Promise<boolean>

מחיקת ההתראה שצוינה.

פרמטרים

  • notificationId

    מחרוזת

    המזהה של ההתראה שרוצים למחוק. הערך הזה מוחזר על ידי השיטה notifications.create.

החזרות

  • Promise<boolean>

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

    מחזירה Promise שמתקבלת כדי לציין אם הייתה התראה תואמת.

create()

browser.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
): Promise<string>

יצירה והצגה של התראה.

פרמטרים

  • notificationId

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

    המזהה של ההתראה. אם לא מגדירים מזהה או משאירים את השדה ריק, המערכת תיצור מזהה באופן אוטומטי. אם הוא תואם להתראה קיימת, ה-method הזו קודם מנקה את ההתראה הזו לפני שהיא ממשיכה בפעולת היצירה. המזהה לא יכול להיות ארוך מ-500 תווים.

    הפרמטר notificationId נדרש לפני Chrome 42.

  • אפשרויות

    NotificationOptions

    תוכן ההתראה.

החזרות

  • Promise<string>

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

    מחזירה Promise שמתקבל עם מזהה ההתראה (שסופק או נוצר) שמייצג את ההתראה שנוצרה.

getAll()

browser.notifications.getAll(): Promise<object>

אחזור של כל ההתראות של האפליקציה או התוסף.

החזרות

  • Promise<object>

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

    הפונקציה מחזירה Promise שמתקבלת עם קבוצת ה-notification_ids שקיימים כרגע במערכת.

getPermissionLevel()

browser.notifications.getPermissionLevel(): Promise<PermissionLevel>

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

החזרות

  • Promise<PermissionLevel>

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

    הפונקציה מחזירה Promise שמתקבלת עם רמת ההרשאה הנוכחית.

update()

browser.notifications.update(
  notificationId: string,
  options: NotificationOptions,
): Promise<boolean>

עדכון של התראה קיימת.

פרמטרים

  • notificationId

    מחרוזת

    המזהה של ההתראה שצריך לעדכן. הערך הזה מוחזר על ידי השיטה notifications.create.

  • אפשרויות

    NotificationOptions

    תוכן ההתראה שרוצים לעדכן.

החזרות

  • Promise<boolean>

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

    מחזירה Promise שמתקבלת כדי לציין אם הייתה התראה תואמת.

אירועים

onButtonClicked

browser.notifications.onButtonClicked.addListener(
  callback: function,
)

המשתמש לחץ על כפתור בהתראה.

פרמטרים

  • callback

    פונקציה

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

    (notificationId: string, buttonIndex: number) => void

    • notificationId

      מחרוזת

    • buttonIndex

      number

onClicked

browser.notifications.onClicked.addListener(
  callback: function,
)

המשתמש לחץ על אזור בהתראה שהוא לא לחצן.

פרמטרים

  • callback

    פונקציה

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

    (notificationId: string) => void

    • notificationId

      מחרוזת

onClosed

browser.notifications.onClosed.addListener(
  callback: function,
)

ההתראה נסגרה, על ידי המערכת או על ידי פעולת משתמש.

פרמטרים

  • callback

    פונקציה

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

    (notificationId: string, byUser: boolean) => void

    • notificationId

      מחרוזת

    • byUser

      בוליאני

onPermissionLevelChanged

browser.notifications.onPermissionLevelChanged.addListener(
  callback: function,
)

המשתמש משנה את רמת ההרשאה. החל מגרסה 47 של Chrome, רק ל-ChromeOS יש ממשק משתמש ששולח את האירוע הזה.

פרמטרים

onShowSettings

הוצא משימוש בגרסה Chrome 65
browser.notifications.onShowSettings.addListener(
  callback: function,
)

הלחצן של הגדרות ההתראות בהתאמה אישית לא נתמך יותר.

המשתמש לחץ על קישור להגדרת ההתראות של האפליקציה. החל מגרסה 47 של Chrome, רק ל-ChromeOS יש ממשק משתמש ששולח את האירוע הזה. החל מגרסה 65 של Chrome, ממשק המשתמש הזה הוסר גם מ-ChromeOS.

פרמטרים

  • callback

    פונקציה

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

    () => void