browser.notifications

תיאור

אפשר להשתמש ב-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

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

    חותמת זמן שמשויכת להתראה, באלפיות השנייה אחרי התקופה (למשל, 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

Enum

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

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

TemplateType

Enum

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

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

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

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

Methods

clear()

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

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

פרמטרים

  • notificationId

    מחרוזת

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

החזרות

  • Promise<boolean>

    ‫Chrome 116 ואילך

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

create()

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

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

פרמטרים

  • notificationId

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

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

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

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

החזרות

  • Promise<string>

    ‫Chrome 116 ואילך

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

getAll()

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

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

החזרות

  • Promise<object>

    ‫Chrome 116 ואילך

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

getPermissionLevel()

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

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

החזרות

  • Promise<PermissionLevel>

    ‫Chrome 116 ואילך

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

update()

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

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

פרמטרים

  • notificationId

    מחרוזת

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

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

החזרות

  • Promise<boolean>

    ‫Chrome 116 ואילך

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

אירועים

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