chrome.notifications

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

תיאור

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

הרשאות

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

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

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

  • iconUrl

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

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

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

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

  • imageUrl

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

    הוצא משימוש מאז Chrome 59

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

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

  • isClickable

    ‫boolean אופציונלי

    הוצא משימוש מאז Chrome 67

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

  • פריטים

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

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

  • הודעה

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

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

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

  • הקמפיין

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

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

  • התקדמות

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

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

  • requireInteraction

    ‫boolean אופציונלי

    ‫Chrome 50 ואילך

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

  • שקט

    ‫boolean אופציונלי

    ‫Chrome 70 ואילך

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

  • title

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

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

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

  • סוג

    ‫TemplateType אופציונלי

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

PermissionLevel

ספירה

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

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

TemplateType

ספירה

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

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

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

‫progress
כולל סמל, כותרת, הודעה, התקדמות ושני לחצנים לכל היותר.

Methods

clear()

Promise 
chrome.notifications.clear(
  notificationId: string,
  callback?: function,
): Promise<boolean>

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

פרמטרים

  • notificationId

    מחרוזת

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

  • callback

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

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

    (wasCleared: boolean) => void

    • wasCleared

      בוליאני

החזרות

  • Promise<boolean>

    ‫Chrome 116 ואילך

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

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

create()

Promise 
chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
  callback?: function,
): Promise<string>

יוצר ומציג התראה.

פרמטרים

  • notificationId

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

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

    הפרמטר notificationId נדרש בגרסאות Chrome 42 ומטה.

  • תוכן ההתראה.

  • callback

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

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

    (notificationId: string) => void

    • notificationId

      מחרוזת

החזרות

  • Promise<string>

    ‫Chrome 116 ואילך

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

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

getAll()

Promise 
chrome.notifications.getAll(
  callback?: function,
): Promise<object>

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

פרמטרים

  • callback

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

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

    (notifications: object) => void

    • התראות

      אובייקט

החזרות

  • Promise<object>

    ‫Chrome 116 ואילך

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

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

getPermissionLevel()

Promise 
chrome.notifications.getPermissionLevel(
  callback?: function,
): Promise<PermissionLevel>

הפונקציה מחזירה את הערך TRUE אם המשתמש הפעיל התראות מהאפליקציה או מהתוסף, או את הערך FALSE אם המשתמש השבית את ההתראות.

פרמטרים

החזרות

  • Promise<PermissionLevel>

    ‫Chrome 116 ואילך

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

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

update()

Promise 
chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
  callback?: function,
): Promise<boolean>

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

פרמטרים

  • notificationId

    מחרוזת

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

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

  • callback

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

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

    (wasUpdated: boolean) => void

    • wasUpdated

      בוליאני

החזרות

  • Promise<boolean>

    ‫Chrome 116 ואילך

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

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

אירועים

onButtonClicked

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

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

פרמטרים

  • callback

    פונקציה

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

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

    • notificationId

      מחרוזת

    • buttonIndex

      number

onClicked

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

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

פרמטרים

  • callback

    פונקציה

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

    (notificationId: string) => void

    • notificationId

      מחרוזת

onClosed

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

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

פרמטרים

  • callback

    פונקציה

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

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

    • notificationId

      מחרוזת

    • byUser

      בוליאני

onPermissionLevelChanged

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

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

פרמטרים

onShowSettings

הוצא משימוש מאז Chrome 65
chrome.notifications.onShowSettings.addListener(
  callback: function,
)

התמיכה בכפתור של הגדרות התראות בהתאמה אישית הופסקה.

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

פרמטרים

  • callback

    פונקציה

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

    () => void